| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logServices.html">logServices</a> . <a href="logging_v1beta3.projects.logServices.sinks.html">sinks</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(projectsId, logServicesId, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates the specified log service sink resource.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified log service sink.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the specified log service sink resource.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(projectsId, logServicesId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists log service sinks associated with the specified service.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates or update the specified log service sink resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(projectsId, logServicesId, body, x__xgafv=None)</code> |
| <pre>Creates the specified log service sink resource. |
| |
| Args: |
| projectsId: string, Part of `serviceName`. The name of the service in which to create a sink. (required) |
| logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # An object that describes where a log may be written. |
| "errors": [ # _Output only._ All active errors found for this sink. |
| { # A problem in a sink or the sink's configuration. |
| "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed. |
| "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field. |
| "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. |
| "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @ype with type URL. |
| }, |
| ], |
| }, |
| "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch. |
| "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset. |
| }, |
| ], |
| "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource. |
| "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink. |
| } |
| |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # An object that describes where a log may be written. |
| "errors": [ # _Output only._ All active errors found for this sink. |
| { # A problem in a sink or the sink's configuration. |
| "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed. |
| "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field. |
| "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. |
| "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @ype with type URL. |
| }, |
| ], |
| }, |
| "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch. |
| "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset. |
| }, |
| ], |
| "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource. |
| "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</code> |
| <pre>Deletes the specified log service sink. |
| |
| Args: |
| projectsId: string, Part of `sinkName`. The name of the sink to delete. (required) |
| logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required) |
| sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required) |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</code> |
| <pre>Gets the specified log service sink resource. |
| |
| Args: |
| projectsId: string, Part of `sinkName`. The name of the sink to return. (required) |
| logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required) |
| sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required) |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # An object that describes where a log may be written. |
| "errors": [ # _Output only._ All active errors found for this sink. |
| { # A problem in a sink or the sink's configuration. |
| "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed. |
| "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field. |
| "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. |
| "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @ype with type URL. |
| }, |
| ], |
| }, |
| "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch. |
| "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset. |
| }, |
| ], |
| "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource. |
| "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(projectsId, logServicesId, x__xgafv=None)</code> |
| <pre>Lists log service sinks associated with the specified service. |
| |
| Args: |
| projectsId: string, Part of `serviceName`. The name of the service for which to list sinks. (required) |
| logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required) |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # Result returned from `ListLogServiceSinks`. |
| "sinks": [ # The requested log service sinks. If any of the returned `LogSink` objects have an empty `destination` field, then call `logServices.sinks.get` to retrieve the complete `LogSink` object. |
| { # An object that describes where a log may be written. |
| "errors": [ # _Output only._ All active errors found for this sink. |
| { # A problem in a sink or the sink's configuration. |
| "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed. |
| "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field. |
| "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. |
| "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @ype with type URL. |
| }, |
| ], |
| }, |
| "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch. |
| "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset. |
| }, |
| ], |
| "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource. |
| "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</code> |
| <pre>Creates or update the specified log service sink resource. |
| |
| Args: |
| projectsId: string, Part of `sinkName`. The name of the sink to update. (required) |
| logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required) |
| sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # An object that describes where a log may be written. |
| "errors": [ # _Output only._ All active errors found for this sink. |
| { # A problem in a sink or the sink's configuration. |
| "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed. |
| "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field. |
| "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. |
| "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @ype with type URL. |
| }, |
| ], |
| }, |
| "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch. |
| "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset. |
| }, |
| ], |
| "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource. |
| "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink. |
| } |
| |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # An object that describes where a log may be written. |
| "errors": [ # _Output only._ All active errors found for this sink. |
| { # A problem in a sink or the sink's configuration. |
| "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed. |
| "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field. |
| "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. |
| "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @ype with type URL. |
| }, |
| ], |
| }, |
| "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch. |
| "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset. |
| }, |
| ], |
| "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource. |
| "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink. |
| }</pre> |
| </div> |
| |
| </body></html> |