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

Unified Diff: discovery/googleapis_beta/logging__v2beta1.json

Issue 2571553005: Api-roll 43: 2016-12-13 (Closed)
Patch Set: Created 4 years 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_beta/language__v1beta1.json ('k') | discovery/googleapis_beta/ml__v1beta1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis_beta/logging__v2beta1.json
diff --git a/discovery/googleapis_beta/logging__v2beta1.json b/discovery/googleapis_beta/logging__v2beta1.json
index cb86cb17618b5aa56103215d2d04bde15d0246df..7aad103ff86118fe1c7ff7032f75a85ce9c9fa0b 100644
--- a/discovery/googleapis_beta/logging__v2beta1.json
+++ b/discovery/googleapis_beta/logging__v2beta1.json
@@ -139,7 +139,7 @@
],
"parameters": {
"metricName": {
- "description": "The resource name of the metric to update.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.\n\nThe updated metric must be provided in the request and have the\nsame identifier that is specified in `metricName`.\nIf the metric does not exist, it is created.",
+ "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,
@@ -168,7 +168,7 @@
],
"parameters": {
"metricName": {
- "description": "The resource name of the desired metric.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+/metrics/[^/]+$",
"required": true,
@@ -195,7 +195,7 @@
],
"parameters": {
"parent": {
- "description": "The resource name of the project in which to create the metric.\nExample: `\"projects/my-project-id\"`.\n\nThe new metric must be provided in the request.",
+ "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,
@@ -224,20 +224,20 @@
],
"parameters": {
"pageSize": {
- "description": "Optional. The maximum number of results to return from this request.\nNon-positive values are ignored. The presence of `nextPageToken` in the\nresponse indicates that more results might be available.",
+ "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 resource name containing the metrics.\nExample: `\"projects/my-project-id\"`.",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `pageToken` must be the value of\n`nextPageToken` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
+ "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"
}
@@ -262,7 +262,7 @@
],
"parameters": {
"metricName": {
- "description": "The resource name of the metric to delete.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.",
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
"location": "path",
"pattern": "^projects/[^/]+/metrics/[^/]+$",
"required": true,
@@ -283,8 +283,46 @@
},
"logs": {
"methods": {
+ "list": {
+ "description": "Lists the logs in projects or organizations. Only logs that have entries are listed.",
+ "httpMethod": "GET",
+ "id": "logging.projects.logs.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_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",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+parent}/logs",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
"delete": {
- "description": "Deletes a log and all its log entries.\nThe log will reappear if it receives new entries.",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries.",
"httpMethod": "DELETE",
"id": "logging.projects.logs.delete",
"parameterOrder": [
@@ -292,7 +330,7 @@
],
"parameters": {
"logName": {
- "description": "Required. The resource name of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^projects/[^/]+/logs/[^/]+$",
"required": true,
@@ -313,7 +351,7 @@
"sinks": {
"methods": {
"update": {
- "description": "Updates or creates a sink.",
+ "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": [
@@ -321,14 +359,14 @@
],
"parameters": {
"sinkName": {
- "description": "Required. The resource name of the sink to update, including the parent\nresource and the sink identifier. If the sink does not exist, this method\ncreates the sink. Example: `\"projects/my-project-id/sinks/my-sink-id\"`.",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
"type": "string"
},
"uniqueWriterIdentity": {
- "description": "Optional. Whether the sink will have a dedicated service account returned\nin the sink's writer_identity. Set this field to be true to export\nlogs from one project to a different project. This field is ignored for\nnon-project sinks (e.g. organization sinks) because those sinks are\nrequired to have dedicated service accounts.",
+ "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"
}
@@ -354,7 +392,7 @@
],
"parameters": {
"sinkName": {
- "description": "Required. The resource name of the sink to return.\nExample: `\"projects/my-project-id/sinks/my-sink-id\"`.",
+ "description": "Required. The parent resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"location": "path",
"pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
@@ -373,7 +411,7 @@
]
},
"create": {
- "description": "Creates a sink.",
+ "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": [
@@ -381,12 +419,12 @@
],
"parameters": {
"uniqueWriterIdentity": {
- "description": "Optional. Whether the sink will have a dedicated service account returned\nin the sink's writer_identity. Set this field to be true to export\nlogs from one project to a different project. This field is ignored for\nnon-project sinks (e.g. organization sinks) because those sinks are\nrequired to have dedicated service accounts.",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is cloud-logs@google.com, the same identity used before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
"location": "query",
"type": "boolean"
},
"parent": {
- "description": "Required. The resource in which to create the sink.\nExample: `\"projects/my-project-id\"`.\nThe new sink must be provided in the request.",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
@@ -414,20 +452,20 @@
],
"parameters": {
"pageSize": {
- "description": "Optional. The maximum number of results to return from this request.\nNon-positive values are ignored. The presence of `nextPageToken` in the\nresponse indicates that more results might be available.",
+ "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 resource name where this sink was created.\nExample: `\"projects/my-logging-project\"`.",
+ "description": "Required. The parent resource whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"organizations/123456789\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `pageToken` must be the value of\n`nextPageToken` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
+ "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"
}
@@ -444,7 +482,7 @@
]
},
"delete": {
- "description": "Deletes a sink.",
+ "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",
"parameterOrder": [
@@ -452,7 +490,7 @@
],
"parameters": {
"sinkName": {
- "description": "Required. The resource name of the sink to delete, including the parent\nresource and the sink identifier. Example:\n`\"projects/my-project-id/sinks/my-sink-id\"`. It is an error if the sink\ndoes not exist.",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\nIt is an error if the sink does not exist. Example: \"projects/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist.",
"location": "path",
"pattern": "^projects/[^/]+/sinks/[^/]+$",
"required": true,
@@ -476,8 +514,46 @@
"resources": {
"logs": {
"methods": {
+ "list": {
+ "description": "Lists the logs in projects or organizations. Only logs that have entries are listed.",
+ "httpMethod": "GET",
+ "id": "logging.organizations.logs.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "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": "v2beta1/{+parent}/logs",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
"delete": {
- "description": "Deletes a log and all its log entries.\nThe log will reappear if it receives new entries.",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries.",
"httpMethod": "DELETE",
"id": "logging.organizations.logs.delete",
"parameterOrder": [
@@ -485,7 +561,7 @@
],
"parameters": {
"logName": {
- "description": "Required. The resource name of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^organizations/[^/]+/logs/[^/]+$",
"required": true,
@@ -508,7 +584,7 @@
"entries": {
"methods": {
"write": {
- "description": "Writes log entries to Stackdriver Logging. All log entries are\nwritten by this method.",
+ "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.",
"httpMethod": "POST",
"id": "logging.entries.write",
"parameterOrder": [],
@@ -527,7 +603,7 @@
]
},
"list": {
- "description": "Lists log entries. Use this method to retrieve log entries from Cloud\nLogging. For ways to export log entries, see\n[Exporting Logs](/logging/docs/export).",
+ "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": [],
@@ -551,19 +627,19 @@
"monitoredResourceDescriptors": {
"methods": {
"list": {
- "description": "Lists the monitored resource descriptors used by Stackdriver Logging.",
+ "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.\nNon-positive values are ignored. The presence of `nextPageToken` in the\nresponse indicates that more results might be available.",
+ "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\npreceding call to this method. `pageToken` must be the value of\n`nextPageToken` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
+ "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"
}
@@ -585,8 +661,46 @@
"resources": {
"logs": {
"methods": {
+ "list": {
+ "description": "Lists the logs in projects or organizations. Only logs that have entries are listed.",
+ "httpMethod": "GET",
+ "id": "logging.billingAccounts.logs.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_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",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+parent}/logs",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
"delete": {
- "description": "Deletes a log and all its log entries.\nThe log will reappear if it receives new entries.",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries.",
"httpMethod": "DELETE",
"id": "logging.billingAccounts.logs.delete",
"parameterOrder": [
@@ -594,7 +708,7 @@
],
"parameters": {
"logName": {
- "description": "Required. The resource name of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"location": "path",
"pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
"required": true,
@@ -615,11 +729,11 @@
}
}
},
- "revision": "20161028",
+ "revision": "20161206",
"rootUrl": "https://logging.googleapis.com/",
"schemas": {
"ListLogEntriesResponse": {
- "description": "Result returned from `ListLogEntries`.",
+ "description": "Result returned from ListLogEntries.",
"id": "ListLogEntriesResponse",
"properties": {
"entries": {
@@ -630,18 +744,18 @@
"type": "array"
},
"nextPageToken": {
- "description": "If there might be more results than appear in this response, then\n`nextPageToken` is included. To get the next set of results, call this\nmethod again using the value of `nextPageToken` as `pageToken`.",
+ "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"
},
"ListSinksResponse": {
- "description": "Result returned from `ListSinks`.",
+ "description": "Result returned from ListSinks.",
"id": "ListSinksResponse",
"properties": {
"nextPageToken": {
- "description": "If there might be more results than appear in this response, then\n`nextPageToken` is included. To get the next set of results, call the same\nmethod again using the value of `nextPageToken` as `pageToken`.",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
"type": "string"
},
"sinks": {
@@ -659,11 +773,11 @@
"id": "SourceLocation",
"properties": {
"file": {
- "description": "Source file name. Depending on the runtime environment, this might be a\nsimple name or a fully-qualified name.",
+ "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\ncontext such as the class or package name. This information is used in\ncontexts such as the logs viewer, where a file and line number are less\nmeaningful. The format can vary by language. For example:\n`qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`\n(Python).",
+ "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
"type": "string"
},
"line": {
@@ -675,54 +789,72 @@
"type": "object"
},
"LogSink": {
- "description": "Describes a sink used to export log entries outside of Stackdriver Logging.\nA logs filter controls which log entries are exported. Sinks can have a\nstart time and an end time; these can be used to place log entries from an\nexact time range into a particular destination. If both `start_time` and\n`end_time` are present, then `start_time` must be less than `end_time`.",
+ "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project or organization.",
"id": "LogSink",
"properties": {
"destination": {
- "description": "Required. The export destination. See\n[Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).\nExamples:\n\n \"storage.googleapis.com/my-gcs-bucket\"\n \"bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset\"\n \"pubsub.googleapis.com/projects/my-project/topics/my-topic\"",
+ "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](/logging/docs/view/advanced_filters).\nOnly log entries matching the filter are exported. The filter\nmust be consistent with the log entry format specified by the\n`outputVersionFormat` parameter, regardless of the format of the\nlog entry that was originally written to Stackdriver Logging.\nExample filter (V2 format):\n\n logName=projects/my-projectid/logs/syslog AND severity>=ERROR",
+ "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": "Optional. Time at which this sink will stop exporting log entries. If this\nvalue is present, then log entries are exported only if `entry.timestamp` <\n`end_time`.",
+ "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"
},
"name": {
- "description": "Required. The client-assigned sink identifier, unique within the\nproject. Example: `\"my-syslog-errors-to-pubsub\"`. Sink identifiers are\nlimited to 1000 characters and can include only the following characters:\n`A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length\nof the name is 100 characters.",
+ "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
"type": "string"
},
"startTime": {
- "description": "Optional. The time at which this sink will begin exporting log entries. If\nthis value is present, then log entries are exported only if `start_time`\n<=`entry.timestamp`.",
+ "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"
},
"outputVersionFormat": {
- "description": "Optional. The log entry version to use for this sink's exported log\nentries. This version does not have to correspond to the version of the\nlog entry that was written to Stackdriver Logging. If omitted, the\nv2 format is used.",
+ "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 version format will default to V2.",
- "`LogEntry` version 2 format.",
- "`LogEntry` version 1 format."
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "LogEntry version 1 format."
],
"type": "string"
},
"writerIdentity": {
- "description": "Output only. An IAM identity&mdash;a service account or group&mdash;that\nwill write exported log entries to the destination on behalf of Stackdriver\nLogging. You must grant this identity write-access to the destination.\nConsult the destination service's documentation to determine the exact role\nthat must be granted.",
+ "description": "Output only. An IAM identity&mdash;a service account or group&mdash;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"
+ }
+ },
+ "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": {
+ "type": "string"
+ },
+ "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.",
"type": "string"
}
},
"type": "object"
},
"LogMetric": {
- "description": "Describes a logs-based metric. The value of the metric is the\nnumber of log entries that match a logs filter.",
+ "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": {
"description": {
@@ -730,15 +862,15 @@
"type": "string"
},
"filter": {
- "description": "Required. An [advanced logs filter](/logging/docs/view/advanced_filters).\nExample: `\"resource.type=gae_app AND severity>=ERROR\"`.",
+ "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"
},
"name": {
- "description": "Required. The client-assigned metric identifier. Example:\n`\"severe_errors\"`. Metric identifiers are limited to 100\ncharacters and can include only the following characters: `A-Z`,\n`a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The\nforward-slash character (`/`) denotes a hierarchy of name pieces,\nand it cannot be the first character of the name. The '%' character\nis used to URL encode unsafe and reserved characters and must be\nfollowed by two hexadecimal digits according to RFC 1738.",
+ "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".",
"type": "string"
},
"version": {
- "description": "Output only. The API version that created or updated this metric.\nThe version also dictates the syntax of the filter expression. When a value\nfor this field is missing, the default value of V2 should be assumed.",
+ "description": "Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.",
"enum": [
"V2",
"V1"
@@ -762,29 +894,37 @@
},
"httpRequest": {
"$ref": "HttpRequest",
- "description": "Optional. Information about the HTTP request associated with this\nlog entry, if applicable."
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
+ },
+ "sourceLocation": {
+ "$ref": "LogEntrySourceLocation",
+ "description": "Optional. Source code location information associated with the log entry, if any."
},
"jsonPayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.",
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
- "description": "Optional. A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
"type": "object"
},
+ "trace": {
+ "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
+ "type": "string"
+ },
"logName": {
- "description": "Required. The resource name of the log to which this log entry\nbelongs. The format of the name is\n`\"projects/<project-id>/logs/<log-id>\"`. Examples:\n`\"projects/my-projectid/logs/syslog\"`,\n`\"projects/my-projectid/logs/library.googleapis.com%2Fbook_log\"`.\n\nThe log ID part of resource name must be less than 512 characters\nlong and can only include the following characters: upper and\nlower case alphanumeric characters: [A-Za-z0-9]; and punctuation\ncharacters: forward-slash, underscore, hyphen, and period.\nForward-slash (`/`) characters in the log ID must be URL-encoded.",
+ "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
"type": "string"
},
"severity": {
- "description": "Optional. The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.",
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
"enum": [
"DEFAULT",
"DEBUG",
@@ -800,7 +940,7 @@
"(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\na configuration change.",
+ "(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.",
@@ -811,28 +951,28 @@
},
"resource": {
"$ref": "MonitoredResource",
- "description": "Required. The monitored resource associated with this log entry.\nExample: a log entry that reports a database error would be\nassociated with the monitored resource designating the particular\ndatabase that reported the error."
+ "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."
},
"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\nGoogle Cloud Platform services use this field for their log\nentry payloads.",
+ "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"
},
"timestamp": {
- "description": "Optional. The time the event described by the log entry occurred. If\nomitted, Stackdriver Logging will use the time the log entry is received.",
+ "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"
},
"insertId": {
- "description": "Optional. A unique ID for the log entry. If you provide this\nfield, the logging service considers other log entries in the\nsame project with the same ID as duplicates which can be removed. If\nomitted, Stackdriver Logging will generate a unique ID for this\nlog entry.",
+ "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\napplicable."
+ "description": "Optional. Information about an operation associated with the log entry, if applicable."
}
},
"type": "object"
@@ -863,7 +1003,7 @@
"(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\na configuration change.",
+ "(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.",
@@ -884,33 +1024,33 @@
"type": "object"
},
"SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
"id": "SourceReference",
"properties": {
"repository": {
- "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
"type": "string"
},
"revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"type": "string"
}
},
"type": "object"
},
"MonitoredResource": {
- "description": "An object representing a resource that can be used for monitoring, logging,\nbilling, or other purposes. Examples include virtual machine instances,\ndatabases, and storage devices such as disks. The `type` field identifies a\nMonitoredResourceDescriptor object that describes the resource's\nschema. Information in the `labels` field identifies the actual resource and\nits attributes according to the schema. For example, a particular Compute\nEngine VM instance could be represented by the following object, because the\nMonitoredResourceDescriptor for `\"gce_instance\"` has labels\n`\"instance_id\"` and `\"zone\"`:\n\n { \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}",
+ "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": {
"labels": {
"additionalProperties": {
"type": "string"
},
- "description": "Required. Values for all of the labels listed in the associated monitored\nresource descriptor. For example, Cloud SQL databases use the labels\n`\"database_id\"` and `\"zone\"`.",
+ "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"
},
"type": {
- "description": "Required. The monitored resource type. This field must match\nthe `type` field of a MonitoredResourceDescriptor object. For\nexample, the type of a Cloud SQL database is `\"cloudsql_database\"`.",
+ "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"
}
},
@@ -924,27 +1064,27 @@
"additionalProperties": {
"type": "string"
},
- "description": "Optional. Default labels that are added to the `labels` field of all log\nentries in `entries`. If a log entry already has a label with the same key\nas a label in this parameter, then the log entry's label is not changed.\nSee LogEntry.",
+ "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"
},
"entries": {
- "description": "Required. The log entries to write. Values supplied for the fields\n`log_name`, `resource`, and `labels` in this `entries.write` request are\nadded to those log entries that do not provide their own values for the\nfields.\n\nTo improve throughput and to avoid exceeding the\n[quota limit](/logging/quota-policy) for calls to `entries.write`,\nyou should write multiple log entries at once rather than\ncalling this method for each individual log entry.",
+ "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"
},
"logName": {
- "description": "Optional. A default log resource name that is assigned to all log entries\nin `entries` that do not specify a value for `log_name`. Example:\n`\"projects/my-project/logs/syslog\"`. See\nLogEntry.",
+ "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"type": "string"
},
"partialSuccess": {
- "description": "Optional. Whether valid entries should be written even if some other\nentries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any\nentry is not written, the response status will be the error associated\nwith one of the failed entries and include error details in the form of\nWriteLogEntriesPartialErrors.",
+ "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.",
"type": "boolean"
},
"resource": {
"$ref": "MonitoredResource",
- "description": "Optional. A default monitored resource object that is assigned to all log\nentries in `entries` that do not specify a value for `resource`. Example:\n\n { \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\n\nSee LogEntry."
+ "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."
}
},
"type": "object"
@@ -990,37 +1130,37 @@
"type": "array"
},
"nextPageToken": {
- "description": "If there might be more results than appear in this response, then\n`nextPageToken` is included. To get the next set of results, call this\nmethod again using the value of `nextPageToken` as `pageToken`.",
+ "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"
},
"MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
+ "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": {
"displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
+ "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
"type": "string"
},
"description": {
- "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
"type": "string"
},
"labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "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": {
- "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
+ "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
"type": "string"
},
"name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
+ "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"
}
},
@@ -1031,7 +1171,7 @@
"id": "ListMonitoredResourceDescriptorsResponse",
"properties": {
"nextPageToken": {
- "description": "If there might be more results than appear in this response, then\n`nextPageToken` is included. To get the next set of results, call this\nmethod again using the value of `nextPageToken` as `pageToken`.",
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
"type": "string"
},
"resourceDescriptors": {
@@ -1045,11 +1185,11 @@
"type": "object"
},
"LogEntryOperation": {
- "description": "Additional information about a potentially long-running operation with which\na log entry is associated.",
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
"id": "LogEntryOperation",
"properties": {
"producer": {
- "description": "Optional. An arbitrary producer identifier. The combination of\n`id` and `producer` must be globally unique. Examples for `producer`:\n`\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.",
+ "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
"type": "string"
},
"last": {
@@ -1061,20 +1201,20 @@
"type": "boolean"
},
"id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the\nsame identifier are assumed to be part of the same operation.",
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "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"
},
"HttpRequest": {
- "description": "A common proto for logging HTTP requests. Only contains semantics\ndefined by the HTTP specification. Product-specific logging\ninformation MUST be defined in a separate message.",
+ "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": {
"cacheLookup": {
@@ -1082,59 +1222,79 @@
"type": "boolean"
},
"responseSize": {
- "description": "The size of the HTTP response message sent back to the client, in bytes,\nincluding the response headers and the response body.",
+ "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"
},
"status": {
- "description": "The response code indicating the status of response.\nExamples: 200, 404.",
+ "description": "The response code indicating the status of response. Examples: 200, 404.",
"format": "int32",
"type": "integer"
},
"cacheValidatedWithOriginServer": {
- "description": "Whether or not the response was validated with the origin server before\nbeing served from cache. This field is only meaningful if `cache_hit` is\nTrue.",
+ "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
"type": "boolean"
},
"referer": {
- "description": "The referer URL of the request, as defined in\n[HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
+ "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
"type": "string"
},
"cacheHit": {
- "description": "Whether or not an entity was served from cache\n(with or without validation).",
+ "description": "Whether or not an entity was served from cache (with or without validation).",
"type": "boolean"
},
"requestUrl": {
- "description": "The scheme (http, https), the host name, the path and the query\nportion of the URL that was requested.\nExample: `\"http://example.com/some/info?color=red\"`.",
+ "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
"type": "string"
},
"latency": {
- "description": "The request processing latency on the server, from the time the request was\nreceived until the response was sent.",
+ "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"
},
"cacheFillBytes": {
- "description": "The number of HTTP response bytes inserted into cache. Set only when a\ncache fill was attempted.",
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
"format": "int64",
"type": "string"
},
"requestMethod": {
- "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.",
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
"type": "string"
},
"remoteIp": {
- "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP\nrequest. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.",
+ "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
"type": "string"
},
"serverIp": {
- "description": "The IP address (IPv4 or IPv6) of the origin server that the request was\nsent to.",
+ "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
"type": "string"
},
"userAgent": {
- "description": "The user agent sent by the client. Example:\n`\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"`.",
+ "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
"type": "string"
},
"requestSize": {
- "description": "The size of the HTTP request message in bytes, including the request\nheaders and the request body.",
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "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).",
+ "type": "string"
+ },
+ "file": {
+ "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "type": "string"
+ },
+ "line": {
+ "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
"format": "int64",
"type": "string"
}
@@ -1142,7 +1302,7 @@
"type": "object"
},
"RequestLog": {
- "description": "Complete log information about a single HTTP request to an App Engine\napplication.",
+ "description": "Complete log information about a single HTTP request to an App Engine application.",
"id": "RequestLog",
"properties": {
"responseSize": {
@@ -1151,15 +1311,15 @@
"type": "string"
},
"requestId": {
- "description": "Globally unique identifier for a request, which is based on the request\nstart time. Request IDs for requests which started later will compare\ngreater as strings than those for requests which started earlier.",
+ "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
"type": "string"
},
"first": {
- "description": "Whether this is the first RequestLog entry for this request. If an active\nrequest has several RequestLog entries written to Cloud Logging, this field\nwill be set for one of them.",
+ "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
"type": "boolean"
},
"method": {
- "description": "Request method. Example: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`, `\"DELETE\"`.",
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
"type": "string"
},
"versionId": {
@@ -1180,7 +1340,7 @@
"type": "string"
},
"nickname": {
- "description": "The logged-in user who made the request.\n\nMost likely, this is the part of the user's email before the `@` sign. The\nfield value is the same for different requests from the same user, but\ndifferent users can have similar names. This information is also\navailable to the application via the App Engine Users API.\n\nThis field will be populated starting with App Engine 1.9.21.",
+ "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
"type": "string"
},
"taskQueueName": {
@@ -1193,12 +1353,12 @@
"type": "string"
},
"instanceIndex": {
- "description": "If the instance processing this request belongs to a manually scaled\nmodule, then this is the 0-based index of the instance. Otherwise, this\nvalue is -1.",
+ "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"
},
"sourceReference": {
- "description": "Source code for the application that handled this request. There can be\nmore than one source reference per deployed application if source code is\ndistributed among multiple repositories.",
+ "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"
},
@@ -1243,7 +1403,7 @@
"type": "string"
},
"traceId": {
- "description": "Cloud Trace identifier for this request.",
+ "description": "Stackdriver Trace identifier for this request.",
"type": "string"
},
"taskName": {
@@ -1269,11 +1429,11 @@
"type": "string"
},
"resource": {
- "description": "Contains the path and query portion of the URL that was requested. For\nexample, if the URL was \"http://example.com/app?name=val\", the resource\nwould be \"/app?name=val\". The fragment identifier, which is identified by\nthe `#` character, is not included.",
+ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
"type": "string"
},
"httpVersion": {
- "description": "HTTP version of request. Example: `\"HTTP/1.1\"`.",
+ "description": "HTTP version of request. Example: \"HTTP/1.1\".",
"type": "string"
},
"referrer": {
@@ -1292,44 +1452,44 @@
"type": "object"
},
"WriteLogEntriesResponse": {
- "description": "Result returned from WriteLogEntries.\nempty",
+ "description": "Result returned from WriteLogEntries. empty",
"id": "WriteLogEntriesResponse",
"properties": {},
"type": "object"
},
"ListLogEntriesRequest": {
- "description": "The parameters to `ListLogEntries`.",
+ "description": "The parameters to ListLogEntries.",
"id": "ListLogEntriesRequest",
"properties": {
"filter": {
- "description": "Optional. A filter that chooses which log entries to return. See [Advanced\nLogs Filters](/logging/docs/view/advanced_filters). Only log entries that\nmatch the filter are returned. An empty filter matches all log entries.",
+ "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
"type": "string"
},
"projectIds": {
- "description": "Deprecated. One or more project identifiers or project numbers from which\nto retrieve log entries. Examples: `\"my-project-1A\"`, `\"1234567890\"`. If\npresent, these project identifiers are converted to resource format and\nadded to the list of resources in `resourceNames`. Callers should use\n`resourceNames` rather than this parameter.",
+ "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"
},
"resourceNames": {
- "description": "Required. One or more cloud resources from which to retrieve log entries.\nExample: `\"projects/my-project-1A\"`, `\"projects/1234567890\"`. Projects\nlisted in `projectIds` are added to this list.",
+ "description": "Required. Names of one or more resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\nProjects listed in the project_ids field are added to this list.",
"items": {
"type": "string"
},
"type": "array"
},
"pageSize": {
- "description": "Optional. The maximum number of results to return from this request.\nNon-positive values are ignored. The presence of `nextPageToken` in the\nresponse indicates that more results might be available.",
+ "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\nvalues are `\"timestamp asc\"` (default) and `\"timestamp desc\"`. The first\noption returns entries in order of increasing values of\n`LogEntry.timestamp` (oldest first), and the second option returns entries\nin order of decreasing timestamps (newest first). Entries with equal\ntimestamps are returned in order of `LogEntry.insertId`.",
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of LogEntry.insertId.",
"type": "string"
},
"pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `pageToken` must be the value of\n`nextPageToken` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
+ "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"
}
},
« no previous file with comments | « discovery/googleapis_beta/language__v1beta1.json ('k') | discovery/googleapis_beta/ml__v1beta1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698