blob: 90196bce1882fef038e87b7c4d05e4cded55f717 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/logging.admin": {
"description": "Administrate log data for your projects"
},
"https://www.googleapis.com/auth/logging.read": {
"description": "View log data for your projects"
},
"https://www.googleapis.com/auth/logging.write": {
"description": "Submit log data for your projects"
}
}
}
},
"basePath": "",
"baseUrl": "https://logging.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Logging",
"description": "Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Logging documentation.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/logging/docs/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "logging:v2",
"kind": "discovery#restDescription",
"name": "logging",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"billingAccounts": {
"resources": {
"exclusions": {
"methods": {
"create": {
"description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
"httpMethod": "POST",
"id": "logging.billingAccounts.exclusions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes an exclusion.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
"httpMethod": "DELETE",
"id": "logging.billingAccounts.exclusions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets the description of an exclusion.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
"httpMethod": "GET",
"id": "logging.billingAccounts.exclusions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists all the exclusions in a parent resource.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
"httpMethod": "GET",
"id": "logging.billingAccounts.exclusions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^billingAccounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"response": {
"$ref": "ListExclusionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Changes one or more properties of an existing exclusion.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
"httpMethod": "PATCH",
"id": "logging.billingAccounts.exclusions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
},
"logs": {
"methods": {
"delete": {
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
"httpMethod": "DELETE",
"id": "logging.billingAccounts.logs.delete",
"parameterOrder": [
"logName"
],
"parameters": {
"logName": {
"description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+logName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
"httpMethod": "GET",
"id": "logging.billingAccounts.logs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^billingAccounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/logs",
"response": {
"$ref": "ListLogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
}
}
},
"sinks": {
"methods": {
"create": {
"description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
"httpMethod": "POST",
"id": "logging.billingAccounts.sinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/sinks",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
"httpMethod": "DELETE",
"id": "logging.billingAccounts.sinks.delete",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets a sink.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
"httpMethod": "GET",
"id": "logging.billingAccounts.sinks.get",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists sinks.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
"httpMethod": "GET",
"id": "logging.billingAccounts.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^billingAccounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/sinks",
"response": {
"$ref": "ListSinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
"httpMethod": "PATCH",
"id": "logging.billingAccounts.sinks.patch",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"update": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
"httpMethod": "PUT",
"id": "logging.billingAccounts.sinks.update",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
}
}
},
"entries": {
"methods": {
"list": {
"description": "Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.",
"flatPath": "v2/entries:list",
"httpMethod": "POST",
"id": "logging.entries.list",
"parameterOrder": [],
"parameters": {},
"path": "v2/entries:list",
"request": {
"$ref": "ListLogEntriesRequest"
},
"response": {
"$ref": "ListLogEntriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"write": {
"description": "Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)",
"flatPath": "v2/entries:write",
"httpMethod": "POST",
"id": "logging.entries.write",
"parameterOrder": [],
"parameters": {},
"path": "v2/entries:write",
"request": {
"$ref": "WriteLogEntriesRequest"
},
"response": {
"$ref": "WriteLogEntriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.write"
]
}
}
},
"exclusions": {
"methods": {
"create": {
"description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
"httpMethod": "POST",
"id": "logging.exclusions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes an exclusion.",
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
"httpMethod": "DELETE",
"id": "logging.exclusions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets the description of an exclusion.",
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
"httpMethod": "GET",
"id": "logging.exclusions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists all the exclusions in a parent resource.",
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
"httpMethod": "GET",
"id": "logging.exclusions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"response": {
"$ref": "ListExclusionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Changes one or more properties of an existing exclusion.",
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
"httpMethod": "PATCH",
"id": "logging.exclusions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
},
"folders": {
"resources": {
"exclusions": {
"methods": {
"create": {
"description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
"flatPath": "v2/folders/{foldersId}/exclusions",
"httpMethod": "POST",
"id": "logging.folders.exclusions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes an exclusion.",
"flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
"httpMethod": "DELETE",
"id": "logging.folders.exclusions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^folders/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets the description of an exclusion.",
"flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
"httpMethod": "GET",
"id": "logging.folders.exclusions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^folders/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists all the exclusions in a parent resource.",
"flatPath": "v2/folders/{foldersId}/exclusions",
"httpMethod": "GET",
"id": "logging.folders.exclusions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"response": {
"$ref": "ListExclusionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Changes one or more properties of an existing exclusion.",
"flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
"httpMethod": "PATCH",
"id": "logging.folders.exclusions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^folders/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
},
"logs": {
"methods": {
"delete": {
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.",
"flatPath": "v2/folders/{foldersId}/logs/{logsId}",
"httpMethod": "DELETE",
"id": "logging.folders.logs.delete",
"parameterOrder": [
"logName"
],
"parameters": {
"logName": {
"description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^folders/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+logName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"flatPath": "v2/folders/{foldersId}/logs",
"httpMethod": "GET",
"id": "logging.folders.logs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/logs",
"response": {
"$ref": "ListLogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
}
}
},
"sinks": {
"methods": {
"create": {
"description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
"flatPath": "v2/folders/{foldersId}/sinks",
"httpMethod": "POST",
"id": "logging.folders.sinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/sinks",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
"httpMethod": "DELETE",
"id": "logging.folders.sinks.delete",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^folders/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets a sink.",
"flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
"httpMethod": "GET",
"id": "logging.folders.sinks.get",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^folders/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists sinks.",
"flatPath": "v2/folders/{foldersId}/sinks",
"httpMethod": "GET",
"id": "logging.folders.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/sinks",
"response": {
"$ref": "ListSinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
"httpMethod": "PATCH",
"id": "logging.folders.sinks.patch",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^folders/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"update": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
"httpMethod": "PUT",
"id": "logging.folders.sinks.update",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^folders/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
}
}
},
"logs": {
"methods": {
"delete": {
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.",
"flatPath": "v2/{v2Id}/{v2Id1}/logs/{logsId}",
"httpMethod": "DELETE",
"id": "logging.logs.delete",
"parameterOrder": [
"logName"
],
"parameters": {
"logName": {
"description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^[^/]+/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+logName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"flatPath": "v2/{v2Id}/{v2Id1}/logs",
"httpMethod": "GET",
"id": "logging.logs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/logs",
"response": {
"$ref": "ListLogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
}
}
},
"monitoredResourceDescriptors": {
"methods": {
"list": {
"description": "Lists the descriptors for monitored resource types used by Logging.",
"flatPath": "v2/monitoredResourceDescriptors",
"httpMethod": "GET",
"id": "logging.monitoredResourceDescriptors.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
}
},
"path": "v2/monitoredResourceDescriptors",
"response": {
"$ref": "ListMonitoredResourceDescriptorsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
}
}
},
"organizations": {
"resources": {
"exclusions": {
"methods": {
"create": {
"description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
"flatPath": "v2/organizations/{organizationsId}/exclusions",
"httpMethod": "POST",
"id": "logging.organizations.exclusions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes an exclusion.",
"flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
"httpMethod": "DELETE",
"id": "logging.organizations.exclusions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^organizations/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets the description of an exclusion.",
"flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
"httpMethod": "GET",
"id": "logging.organizations.exclusions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^organizations/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists all the exclusions in a parent resource.",
"flatPath": "v2/organizations/{organizationsId}/exclusions",
"httpMethod": "GET",
"id": "logging.organizations.exclusions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"response": {
"$ref": "ListExclusionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Changes one or more properties of an existing exclusion.",
"flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
"httpMethod": "PATCH",
"id": "logging.organizations.exclusions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^organizations/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
},
"logs": {
"methods": {
"delete": {
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.",
"flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
"httpMethod": "DELETE",
"id": "logging.organizations.logs.delete",
"parameterOrder": [
"logName"
],
"parameters": {
"logName": {
"description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^organizations/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+logName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"flatPath": "v2/organizations/{organizationsId}/logs",
"httpMethod": "GET",
"id": "logging.organizations.logs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/logs",
"response": {
"$ref": "ListLogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
}
}
},
"sinks": {
"methods": {
"create": {
"description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
"flatPath": "v2/organizations/{organizationsId}/sinks",
"httpMethod": "POST",
"id": "logging.organizations.sinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/sinks",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
"httpMethod": "DELETE",
"id": "logging.organizations.sinks.delete",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^organizations/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets a sink.",
"flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
"httpMethod": "GET",
"id": "logging.organizations.sinks.get",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^organizations/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists sinks.",
"flatPath": "v2/organizations/{organizationsId}/sinks",
"httpMethod": "GET",
"id": "logging.organizations.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/sinks",
"response": {
"$ref": "ListSinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
"httpMethod": "PATCH",
"id": "logging.organizations.sinks.patch",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^organizations/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"update": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
"httpMethod": "PUT",
"id": "logging.organizations.sinks.update",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^organizations/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
}
}
},
"projects": {
"resources": {
"exclusions": {
"methods": {
"create": {
"description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
"flatPath": "v2/projects/{projectsId}/exclusions",
"httpMethod": "POST",
"id": "logging.projects.exclusions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes an exclusion.",
"flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
"httpMethod": "DELETE",
"id": "logging.projects.exclusions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^projects/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets the description of an exclusion.",
"flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
"httpMethod": "GET",
"id": "logging.projects.exclusions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^projects/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists all the exclusions in a parent resource.",
"flatPath": "v2/projects/{projectsId}/exclusions",
"httpMethod": "GET",
"id": "logging.projects.exclusions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/exclusions",
"response": {
"$ref": "ListExclusionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Changes one or more properties of an existing exclusion.",
"flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
"httpMethod": "PATCH",
"id": "logging.projects.exclusions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
"location": "path",
"pattern": "^projects/[^/]+/exclusions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "LogExclusion"
},
"response": {
"$ref": "LogExclusion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
},
"logs": {
"methods": {
"delete": {
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.",
"flatPath": "v2/projects/{projectsId}/logs/{logsId}",
"httpMethod": "DELETE",
"id": "logging.projects.logs.delete",
"parameterOrder": [
"logName"
],
"parameters": {
"logName": {
"description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^projects/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+logName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"flatPath": "v2/projects/{projectsId}/logs",
"httpMethod": "GET",
"id": "logging.projects.logs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/logs",
"response": {
"$ref": "ListLogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
}
}
},
"metrics": {
"methods": {
"create": {
"description": "Creates a logs-based metric.",
"flatPath": "v2/projects/{projectsId}/metrics",
"httpMethod": "POST",
"id": "logging.projects.metrics.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/metrics",
"request": {
"$ref": "LogMetric"
},
"response": {
"$ref": "LogMetric"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.write"
]
},
"delete": {
"description": "Deletes a logs-based metric.",
"flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
"httpMethod": "DELETE",
"id": "logging.projects.metrics.delete",
"parameterOrder": [
"metricName"
],
"parameters": {
"metricName": {
"description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+/metrics/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+metricName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.write"
]
},
"get": {
"description": "Gets a logs-based metric.",
"flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
"httpMethod": "GET",
"id": "logging.projects.metrics.get",
"parameterOrder": [
"metricName"
],
"parameters": {
"metricName": {
"description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+/metrics/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+metricName}",
"response": {
"$ref": "LogMetric"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists logs-based metrics.",
"flatPath": "v2/projects/{projectsId}/metrics",
"httpMethod": "GET",
"id": "logging.projects.metrics.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/metrics",
"response": {
"$ref": "ListLogMetricsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"update": {
"description": "Creates or updates a logs-based metric.",
"flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
"httpMethod": "PUT",
"id": "logging.projects.metrics.update",
"parameterOrder": [
"metricName"
],
"parameters": {
"metricName": {
"description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
"location": "path",
"pattern": "^projects/[^/]+/metrics/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+metricName}",
"request": {
"$ref": "LogMetric"
},
"response": {
"$ref": "LogMetric"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.write"
]
}
}
},
"sinks": {
"methods": {
"create": {
"description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
"flatPath": "v2/projects/{projectsId}/sinks",
"httpMethod": "POST",
"id": "logging.projects.sinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/sinks",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
"httpMethod": "DELETE",
"id": "logging.projects.sinks.delete",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets a sink.",
"flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
"httpMethod": "GET",
"id": "logging.projects.sinks.get",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists sinks.",
"flatPath": "v2/projects/{projectsId}/sinks",
"httpMethod": "GET",
"id": "logging.projects.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/sinks",
"response": {
"$ref": "ListSinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"patch": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
"httpMethod": "PATCH",
"id": "logging.projects.sinks.patch",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"update": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
"httpMethod": "PUT",
"id": "logging.projects.sinks.update",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
}
}
},
"sinks": {
"methods": {
"create": {
"description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
"flatPath": "v2/{v2Id}/{v2Id1}/sinks",
"httpMethod": "POST",
"id": "logging.sinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/sinks",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
"httpMethod": "DELETE",
"id": "logging.sinks.delete",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
},
"get": {
"description": "Gets a sink.",
"flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
"httpMethod": "GET",
"id": "logging.sinks.get",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+sinkName}",
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"list": {
"description": "Lists sinks.",
"flatPath": "v2/{v2Id}/{v2Id1}/sinks",
"httpMethod": "GET",
"id": "logging.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/sinks",
"response": {
"$ref": "ListSinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
},
"update": {
"description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
"httpMethod": "PUT",
"id": "logging.sinks.update",
"parameterOrder": [
"sinkName"
],
"parameters": {
"sinkName": {
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
"description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+sinkName}",
"request": {
"$ref": "LogSink"
},
"response": {
"$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
}
}
}
},
"revision": "20191007",
"rootUrl": "https://logging.googleapis.com/",
"schemas": {
"BigQueryOptions": {
"description": "Options that change functionality of a sink exporting data to BigQuery.",
"id": "BigQueryOptions",
"properties": {
"usePartitionedTables": {
"description": "Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.",
"type": "boolean"
}
},
"type": "object"
},
"BucketOptions": {
"description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
"id": "BucketOptions",
"properties": {
"explicitBuckets": {
"$ref": "Explicit",
"description": "The explicit buckets."
},
"exponentialBuckets": {
"$ref": "Exponential",
"description": "The exponential buckets."
},
"linearBuckets": {
"$ref": "Linear",
"description": "The linear bucket."
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"id": "Empty",
"properties": {},
"type": "object"
},
"Explicit": {
"description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
"id": "Explicit",
"properties": {
"bounds": {
"description": "The values must be monotonically increasing.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"Exponential": {
"description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
"id": "Exponential",
"properties": {
"growthFactor": {
"description": "Must be greater than 1.",
"format": "double",
"type": "number"
},
"numFiniteBuckets": {
"