Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1866)

Unified Diff: discovery/googleapis/logging__v2.json

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)
Patch Set: Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/licensing__v1.json ('k') | discovery/googleapis/manufacturers__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/logging__v2.json
diff --git a/discovery/googleapis/logging__v2.json b/discovery/googleapis/logging__v2.json
index cdde5a9035790ea9a5d5d7845349bae5e941fdca..2c65d59a884058b88f3f52617167e9b2b213e828 100644
--- a/discovery/googleapis/logging__v2.json
+++ b/discovery/googleapis/logging__v2.json
@@ -37,6 +37,34 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -53,13 +81,13 @@
"location": "query",
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
+ "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"
},
- "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.",
+ "access_token": {
+ "description": "OAuth access token.",
"location": "query",
"type": "string"
},
@@ -94,46 +122,18 @@
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
}
},
"protocol": "rest",
"resources": {
- "folders": {
+ "organizations": {
"resources": {
"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.",
"httpMethod": "DELETE",
- "id": "logging.folders.logs.delete",
+ "id": "logging.organizations.logs.delete",
"parameterOrder": [
"logName"
],
@@ -141,7 +141,7 @@
"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/[^/]+$",
+ "pattern": "^organizations/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
@@ -158,7 +158,7 @@
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"httpMethod": "GET",
- "id": "logging.folders.logs.list",
+ "id": "logging.organizations.logs.list",
"parameterOrder": [
"parent"
],
@@ -177,7 +177,7 @@
"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/[^/]+$",
+ "pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
@@ -200,7 +200,7 @@
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"httpMethod": "DELETE",
- "id": "logging.folders.sinks.delete",
+ "id": "logging.organizations.sinks.delete",
"parameterOrder": [
"sinkName"
],
@@ -208,7 +208,7 @@
"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/[^/]+$",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -225,18 +225,11 @@
"list": {
"description": "Lists sinks.",
"httpMethod": "GET",
- "id": "logging.folders.sinks.list",
+ "id": "logging.organizations.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
- "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"
- },
"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",
@@ -247,6 +240,13 @@
"format": "int32",
"location": "query",
"type": "integer"
+ },
+ "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",
@@ -263,7 +263,7 @@
"get": {
"description": "Gets a sink.",
"httpMethod": "GET",
- "id": "logging.folders.sinks.get",
+ "id": "logging.organizations.sinks.get",
"parameterOrder": [
"sinkName"
],
@@ -271,7 +271,7 @@
"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/[^/]+$",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -290,7 +290,7 @@
"update": {
"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.",
"httpMethod": "PUT",
- "id": "logging.folders.sinks.update",
+ "id": "logging.organizations.sinks.update",
"parameterOrder": [
"sinkName"
],
@@ -298,12 +298,12 @@
"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/[^/]+$",
+ "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 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.",
+ "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 false.",
"location": "query",
"type": "boolean"
}
@@ -323,7 +323,7 @@
"create": {
"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.",
"httpMethod": "POST",
- "id": "logging.folders.sinks.create",
+ "id": "logging.organizations.sinks.create",
"parameterOrder": [
"parent"
],
@@ -331,12 +331,12 @@
"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/[^/]+$",
+ "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 cloud-logs@system.gserviceaccount.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.",
+ "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 Stackdriver 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"
}
@@ -357,29 +357,20 @@
}
}
},
- "monitoredResourceDescriptors": {
+ "entries": {
"methods": {
"list": {
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
- "httpMethod": "GET",
- "id": "logging.monitoredResourceDescriptors.list",
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "httpMethod": "POST",
+ "id": "logging.entries.list",
"parameterOrder": [],
- "parameters": {
- "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"
- },
- "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"
- }
+ "parameters": {},
+ "path": "v2/entries:list",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
},
- "path": "v2/monitoredResourceDescriptors",
"response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
+ "$ref": "ListLogEntriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -387,17 +378,61 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
+ },
+ "write": {
+ "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.",
+ "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"
+ ]
}
}
},
- "organizations": {
+ "projects": {
"resources": {
"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.",
+ "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.",
"httpMethod": "GET",
- "id": "logging.organizations.logs.list",
+ "id": "logging.projects.logs.list",
"parameterOrder": [
"parent"
],
@@ -411,7 +446,7 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
@@ -431,40 +466,81 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "update": {
+ "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.",
+ "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 false.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "v2/{+sinkName}",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
},
- "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.",
- "httpMethod": "DELETE",
- "id": "logging.organizations.logs.delete",
+ "create": {
+ "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.",
+ "httpMethod": "POST",
+ "id": "logging.projects.sinks.create",
"parameterOrder": [
- "logName"
+ "parent"
],
"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.",
+ "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/[^/]+/logs/[^/]+$",
+ "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 Stackdriver 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/{+logName}",
+ "path": "v2/{+parent}/sinks",
+ "request": {
+ "$ref": "LogSink"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "LogSink"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
- }
- }
- },
- "sinks": {
- "methods": {
+ },
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"httpMethod": "DELETE",
- "id": "logging.organizations.sinks.delete",
+ "id": "logging.projects.sinks.delete",
"parameterOrder": [
"sinkName"
],
@@ -472,7 +548,7 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -489,11 +565,16 @@
"list": {
"description": "Lists sinks.",
"httpMethod": "GET",
- "id": "logging.organizations.sinks.list",
+ "id": "logging.projects.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
+ "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"
+ },
"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",
@@ -503,14 +584,9 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+$",
"required": true,
"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",
@@ -527,7 +603,7 @@
"get": {
"description": "Gets a sink.",
"httpMethod": "GET",
- "id": "logging.organizations.sinks.get",
+ "id": "logging.projects.sinks.get",
"parameterOrder": [
"sinkName"
],
@@ -535,7 +611,7 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -550,128 +626,172 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
]
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a logs-based metric.",
+ "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"
+ ]
+ },
+ "list": {
+ "description": "Lists logs-based metrics.",
+ "httpMethod": "GET",
+ "id": "logging.projects.metrics.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ ]
+ },
+ "get": {
+ "description": "Gets a logs-based metric.",
+ "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"
+ ]
},
"update": {
- "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.",
+ "description": "Creates or updates a logs-based metric.",
"httpMethod": "PUT",
- "id": "logging.organizations.sinks.update",
+ "id": "logging.projects.metrics.update",
"parameterOrder": [
- "sinkName"
+ "metricName"
],
"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\".",
+ "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": "^organizations/[^/]+/sinks/[^/]+$",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
"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 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}",
+ "path": "v2/{+metricName}",
"request": {
- "$ref": "LogSink"
+ "$ref": "LogMetric"
},
"response": {
- "$ref": "LogSink"
+ "$ref": "LogMetric"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
]
},
"create": {
- "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.",
+ "description": "Creates a logs-based metric.",
"httpMethod": "POST",
- "id": "logging.organizations.sinks.create",
+ "id": "logging.projects.metrics.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\".",
+ "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": "^organizations/[^/]+$",
+ "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 cloud-logs@system.gserviceaccount.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"
}
},
- "path": "v2/{+parent}/sinks",
+ "path": "v2/{+parent}/metrics",
"request": {
- "$ref": "LogSink"
+ "$ref": "LogMetric"
},
"response": {
- "$ref": "LogSink"
+ "$ref": "LogMetric"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
]
}
}
}
}
},
- "entries": {
- "methods": {
- "write": {
- "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.",
- "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"
- ]
- },
- "list": {
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "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"
- ]
- }
- }
- },
- "projects": {
+ "billingAccounts": {
"resources": {
"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.",
"httpMethod": "DELETE",
- "id": "logging.projects.logs.delete",
+ "id": "logging.billingAccounts.logs.delete",
"parameterOrder": [
"logName"
],
@@ -679,7 +799,7 @@
"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/[^/]+$",
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
@@ -696,11 +816,18 @@
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"httpMethod": "GET",
- "id": "logging.projects.logs.list",
+ "id": "logging.billingAccounts.logs.list",
"parameterOrder": [
"parent"
],
"parameters": {
+ "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"
+ },
"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",
@@ -711,13 +838,6 @@
"format": "int32",
"location": "query",
"type": "integer"
- },
- "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",
@@ -738,7 +858,7 @@
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"httpMethod": "DELETE",
- "id": "logging.projects.sinks.delete",
+ "id": "logging.billingAccounts.sinks.delete",
"parameterOrder": [
"sinkName"
],
@@ -746,7 +866,7 @@
"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/[^/]+$",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -763,18 +883,11 @@
"list": {
"description": "Lists sinks.",
"httpMethod": "GET",
- "id": "logging.projects.sinks.list",
+ "id": "logging.billingAccounts.sinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
- "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"
- },
"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",
@@ -785,6 +898,13 @@
"format": "int32",
"location": "query",
"type": "integer"
+ },
+ "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",
@@ -801,7 +921,7 @@
"get": {
"description": "Gets a sink.",
"httpMethod": "GET",
- "id": "logging.projects.sinks.get",
+ "id": "logging.billingAccounts.sinks.get",
"parameterOrder": [
"sinkName"
],
@@ -809,7 +929,7 @@
"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/[^/]+$",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -828,7 +948,7 @@
"update": {
"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.",
"httpMethod": "PUT",
- "id": "logging.projects.sinks.update",
+ "id": "logging.billingAccounts.sinks.update",
"parameterOrder": [
"sinkName"
],
@@ -836,12 +956,12 @@
"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/[^/]+$",
+ "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 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.",
+ "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 false.",
"location": "query",
"type": "boolean"
}
@@ -861,22 +981,22 @@
"create": {
"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.",
"httpMethod": "POST",
- "id": "logging.projects.sinks.create",
+ "id": "logging.billingAccounts.sinks.create",
"parameterOrder": [
"parent"
],
"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@system.gserviceaccount.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]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
- "pattern": "^projects/[^/]+$",
+ "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 Stackdriver 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",
@@ -892,170 +1012,17 @@
]
}
}
- },
- "metrics": {
- "methods": {
- "update": {
- "description": "Creates or updates a logs-based metric.",
- "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"
- ]
- },
- "create": {
- "description": "Creates a logs-based metric.",
- "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.",
- "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"
- ]
- },
- "list": {
- "description": "Lists logs-based metrics.",
- "httpMethod": "GET",
- "id": "logging.projects.metrics.list",
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "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"
- },
- "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"
- },
- "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"
- ]
- },
- "get": {
- "description": "Gets a logs-based metric.",
- "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"
- ]
- }
- }
}
}
},
- "billingAccounts": {
+ "folders": {
"resources": {
"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.",
"httpMethod": "DELETE",
- "id": "logging.billingAccounts.logs.delete",
+ "id": "logging.folders.logs.delete",
"parameterOrder": [
"logName"
],
@@ -1063,7 +1030,7 @@
"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/[^/]+$",
+ "pattern": "^folders/[^/]+/logs/[^/]+$",
"required": true,
"type": "string"
}
@@ -1080,11 +1047,16 @@
"list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"httpMethod": "GET",
- "id": "logging.billingAccounts.logs.list",
+ "id": "logging.folders.logs.list",
"parameterOrder": [
"parent"
],
"parameters": {
+ "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"
+ },
"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",
@@ -1094,14 +1066,9 @@
"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/[^/]+$",
+ "pattern": "^folders/[^/]+$",
"required": true,
"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",
@@ -1122,7 +1089,7 @@
"delete": {
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"httpMethod": "DELETE",
- "id": "logging.billingAccounts.sinks.delete",
+ "id": "logging.folders.sinks.delete",
"parameterOrder": [
"sinkName"
],
@@ -1130,7 +1097,7 @@
"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/[^/]+$",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -1147,7 +1114,7 @@
"list": {
"description": "Lists sinks.",
"httpMethod": "GET",
- "id": "logging.billingAccounts.sinks.list",
+ "id": "logging.folders.sinks.list",
"parameterOrder": [
"parent"
],
@@ -1166,7 +1133,7 @@
"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/[^/]+$",
+ "pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
@@ -1185,7 +1152,7 @@
"get": {
"description": "Gets a sink.",
"httpMethod": "GET",
- "id": "logging.billingAccounts.sinks.get",
+ "id": "logging.folders.sinks.get",
"parameterOrder": [
"sinkName"
],
@@ -1193,7 +1160,7 @@
"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/[^/]+$",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
}
@@ -1212,7 +1179,7 @@
"update": {
"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.",
"httpMethod": "PUT",
- "id": "logging.billingAccounts.sinks.update",
+ "id": "logging.folders.sinks.update",
"parameterOrder": [
"sinkName"
],
@@ -1220,12 +1187,12 @@
"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/[^/]+$",
+ "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 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.",
+ "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 false.",
"location": "query",
"type": "boolean"
}
@@ -1245,7 +1212,7 @@
"create": {
"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.",
"httpMethod": "POST",
- "id": "logging.billingAccounts.sinks.create",
+ "id": "logging.folders.sinks.create",
"parameterOrder": [
"parent"
],
@@ -1253,12 +1220,12 @@
"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/[^/]+$",
+ "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 cloud-logs@system.gserviceaccount.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.",
+ "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 Stackdriver 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"
}
@@ -1278,770 +1245,803 @@
}
}
}
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
+ "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"
+ ]
+ }
+ }
}
},
- "revision": "20170210",
+ "revision": "20170228",
"rootUrl": "https://logging.googleapis.com/",
"schemas": {
- "ListLogsResponse": {
- "description": "Result returned from ListLogs.",
- "id": "ListLogsResponse",
+ "ListLogEntriesRequest": {
+ "description": "The parameters to ListLogEntries.",
+ "id": "ListLogEntriesRequest",
"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.",
+ "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",
+ "type": "integer"
+ },
+ "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"
},
- "logNames": {
- "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
+ "resourceNames": {
+ "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
"items": {
"type": "string"
},
"type": "array"
- }
- },
- "type": "object"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "type": "object"
},
- "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.",
- "id": "HttpRequest",
+ "RequestLog": {
+ "description": "Complete log information about a single HTTP request to an App Engine application.",
+ "id": "RequestLog",
"properties": {
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "megaCycles": {
+ "description": "Number of CPU megacycles used to process request.",
+ "format": "int64",
"type": "string"
},
- "requestSize": {
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "format": "int64",
+ "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"
+ },
+ "versionId": {
+ "description": "Version of the application that handled this request.",
+ "type": "string"
+ },
+ "moduleId": {
+ "description": "Module of the application that handled this request.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time when the request finished.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "userAgent": {
+ "description": "User agent that made the request.",
"type": "string"
},
+ "wasLoadingRequest": {
+ "description": "Whether this was a loading request for the instance.",
+ "type": "boolean"
+ },
+ "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.",
+ "items": {
+ "$ref": "SourceReference"
+ },
+ "type": "array"
+ },
"responseSize": {
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "description": "Size in bytes sent back to client by request.",
"format": "int64",
"type": "string"
},
- "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\".",
+ "traceId": {
+ "description": "Stackdriver Trace identifier for this request.",
"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"
+ "line": {
+ "description": "A list of log lines emitted by the application while serving this request.",
+ "items": {
+ "$ref": "LogLine"
+ },
+ "type": "array"
},
- "serverIp": {
- "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
+ "referrer": {
+ "description": "Referrer URL of request.",
"type": "string"
},
- "cacheLookup": {
- "description": "Whether or not a cache lookup was attempted.",
- "type": "boolean"
+ "taskQueueName": {
+ "description": "Queue name of the request, in the case of an offline request.",
+ "type": "string"
},
- "cacheHit": {
- "description": "Whether or not an entity was served from cache (with or without validation).",
- "type": "boolean"
+ "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"
},
- "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"
+ "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"
},
"status": {
- "description": "The response code indicating the status of response. Examples: 200, 404.",
+ "description": "HTTP response status code. Example: 200, 404.",
"format": "int32",
"type": "integer"
},
- "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).",
+ "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"
},
- "latency": {
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "pendingTime": {
+ "description": "Time this request spent in the pending request queue.",
"format": "google-duration",
"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)\".",
+ "taskName": {
+ "description": "Task name of the request, in the case of an offline request.",
"type": "string"
},
- "cacheFillBytes": {
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListSinksResponse": {
- "description": "Result returned from ListSinks.",
- "id": "ListSinksResponse",
- "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.",
+ "urlMapEntry": {
+ "description": "File or class that handled the request.",
"type": "string"
},
- "sinks": {
- "description": "A list of sinks.",
- "items": {
- "$ref": "LogSink"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LabelDescriptor": {
- "description": "A description of a label.",
- "id": "LabelDescriptor",
- "properties": {
- "key": {
- "description": "The label key.",
- "type": "string"
+ "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.",
+ "format": "int32",
+ "type": "integer"
},
- "description": {
- "description": "A human-readable description for the label.",
+ "finished": {
+ "description": "Whether this request is finished or active.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Internet host and port number of the resource being requested.",
"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."
- ],
+ "httpVersion": {
+ "description": "HTTP version of request. Example: \"HTTP/1.1\".",
"type": "string"
- }
- },
- "type": "object"
- },
- "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.",
- "id": "MonitoredResourceDescriptor",
- "properties": {
- "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}\".",
+ },
+ "startTime": {
+ "description": "Time when the request started.",
+ "format": "google-datetime",
"type": "string"
},
- "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\".",
+ "latency": {
+ "description": "Latency of the request.",
+ "format": "google-duration",
"type": "string"
},
- "description": {
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
+ "ip": {
+ "description": "Origin IP address.",
"type": "string"
},
- "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.",
+ "appId": {
+ "description": "Application that handled this request.",
"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\".",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LogEntrySourceLocation": {
- "description": "Additional information about the source code location that produced the log entry.",
- "id": "LogEntrySourceLocation",
- "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).",
+ "appEngineRelease": {
+ "description": "App Engine release version.",
"type": "string"
},
- "line": {
- "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
- "format": "int64",
+ "method": {
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
"type": "string"
},
- "file": {
- "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "cost": {
+ "description": "An indication of the relative cost of serving this request.",
+ "format": "double",
+ "type": "number"
+ },
+ "instanceId": {
+ "description": "An identifier for the instance that handled the request.",
"type": "string"
}
},
"type": "object"
},
- "ListLogEntriesResponse": {
- "description": "Result returned from ListLogEntries.",
- "id": "ListLogEntriesResponse",
+ "ListMonitoredResourceDescriptorsResponse": {
+ "description": "Result returned from ListMonitoredResourceDescriptors.",
+ "id": "ListMonitoredResourceDescriptorsResponse",
"properties": {
- "entries": {
- "description": "A list of log entries.",
+ "resourceDescriptors": {
+ "description": "A list of resource descriptors.",
"items": {
- "$ref": "LogEntry"
+ "$ref": "MonitoredResourceDescriptor"
},
"type": "array"
},
"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.",
+ "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"
}
},
"type": "object"
},
- "LogLine": {
- "description": "Application log line emitted while processing a request.",
- "id": "LogLine",
+ "SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
+ "id": "SourceReference",
"properties": {
- "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"
- },
- "logMessage": {
- "description": "App-provided log message.",
- "type": "string"
- },
- "sourceLocation": {
- "$ref": "SourceLocation",
- "description": "Where in the source code this log message was written."
- },
- "time": {
- "description": "Approximate time when this log entry was made.",
- "format": "google-datetime",
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"type": "string"
- }
- },
- "type": "object"
- },
- "ListLogMetricsResponse": {
- "description": "Result returned from ListLogMetrics.",
- "id": "ListLogMetricsResponse",
- "properties": {
- "metrics": {
- "description": "A list of logs-based metrics.",
- "items": {
- "$ref": "LogMetric"
- },
- "type": "array"
},
- "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.",
+ "repository": {
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
"type": "string"
}
},
"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",
+ "WriteLogEntriesResponse": {
+ "description": "Result returned from WriteLogEntries. empty",
+ "id": "WriteLogEntriesResponse",
"properties": {},
"type": "object"
},
- "LogEntry": {
- "description": "An individual entry in a log.",
- "id": "LogEntry",
+ "LogEntryOperation": {
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
+ "id": "LogEntryOperation",
"properties": {
- "httpRequest": {
- "$ref": "HttpRequest",
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
- },
- "resource": {
- "$ref": "MonitoredResource",
- "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."
- },
- "jsonPayload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
- "type": "object"
- },
- "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": {
- "$ref": "LogEntryOperation",
- "description": "Optional. Information about an operation associated with the log entry, if applicable."
- },
- "textPayload": {
- "description": "The log entry payload, represented as a Unicode string (UTF-8).",
+ "id": {
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
"type": "string"
},
- "protoPayload": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
- "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",
+ "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"
},
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object"
+ "first": {
+ "description": "Optional. Set this to True if this is the first log entry in the operation.",
+ "type": "boolean"
},
- "severity": {
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
+ "last": {
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "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.",
+ "id": "LogMetric",
+ "properties": {
+ "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": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
+ "V2",
+ "V1"
],
"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."
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
],
"type": "string"
},
- "sourceLocation": {
- "$ref": "LogEntrySourceLocation",
- "description": "Optional. Source code location information associated with the log entry, if any."
+ "filter": {
+ "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity>=ERROR\"\nThe maximum length of the filter is 20000 characters.",
+ "type": "string"
},
- "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.",
- "format": "google-datetime",
+ "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"
},
- "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\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_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.",
+ "description": {
+ "description": "Optional. A description of this metric, which is used in documentation.",
"type": "string"
}
},
"type": "object"
},
- "SourceLocation": {
- "description": "Specifies a location in a source code file.",
- "id": "SourceLocation",
+ "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",
+ "id": "MonitoredResource",
"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"
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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\".",
+ "type": "object"
},
- "line": {
- "description": "Line within the source file.",
- "format": "int64",
+ "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"
}
},
"type": "object"
},
- "ListLogEntriesRequest": {
- "description": "The parameters to ListLogEntries.",
- "id": "ListLogEntriesRequest",
+ "WriteLogEntriesRequest": {
+ "description": "The parameters to WriteLogEntries.",
+ "id": "WriteLogEntriesRequest",
"properties": {
- "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"
- },
- "resourceNames": {
- "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
- "items": {
+ "labels": {
+ "additionalProperties": {
"type": "string"
},
- "type": "array"
+ "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.",
+ "type": "object"
},
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "resource": {
+ "$ref": "MonitoredResource",
+ "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."
},
- "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.",
+ "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\"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\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"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"
+ "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.",
+ "items": {
+ "$ref": "LogEntry"
+ },
+ "type": "array"
},
- "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",
- "type": "integer"
+ "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"
}
},
"type": "object"
},
- "RequestLog": {
- "description": "Complete log information about a single HTTP request to an App Engine application.",
- "id": "RequestLog",
+ "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, organization, billing account, or folder.",
+ "id": "LogSink",
"properties": {
- "versionId": {
- "description": "Version of the application that handled this request.",
+ "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"
},
- "moduleId": {
- "description": "Module of the application that handled this request.",
+ "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>=ERROR\n",
"type": "string"
},
"endTime": {
- "description": "Time when the request finished.",
+ "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.",
"format": "google-datetime",
"type": "string"
},
- "userAgent": {
- "description": "User agent that made the request.",
+ "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"
},
- "wasLoadingRequest": {
- "description": "Whether this was a loading request for the instance.",
- "type": "boolean"
+ "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.",
+ "format": "google-datetime",
+ "type": "string"
},
- "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.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "ListLogsResponse": {
+ "description": "Result returned from ListLogs.",
+ "id": "ListLogsResponse",
+ "properties": {
+ "logNames": {
+ "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
"items": {
- "$ref": "SourceReference"
+ "type": "string"
},
"type": "array"
},
- "responseSize": {
- "description": "Size in bytes sent back to client by request.",
- "format": "int64",
- "type": "string"
- },
- "traceId": {
- "description": "Stackdriver Trace identifier for this request.",
+ "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"
- },
- "line": {
- "description": "A list of log lines emitted by the application while serving this request.",
+ }
+ },
+ "type": "object"
+ },
+ "ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
+ "id": "ListSinksResponse",
+ "properties": {
+ "sinks": {
+ "description": "A list of sinks.",
"items": {
- "$ref": "LogLine"
+ "$ref": "LogSink"
},
"type": "array"
},
- "referrer": {
- "description": "Referrer URL of request.",
+ "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"
- },
- "taskQueueName": {
- "description": "Queue name of the request, in the case of an offline request.",
+ }
+ },
+ "type": "object"
+ },
+ "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.",
+ "id": "HttpRequest",
+ "properties": {
+ "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"
},
- "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.",
+ "serverIp": {
+ "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
"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.",
+ "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"
},
+ "cacheLookup": {
+ "description": "Whether or not a cache lookup was attempted.",
+ "type": "boolean"
+ },
+ "cacheHit": {
+ "description": "Whether or not an entity was served from cache (with or without validation).",
+ "type": "boolean"
+ },
+ "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"
+ },
"status": {
- "description": "HTTP response status code. Example: 200, 404.",
+ "description": "The response code indicating the status of response. Examples: 200, 404.",
"format": "int32",
"type": "integer"
},
- "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.",
+ "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"
},
- "pendingTime": {
- "description": "Time this request spent in the pending request queue.",
- "format": "google-duration",
+ "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"
},
- "taskName": {
- "description": "Task name of the request, in the case of an offline request.",
+ "latency": {
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "format": "google-duration",
"type": "string"
},
- "urlMapEntry": {
- "description": "File or class that handled the request.",
+ "cacheFillBytes": {
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "format": "int64",
"type": "string"
},
- "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.",
- "format": "int32",
- "type": "integer"
- },
- "finished": {
- "description": "Whether this request is finished or active.",
- "type": "boolean"
- },
- "host": {
- "description": "Internet host and port number of the resource being requested.",
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
"type": "string"
},
- "httpVersion": {
- "description": "HTTP version of request. Example: \"HTTP/1.1\".",
+ "responseSize": {
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "format": "int64",
"type": "string"
},
- "startTime": {
- "description": "Time when the request started.",
- "format": "google-datetime",
+ "requestSize": {
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
"type": "string"
- },
- "latency": {
- "description": "Latency of the request.",
- "format": "google-duration",
+ }
+ },
+ "type": "object"
+ },
+ "LabelDescriptor": {
+ "description": "A description of a label.",
+ "id": "LabelDescriptor",
+ "properties": {
+ "key": {
+ "description": "The label key.",
"type": "string"
},
- "ip": {
- "description": "Origin IP address.",
+ "description": {
+ "description": "A human-readable description for the label.",
"type": "string"
},
- "appId": {
- "description": "Application that handled this request.",
+ "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"
- },
- "appEngineRelease": {
- "description": "App Engine release version.",
+ }
+ },
+ "type": "object"
+ },
+ "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.",
+ "id": "MonitoredResourceDescriptor",
+ "properties": {
+ "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"
},
- "method": {
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
+ "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"
},
- "cost": {
- "description": "An indication of the relative cost of serving this request.",
- "format": "double",
- "type": "number"
- },
- "instanceId": {
- "description": "An identifier for the instance that handled the request.",
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
"type": "string"
},
- "megaCycles": {
- "description": "Number of CPU megacycles used to process request.",
- "format": "int64",
+ "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"
},
- "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"
+ "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\".",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "ListMonitoredResourceDescriptorsResponse": {
- "description": "Result returned from ListMonitoredResourceDescriptors.",
- "id": "ListMonitoredResourceDescriptorsResponse",
+ "LogEntrySourceLocation": {
+ "description": "Additional information about the source code location that produced the log entry.",
+ "id": "LogEntrySourceLocation",
"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.",
+ "line": {
+ "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
+ "format": "int64",
"type": "string"
},
- "resourceDescriptors": {
- "description": "A list of resource descriptors.",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "type": "array"
+ "file": {
+ "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "type": "string"
+ },
+ "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"
}
},
"type": "object"
},
- "SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
- "id": "SourceReference",
+ "ListLogEntriesResponse": {
+ "description": "Result returned from ListLogEntries.",
+ "id": "ListLogEntriesResponse",
"properties": {
- "repository": {
- "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
+ "entries": {
+ "description": "A list of log entries.",
+ "items": {
+ "$ref": "LogEntry"
+ },
+ "type": "array"
},
- "revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "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"
}
},
"type": "object"
},
- "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.",
- "id": "LogMetric",
+ "LogLine": {
+ "description": "Application log line emitted while processing a request.",
+ "id": "LogLine",
"properties": {
- "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"
+ "sourceLocation": {
+ "$ref": "SourceLocation",
+ "description": "Where in the source code this log message was written."
},
- "description": {
- "description": "Optional. A description of this metric, which is used in documentation.",
+ "time": {
+ "description": "Approximate time when this log entry was made.",
+ "format": "google-datetime",
"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.",
+ "severity": {
+ "description": "Severity of this log entry.",
"enum": [
- "V2",
- "V1"
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
],
"enumDescriptions": [
- "Stackdriver Logging API v2.",
- "Stackdriver Logging API v1."
+ "(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"
},
- "filter": {
- "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity>=ERROR\"\nThe maximum length of the filter is 20000 characters.",
+ "logMessage": {
+ "description": "App-provided log message.",
"type": "string"
}
},
"type": "object"
},
- "WriteLogEntriesResponse": {
- "description": "Result returned from WriteLogEntries. empty",
- "id": "WriteLogEntriesResponse",
+ "ListLogMetricsResponse": {
+ "description": "Result returned from ListLogMetrics.",
+ "id": "ListLogMetricsResponse",
+ "properties": {
+ "metrics": {
+ "description": "A list of logs-based metrics.",
+ "items": {
+ "$ref": "LogMetric"
+ },
+ "type": "array"
+ },
+ "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"
+ }
+ },
+ "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"
},
- "LogEntryOperation": {
- "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
- "id": "LogEntryOperation",
+ "LogEntry": {
+ "description": "An individual entry in a log.",
+ "id": "LogEntry",
"properties": {
- "id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "httpRequest": {
+ "$ref": "HttpRequest",
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "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."
+ },
+ "jsonPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object"
+ },
+ "operation": {
+ "$ref": "LogEntryOperation",
+ "description": "Optional. Information about an operation associated with the log entry, if applicable."
+ },
+ "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"
},
- "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\".",
+ "textPayload": {
+ "description": "The log entry payload, represented as a Unicode string (UTF-8).",
"type": "string"
},
- "first": {
- "description": "Optional. Set this to True if this is the first log entry in the operation.",
- "type": "boolean"
+ "protoPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
+ "type": "object"
},
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "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",
- "id": "MonitoredResource",
- "properties": {
- "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\".",
+ "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"
},
"labels": {
"additionalProperties": {
"type": "string"
},
- "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\".",
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
"type": "object"
- }
- },
- "type": "object"
- },
- "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, organization, billing account, or folder.",
- "id": "LogSink",
- "properties": {
- "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.",
+ },
+ "severity": {
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
"enum": [
- "VERSION_FORMAT_UNSPECIFIED",
- "V2",
- "V1"
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
],
"enumDescriptions": [
- "An unspecified format version that will default to V2.",
- "LogEntry version 2 format.",
- "LogEntry version 1 format."
+ "(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"
},
- "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"
- },
- "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>=ERROR\n",
- "type": "string"
+ "sourceLocation": {
+ "$ref": "LogEntrySourceLocation",
+ "description": "Optional. Source code location information associated with the log entry, if any."
},
- "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.",
+ "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.",
"format": "google-datetime",
"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"
- },
- "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.",
- "format": "google-datetime",
+ "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\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_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"
}
},
"type": "object"
},
- "WriteLogEntriesRequest": {
- "description": "The parameters to WriteLogEntries.",
- "id": "WriteLogEntriesRequest",
+ "SourceLocation": {
+ "description": "Specifies a location in a source code file.",
+ "id": "SourceLocation",
"properties": {
- "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\"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\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "file": {
+ "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
"type": "string"
},
- "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.",
- "items": {
- "$ref": "LogEntry"
- },
- "type": "array"
- },
- "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"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "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.",
- "type": "object"
+ "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"
},
- "resource": {
- "$ref": "MonitoredResource",
- "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."
+ "line": {
+ "description": "Line within the source file.",
+ "format": "int64",
+ "type": "string"
}
},
"type": "object"
« no previous file with comments | « discovery/googleapis/licensing__v1.json ('k') | discovery/googleapis/manufacturers__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698