{ "id": "logging:v2", "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.read": { "description": "View log data for your projects" }, "https://www.googleapis.com/auth/logging.write": { "description": "Submit log data for your projects" }, "https://www.googleapis.com/auth/logging.admin": { "description": "Administrate log data for your projects" } } } }, "description": "Writes log entries and manages your Stackdriver Logging configuration.", "protocol": "rest", "title": "Stackdriver Logging API", "resources": { "folders": { "resources": { "logs": { "methods": { "list": { "id": "logging.folders.logs.list", "response": { "$ref": "ListLogsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists the logs in projects or organizations. Only logs that have entries are listed.", "flatPath": "v2/folders/{foldersId}/logs", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n", "required": true, "pattern": "^folders/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/logs", "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" ] }, "delete": { "id": "logging.folders.logs.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "logName" ], "description": "Deletes all the log entries in a log. The log reappears if it receives new entries.", "flatPath": "v2/folders/{foldersId}/logs/{logsId}", "httpMethod": "DELETE", "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[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.", "required": true, "pattern": "^folders/[^/]+/logs/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+logName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "sinks": { "methods": { "update": { "id": "logging.folders.sinks.update", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.", "request": { "$ref": "LogSink" }, "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", "httpMethod": "PUT", "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]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^folders/[^/]+/sinks/[^/]+$", "location": "path", "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 was 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 was true and the new value is false.", "location": "query", "type": "boolean" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "id": "logging.folders.sinks.get", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Gets a sink.", "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", "httpMethod": "GET", "parameters": { "sinkName": { "description": "Required. The parent resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^folders/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "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" ] }, "create": { "id": "logging.folders.sinks.create", "response": { "$ref": "LogSink" }, "parameterOrder": [ "parent" ], "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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.", "request": { "$ref": "LogSink" }, "flatPath": "v2/folders/{foldersId}/sinks", "httpMethod": "POST", "parameters": { "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 cloud-logs@google.com, the same identity used 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" }, "parent": { "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^folders/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+parent}/sinks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "list": { "id": "logging.folders.sinks.list", "response": { "$ref": "ListSinksResponse" }, "parameterOrder": [ "parent" ], "description": "Lists sinks.", "flatPath": "v2/folders/{foldersId}/sinks", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^folders/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/sinks", "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" ] }, "delete": { "id": "logging.folders.sinks.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "sinkName" ], "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", "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]\"\nIt is an error if the sink does not exist. Example: \"projects/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist.", "required": true, "pattern": "^folders/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } } } }, "billingAccounts": { "resources": { "logs": { "methods": { "list": { "id": "logging.billingAccounts.logs.list", "response": { "$ref": "ListLogsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists the logs in projects or organizations. Only logs that have entries are listed.", "flatPath": "v2/billingAccounts/{billingAccountsId}/logs", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n", "required": true, "pattern": "^billingAccounts/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/logs", "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" ] }, "delete": { "id": "logging.billingAccounts.logs.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "logName" ], "description": "Deletes all the log entries in a log. The log reappears if it receives new entries.", "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}", "httpMethod": "DELETE", "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[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.", "required": true, "pattern": "^billingAccounts/[^/]+/logs/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+logName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "sinks": { "methods": { "update": { "id": "logging.billingAccounts.sinks.update", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.", "request": { "$ref": "LogSink" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", "httpMethod": "PUT", "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]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", "location": "path", "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 was 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 was true and the new value is false.", "location": "query", "type": "boolean" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "id": "logging.billingAccounts.sinks.get", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Gets a sink.", "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", "httpMethod": "GET", "parameters": { "sinkName": { "description": "Required. The parent resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "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" ] }, "create": { "id": "logging.billingAccounts.sinks.create", "response": { "$ref": "LogSink" }, "parameterOrder": [ "parent" ], "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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.", "request": { "$ref": "LogSink" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks", "httpMethod": "POST", "parameters": { "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 cloud-logs@google.com, the same identity used 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" }, "parent": { "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^billingAccounts/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+parent}/sinks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "list": { "id": "logging.billingAccounts.sinks.list", "response": { "$ref": "ListSinksResponse" }, "parameterOrder": [ "parent" ], "description": "Lists sinks.", "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^billingAccounts/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/sinks", "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" ] }, "delete": { "id": "logging.billingAccounts.sinks.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "sinkName" ], "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", "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]\"\nIt is an error if the sink does not exist. Example: \"projects/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist.", "required": true, "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } } } }, "organizations": { "resources": { "logs": { "methods": { "list": { "id": "logging.organizations.logs.list", "response": { "$ref": "ListLogsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists the logs in projects or organizations. Only logs that have entries are listed.", "flatPath": "v2/organizations/{organizationsId}/logs", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n", "required": true, "pattern": "^organizations/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/logs", "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" ] }, "delete": { "id": "logging.organizations.logs.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "logName" ], "description": "Deletes all the log entries in a log. The log reappears if it receives new entries.", "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}", "httpMethod": "DELETE", "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[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.", "required": true, "pattern": "^organizations/[^/]+/logs/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+logName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "sinks": { "methods": { "update": { "id": "logging.organizations.sinks.update", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.", "request": { "$ref": "LogSink" }, "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", "httpMethod": "PUT", "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]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^organizations/[^/]+/sinks/[^/]+$", "location": "path", "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 was 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 was true and the new value is false.", "location": "query", "type": "boolean" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "id": "logging.organizations.sinks.get", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Gets a sink.", "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", "httpMethod": "GET", "parameters": { "sinkName": { "description": "Required. The parent resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^organizations/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "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" ] }, "create": { "id": "logging.organizations.sinks.create", "response": { "$ref": "LogSink" }, "parameterOrder": [ "parent" ], "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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.", "request": { "$ref": "LogSink" }, "flatPath": "v2/organizations/{organizationsId}/sinks", "httpMethod": "POST", "parameters": { "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 cloud-logs@google.com, the same identity used 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" }, "parent": { "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^organizations/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+parent}/sinks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "list": { "id": "logging.organizations.sinks.list", "response": { "$ref": "ListSinksResponse" }, "parameterOrder": [ "parent" ], "description": "Lists sinks.", "flatPath": "v2/organizations/{organizationsId}/sinks", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^organizations/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/sinks", "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" ] }, "delete": { "id": "logging.organizations.sinks.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "sinkName" ], "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", "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]\"\nIt is an error if the sink does not exist. Example: \"projects/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist.", "required": true, "pattern": "^organizations/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } } } }, "projects": { "resources": { "metrics": { "methods": { "update": { "id": "logging.projects.metrics.update", "response": { "$ref": "LogMetric" }, "parameterOrder": [ "metricName" ], "description": "Creates or updates a logs-based metric.", "request": { "$ref": "LogMetric" }, "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}", "httpMethod": "PUT", "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.", "required": true, "pattern": "^projects/[^/]+/metrics/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+metricName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.write" ] }, "get": { "id": "logging.projects.metrics.get", "response": { "$ref": "LogMetric" }, "parameterOrder": [ "metricName" ], "description": "Gets a logs-based metric.", "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}", "httpMethod": "GET", "parameters": { "metricName": { "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", "required": true, "pattern": "^projects/[^/]+/metrics/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+metricName}", "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" ] }, "create": { "id": "logging.projects.metrics.create", "response": { "$ref": "LogMetric" }, "parameterOrder": [ "parent" ], "description": "Creates a logs-based metric.", "request": { "$ref": "LogMetric" }, "flatPath": "v2/projects/{projectsId}/metrics", "httpMethod": "POST", "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.", "required": true, "pattern": "^projects/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+parent}/metrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.write" ] }, "list": { "id": "logging.projects.metrics.list", "response": { "$ref": "ListLogMetricsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists logs-based metrics.", "flatPath": "v2/projects/{projectsId}/metrics", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n", "required": true, "pattern": "^projects/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/metrics", "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" ] }, "delete": { "id": "logging.projects.metrics.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "metricName" ], "description": "Deletes a logs-based metric.", "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}", "httpMethod": "DELETE", "parameters": { "metricName": { "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", "required": true, "pattern": "^projects/[^/]+/metrics/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+metricName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.write" ] } } }, "logs": { "methods": { "list": { "id": "logging.projects.logs.list", "response": { "$ref": "ListLogsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists the logs in projects or organizations. Only logs that have entries are listed.", "flatPath": "v2/projects/{projectsId}/logs", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n", "required": true, "pattern": "^projects/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/logs", "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" ] }, "delete": { "id": "logging.projects.logs.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "logName" ], "description": "Deletes all the log entries in a log. The log reappears if it receives new entries.", "flatPath": "v2/projects/{projectsId}/logs/{logsId}", "httpMethod": "DELETE", "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[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.", "required": true, "pattern": "^projects/[^/]+/logs/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+logName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "sinks": { "methods": { "update": { "id": "logging.projects.sinks.update", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.", "request": { "$ref": "LogSink" }, "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", "httpMethod": "PUT", "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]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^projects/[^/]+/sinks/[^/]+$", "location": "path", "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 was 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 was true and the new value is false.", "location": "query", "type": "boolean" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "id": "logging.projects.sinks.get", "response": { "$ref": "LogSink" }, "parameterOrder": [ "sinkName" ], "description": "Gets a sink.", "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", "httpMethod": "GET", "parameters": { "sinkName": { "description": "Required. The parent resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, "pattern": "^projects/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "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" ] }, "create": { "id": "logging.projects.sinks.create", "response": { "$ref": "LogSink" }, "parameterOrder": [ "parent" ], "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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.", "request": { "$ref": "LogSink" }, "flatPath": "v2/projects/{projectsId}/sinks", "httpMethod": "POST", "parameters": { "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 cloud-logs@google.com, the same identity used 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" }, "parent": { "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^projects/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+parent}/sinks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "list": { "id": "logging.projects.sinks.list", "response": { "$ref": "ListSinksResponse" }, "parameterOrder": [ "parent" ], "description": "Lists sinks.", "flatPath": "v2/projects/{projectsId}/sinks", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "pattern": "^projects/[^/]+$", "location": "path", "type": "string" }, "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/{+parent}/sinks", "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" ] }, "delete": { "id": "logging.projects.sinks.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "sinkName" ], "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", "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]\"\nIt is an error if the sink does not exist. Example: \"projects/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist.", "required": true, "pattern": "^projects/[^/]+/sinks/[^/]+$", "location": "path", "type": "string" } }, "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } } } }, "entries": { "methods": { "write": { "id": "logging.entries.write", "response": { "$ref": "WriteLogEntriesResponse" }, "parameterOrder": [], "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.", "request": { "$ref": "WriteLogEntriesRequest" }, "flatPath": "v2/entries:write", "httpMethod": "POST", "parameters": {}, "path": "v2/entries:write", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.write" ] }, "list": { "id": "logging.entries.list", "response": { "$ref": "ListLogEntriesResponse" }, "parameterOrder": [], "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.", "request": { "$ref": "ListLogEntriesRequest" }, "flatPath": "v2/entries:list", "httpMethod": "POST", "parameters": {}, "path": "v2/entries:list", "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": { "id": "logging.monitoredResourceDescriptors.list", "response": { "$ref": "ListMonitoredResourceDescriptorsResponse" }, "parameterOrder": [], "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.", "flatPath": "v2/monitoredResourceDescriptors", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "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", "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" ] } } } }, "schemas": { "ListLogEntriesResponse": { "description": "Result returned from ListLogEntries.", "type": "object", "properties": { "entries": { "description": "A list of log entries.", "type": "array", "items": { "$ref": "LogEntry" } }, "nextPageToken": { "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.", "type": "string" } }, "id": "ListLogEntriesResponse" }, "ListSinksResponse": { "description": "Result returned from ListSinks.", "type": "object", "properties": { "nextPageToken": { "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.", "type": "string" }, "sinks": { "description": "A list of sinks.", "type": "array", "items": { "$ref": "LogSink" } } }, "id": "ListSinksResponse" }, "SourceLocation": { "description": "Specifies a location in a source code file.", "type": "object", "properties": { "file": { "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", "type": "string" }, "functionName": { "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).", "type": "string" }, "line": { "description": "Line within the source file.", "type": "string", "format": "int64" } }, "id": "SourceLocation" }, "LogSink": { "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project or organization.", "type": "object", "properties": { "destination": { "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.", "type": "string" }, "filter": { "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n", "type": "string" }, "endTime": { "description": "Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.", "type": "string", "format": "google-datetime" }, "name": { "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", "type": "string" }, "startTime": { "description": "Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.", "type": "string", "format": "google-datetime" }, "outputVersionFormat": { "description": "Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.", "enum": [ "VERSION_FORMAT_UNSPECIFIED", "V2", "V1" ], "enumDescriptions": [ "An unspecified format version that will default to V2.", "LogEntry version 2 format.", "LogEntry version 1 format." ], "type": "string" }, "writerIdentity": { "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.", "type": "string" } }, "id": "LogSink" }, "ListLogsResponse": { "description": "Result returned from ListLogs.", "type": "object", "properties": { "logNames": { "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", "type": "string" } }, "id": "ListLogsResponse" }, "LogMetric": { "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.", "type": "object", "properties": { "description": { "description": "Optional. A description of this metric, which is used in documentation.", "type": "string" }, "filter": { "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.", "type": "string" }, "name": { "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".", "type": "string" }, "version": { "description": "Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.", "enum": [ "V2", "V1" ], "enumDescriptions": [ "Stackdriver Logging API v2.", "Stackdriver Logging API v1." ], "type": "string" } }, "id": "LogMetric" }, "LogEntry": { "description": "An individual entry in a log.", "type": "object", "properties": { "textPayload": { "description": "The log entry payload, represented as a Unicode string (UTF-8).", "type": "string" }, "httpRequest": { "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.", "$ref": "HttpRequest" }, "sourceLocation": { "description": "Optional. Source code location information associated with the log entry, if any.", "$ref": "LogEntrySourceLocation" }, "jsonPayload": { "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "labels": { "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.", "additionalProperties": { "type": "string" }, "type": "object" }, "trace": { "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824", "type": "string" }, "logName": { "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.", "type": "string" }, "severity": { "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.", "enum": [ "DEFAULT", "DEBUG", "INFO", "NOTICE", "WARNING", "ERROR", "CRITICAL", "ALERT", "EMERGENCY" ], "enumDescriptions": [ "(0) The log entry has no assigned severity level.", "(100) Debug or trace information.", "(200) Routine information, such as ongoing status or performance.", "(300) Normal but significant events, such as start up, shut down, or a configuration change.", "(400) Warning events might cause problems.", "(500) Error events are likely to cause problems.", "(600) Critical events cause more severe problems or outages.", "(700) A person must take an action immediately.", "(800) One or more systems are unusable." ], "type": "string" }, "resource": { "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.", "$ref": "MonitoredResource" }, "protoPayload": { "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "timestamp": { "description": "Optional. The time the event described by the log entry occurred. If omitted, Stackdriver Logging will use the time the log entry is received.", "type": "string", "format": "google-datetime" }, "insertId": { "description": "Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same project with the same ID as duplicates which can be removed. If omitted, Stackdriver Logging will generate a unique ID for this log entry.", "type": "string" }, "operation": { "description": "Optional. Information about an operation associated with the log entry, if applicable.", "$ref": "LogEntryOperation" } }, "id": "LogEntry" }, "LogLine": { "description": "Application log line emitted while processing a request.", "type": "object", "properties": { "time": { "description": "Approximate time when this log entry was made.", "type": "string", "format": "google-datetime" }, "severity": { "description": "Severity of this log entry.", "enum": [ "DEFAULT", "DEBUG", "INFO", "NOTICE", "WARNING", "ERROR", "CRITICAL", "ALERT", "EMERGENCY" ], "enumDescriptions": [ "(0) The log entry has no assigned severity level.", "(100) Debug or trace information.", "(200) Routine information, such as ongoing status or performance.", "(300) Normal but significant events, such as start up, shut down, or a configuration change.", "(400) Warning events might cause problems.", "(500) Error events are likely to cause problems.", "(600) Critical events cause more severe problems or outages.", "(700) A person must take an action immediately.", "(800) One or more systems are unusable." ], "type": "string" }, "sourceLocation": { "description": "Where in the source code this log message was written.", "$ref": "SourceLocation" }, "logMessage": { "description": "App-provided log message.", "type": "string" } }, "id": "LogLine" }, "SourceReference": { "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.", "type": "object", "properties": { "repository": { "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", "type": "string" }, "revisionId": { "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"", "type": "string" } }, "id": "SourceReference" }, "MonitoredResource": { "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n", "type": "object", "properties": { "labels": { "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels \"database_id\" and \"zone\".", "additionalProperties": { "type": "string" }, "type": "object" }, "type": { "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is \"cloudsql_database\".", "type": "string" } }, "id": "MonitoredResource" }, "WriteLogEntriesRequest": { "description": "The parameters to WriteLogEntries.", "type": "object", "properties": { "labels": { "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.", "additionalProperties": { "type": "string" }, "type": "object" }, "entries": { "description": "Required. The log entries to write. Values supplied for the fields log_name, resource, and labels in this entries.write request are added to those log entries that do not provide their own values for the fields.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than calling this method for each individual log entry.", "type": "array", "items": { "$ref": "LogEntry" } }, "logName": { "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", "type": "string" }, "partialSuccess": { "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.", "type": "boolean" }, "resource": { "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry.", "$ref": "MonitoredResource" } }, "id": "WriteLogEntriesRequest" }, "LabelDescriptor": { "description": "A description of a label.", "type": "object", "properties": { "description": { "description": "A human-readable description for the label.", "type": "string" }, "valueType": { "description": "The type of data that can be assigned to the label.", "enum": [ "STRING", "BOOL", "INT64" ], "enumDescriptions": [ "A variable-length string. This is the default.", "Boolean; true or false.", "A 64-bit signed integer." ], "type": "string" }, "key": { "description": "The label key.", "type": "string" } }, "id": "LabelDescriptor" }, "ListLogMetricsResponse": { "description": "Result returned from ListLogMetrics.", "type": "object", "properties": { "metrics": { "description": "A list of logs-based metrics.", "type": "array", "items": { "$ref": "LogMetric" } }, "nextPageToken": { "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", "type": "string" } }, "id": "ListLogMetricsResponse" }, "MonitoredResourceDescriptor": { "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.", "type": "object", "properties": { "displayName": { "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".", "type": "string" }, "description": { "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.", "type": "string" }, "labels": { "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".", "type": "array", "items": { "$ref": "LabelDescriptor" } }, "type": { "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.", "type": "string" }, "name": { "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".", "type": "string" } }, "id": "MonitoredResourceDescriptor" }, "ListMonitoredResourceDescriptorsResponse": { "description": "Result returned from ListMonitoredResourceDescriptors.", "type": "object", "properties": { "nextPageToken": { "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", "type": "string" }, "resourceDescriptors": { "description": "A list of resource descriptors.", "type": "array", "items": { "$ref": "MonitoredResourceDescriptor" } } }, "id": "ListMonitoredResourceDescriptorsResponse" }, "LogEntryOperation": { "description": "Additional information about a potentially long-running operation with which a log entry is associated.", "type": "object", "properties": { "producer": { "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".", "type": "string" }, "last": { "description": "Optional. Set this to True if this is the last log entry in the operation.", "type": "boolean" }, "first": { "description": "Optional. Set this to True if this is the first log entry in the operation.", "type": "boolean" }, "id": { "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.", "type": "string" } }, "id": "LogEntryOperation" }, "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 {}.", "type": "object", "properties": {}, "id": "Empty" }, "HttpRequest": { "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", "type": "object", "properties": { "cacheLookup": { "description": "Whether or not a cache lookup was attempted.", "type": "boolean" }, "responseSize": { "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.", "type": "string", "format": "int64" }, "status": { "description": "The response code indicating the status of response. Examples: 200, 404.", "type": "integer", "format": "int32" }, "cacheValidatedWithOriginServer": { "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.", "type": "boolean" }, "referer": { "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", "type": "string" }, "cacheHit": { "description": "Whether or not an entity was served from cache (with or without validation).", "type": "boolean" }, "requestUrl": { "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".", "type": "string" }, "latency": { "description": "The request processing latency on the server, from the time the request was received until the response was sent.", "type": "string", "format": "google-duration" }, "cacheFillBytes": { "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", "type": "string", "format": "int64" }, "requestMethod": { "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".", "type": "string" }, "remoteIp": { "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".", "type": "string" }, "serverIp": { "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", "type": "string" }, "userAgent": { "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".", "type": "string" }, "requestSize": { "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", "type": "string", "format": "int64" } }, "id": "HttpRequest" }, "LogEntrySourceLocation": { "description": "Additional information about the source code location that produced the log entry.", "type": "object", "properties": { "function": { "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).", "type": "string" }, "file": { "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", "type": "string" }, "line": { "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", "type": "string", "format": "int64" } }, "id": "LogEntrySourceLocation" }, "RequestLog": { "description": "Complete log information about a single HTTP request to an App Engine application.", "type": "object", "properties": { "responseSize": { "description": "Size in bytes sent back to client by request.", "type": "string", "format": "int64" }, "requestId": { "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.", "type": "string" }, "first": { "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.", "type": "boolean" }, "method": { "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".", "type": "string" }, "versionId": { "description": "Version of the application that handled this request.", "type": "string" }, "status": { "description": "HTTP response status code. Example: 200, 404.", "type": "integer", "format": "int32" }, "wasLoadingRequest": { "description": "Whether this was a loading request for the instance.", "type": "boolean" }, "ip": { "description": "Origin IP address.", "type": "string" }, "nickname": { "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.", "type": "string" }, "taskQueueName": { "description": "Queue name of the request, in the case of an offline request.", "type": "string" }, "pendingTime": { "description": "Time this request spent in the pending request queue.", "type": "string", "format": "google-duration" }, "instanceIndex": { "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.", "type": "integer", "format": "int32" }, "sourceReference": { "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.", "type": "array", "items": { "$ref": "SourceReference" } }, "moduleId": { "description": "Module of the application that handled this request.", "type": "string" }, "host": { "description": "Internet host and port number of the resource being requested.", "type": "string" }, "latency": { "description": "Latency of the request.", "type": "string", "format": "google-duration" }, "urlMapEntry": { "description": "File or class that handled the request.", "type": "string" }, "endTime": { "description": "Time when the request finished.", "type": "string", "format": "google-datetime" }, "line": { "description": "A list of log lines emitted by the application while serving this request.", "type": "array", "items": { "$ref": "LogLine" } }, "megaCycles": { "description": "Number of CPU megacycles used to process request.", "type": "string", "format": "int64" }, "appId": { "description": "Application that handled this request.", "type": "string" }, "traceId": { "description": "Stackdriver Trace identifier for this request.", "type": "string" }, "taskName": { "description": "Task name of the request, in the case of an offline request.", "type": "string" }, "cost": { "description": "An indication of the relative cost of serving this request.", "type": "number", "format": "double" }, "instanceId": { "description": "An identifier for the instance that handled the request.", "type": "string" }, "startTime": { "description": "Time when the request started.", "type": "string", "format": "google-datetime" }, "appEngineRelease": { "description": "App Engine release version.", "type": "string" }, "resource": { "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.", "type": "string" }, "httpVersion": { "description": "HTTP version of request. Example: \"HTTP/1.1\".", "type": "string" }, "referrer": { "description": "Referrer URL of request.", "type": "string" }, "userAgent": { "description": "User agent that made the request.", "type": "string" }, "finished": { "description": "Whether this request is finished or active.", "type": "boolean" } }, "id": "RequestLog" }, "WriteLogEntriesResponse": { "description": "Result returned from WriteLogEntries. empty", "type": "object", "properties": {}, "id": "WriteLogEntriesResponse" }, "ListLogEntriesRequest": { "description": "The parameters to ListLogEntries.", "type": "object", "properties": { "filter": { "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.", "type": "string" }, "projectIds": { "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.", "type": "array", "items": { "type": "string" } }, "resourceNames": { "description": "Required. Names of one or more resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\nProjects listed in the project_ids field are added to this list.", "type": "array", "items": { "type": "string" } }, "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.", "type": "integer", "format": "int32" }, "orderBy": { "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of LogEntry.insertId.", "type": "string" }, "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.", "type": "string" } }, "id": "ListLogEntriesRequest" } }, "revision": "20170103", "basePath": "", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "version_module": "True", "canonicalName": "Logging", "discoveryVersion": "v1", "baseUrl": "https://logging.googleapis.com/", "name": "logging", "parameters": { "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "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.", "type": "string", "location": "query" }, "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.", "type": "string", "location": "query" }, "pp": { "description": "Pretty-print response.", "default": "true", "type": "boolean", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "alt": { "description": "Data format for response.", "location": "query", "enum": [ "json", "media", "proto" ], "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string" }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "location": "query" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "bearer_token": { "description": "OAuth bearer token.", "type": "string", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" } }, "documentationLink": "https://cloud.google.com/logging/docs/", "ownerDomain": "google.com", "batchPath": "batch", "servicePath": "", "ownerName": "Google", "version": "v2", "rootUrl": "https://logging.googleapis.com/", "kind": "discovery#restDescription" }