create(parent=None, body, x__xgafv=None)
Creates a sink.
delete(sinkName=None, x__xgafv=None)
Deletes a sink.
get(sinkName=None, x__xgafv=None)
Gets a sink.
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)
Lists sinks.
list_next(previous_request, previous_response)
Retrieves the next page of results.
update(sinkName=None, body, x__xgafv=None)
Updates or creates a sink.
create(parent=None, body, x__xgafv=None)
Creates a sink. Args: parent: string, Required. The resource in which to create the sink. Example: `"projects/my-project-id"`. The new sink must be provided in the request. (required) body: object, The request body. (required) The object takes the form of: { # Describes a sink used to export log entries outside of Stackdriver Logging. "endTime": "A String", # Optional. Time at which this sink expires. "name": "A String", # Required. The client-assigned sink identifier, unique within the # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are # limited to 1000 characters and can include only the following characters: # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length # of the name is 100 characters. "destination": "A String", # Required. The export destination. See # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). # Examples: # # "storage.googleapis.com/my-gcs-bucket" # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" # "pubsub.googleapis.com/projects/my-project/topics/my-topic" "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). # Only log entries matching the filter are exported. The filter # must be consistent with the log entry format specified by the # `outputVersionFormat` parameter, regardless of the format of the # log entry that was originally written to Stackdriver Logging. # Example filter (V2 format): # # logName=projects/my-projectid/logs/syslog AND severity>=ERROR "startTime": "A String", # Optional. Time range for which this sink is active. # Logs are exported only if start_time <= entry.timestamp < end_time # Both start_time and end_time may be omitted to specify # (half) infinite ranges. The start_time must be less than the end_time. "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log # entries. This version does not have to correspond to the version of the # log entry that was written to Stackdriver Logging. If omitted, the # v2 format is used. "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write # access. This may be a service account or a group. # Examples (Do not assume these specific values): # "serviceAccount:cloud-logs@system.gserviceaccount.com" # "group:cloud-logs@google.com" # # For GCS destinations, the role "roles/owner" is required on the bucket # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is # required on the topic # For BigQuery, the role "roles/editor" is required on the dataset } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Describes a sink used to export log entries outside of Stackdriver Logging. "endTime": "A String", # Optional. Time at which this sink expires. "name": "A String", # Required. The client-assigned sink identifier, unique within the # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are # limited to 1000 characters and can include only the following characters: # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length # of the name is 100 characters. "destination": "A String", # Required. The export destination. See # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). # Examples: # # "storage.googleapis.com/my-gcs-bucket" # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" # "pubsub.googleapis.com/projects/my-project/topics/my-topic" "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). # Only log entries matching the filter are exported. The filter # must be consistent with the log entry format specified by the # `outputVersionFormat` parameter, regardless of the format of the # log entry that was originally written to Stackdriver Logging. # Example filter (V2 format): # # logName=projects/my-projectid/logs/syslog AND severity>=ERROR "startTime": "A String", # Optional. Time range for which this sink is active. # Logs are exported only if start_time <= entry.timestamp < end_time # Both start_time and end_time may be omitted to specify # (half) infinite ranges. The start_time must be less than the end_time. "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log # entries. This version does not have to correspond to the version of the # log entry that was written to Stackdriver Logging. If omitted, the # v2 format is used. "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write # access. This may be a service account or a group. # Examples (Do not assume these specific values): # "serviceAccount:cloud-logs@system.gserviceaccount.com" # "group:cloud-logs@google.com" # # For GCS destinations, the role "roles/owner" is required on the bucket # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is # required on the topic # For BigQuery, the role "roles/editor" is required on the dataset }
delete(sinkName=None, x__xgafv=None)
Deletes a sink. Args: sinkName: string, Required. The resource name of the sink to delete, including the parent resource and the sink identifier. Example: `"projects/my-project-id/sinks/my-sink-id"`. It is an error if the sink does not exist. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 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); # } # # The JSON representation for `Empty` is empty JSON object `{}`. }
get(sinkName=None, x__xgafv=None)
Gets a sink. Args: sinkName: string, Required. The resource name of the sink to return. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Describes a sink used to export log entries outside of Stackdriver Logging. "endTime": "A String", # Optional. Time at which this sink expires. "name": "A String", # Required. The client-assigned sink identifier, unique within the # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are # limited to 1000 characters and can include only the following characters: # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length # of the name is 100 characters. "destination": "A String", # Required. The export destination. See # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). # Examples: # # "storage.googleapis.com/my-gcs-bucket" # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" # "pubsub.googleapis.com/projects/my-project/topics/my-topic" "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). # Only log entries matching the filter are exported. The filter # must be consistent with the log entry format specified by the # `outputVersionFormat` parameter, regardless of the format of the # log entry that was originally written to Stackdriver Logging. # Example filter (V2 format): # # logName=projects/my-projectid/logs/syslog AND severity>=ERROR "startTime": "A String", # Optional. Time range for which this sink is active. # Logs are exported only if start_time <= entry.timestamp < end_time # Both start_time and end_time may be omitted to specify # (half) infinite ranges. The start_time must be less than the end_time. "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log # entries. This version does not have to correspond to the version of the # log entry that was written to Stackdriver Logging. If omitted, the # v2 format is used. "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write # access. This may be a service account or a group. # Examples (Do not assume these specific values): # "serviceAccount:cloud-logs@system.gserviceaccount.com" # "group:cloud-logs@google.com" # # For GCS destinations, the role "roles/owner" is required on the bucket # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is # required on the topic # For BigQuery, the role "roles/editor" is required on the dataset }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)
Lists sinks. Args: parent: string, Required. The cloud resource containing the sinks. Example: `"projects/my-logging-project"`. (required) pageToken: string, 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. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format pageSize: integer, 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. Returns: An object of the form: { # Result returned from `ListSinks`. "nextPageToken": "A String", # 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`. "sinks": [ # A list of sinks. { # Describes a sink used to export log entries outside of Stackdriver Logging. "endTime": "A String", # Optional. Time at which this sink expires. "name": "A String", # Required. The client-assigned sink identifier, unique within the # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are # limited to 1000 characters and can include only the following characters: # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length # of the name is 100 characters. "destination": "A String", # Required. The export destination. See # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). # Examples: # # "storage.googleapis.com/my-gcs-bucket" # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" # "pubsub.googleapis.com/projects/my-project/topics/my-topic" "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). # Only log entries matching the filter are exported. The filter # must be consistent with the log entry format specified by the # `outputVersionFormat` parameter, regardless of the format of the # log entry that was originally written to Stackdriver Logging. # Example filter (V2 format): # # logName=projects/my-projectid/logs/syslog AND severity>=ERROR "startTime": "A String", # Optional. Time range for which this sink is active. # Logs are exported only if start_time <= entry.timestamp < end_time # Both start_time and end_time may be omitted to specify # (half) infinite ranges. The start_time must be less than the end_time. "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log # entries. This version does not have to correspond to the version of the # log entry that was written to Stackdriver Logging. If omitted, the # v2 format is used. "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write # access. This may be a service account or a group. # Examples (Do not assume these specific values): # "serviceAccount:cloud-logs@system.gserviceaccount.com" # "group:cloud-logs@google.com" # # For GCS destinations, the role "roles/owner" is required on the bucket # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is # required on the topic # For BigQuery, the role "roles/editor" is required on the dataset }, ], }
list_next(previous_request, previous_response)
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
update(sinkName=None, body, x__xgafv=None)
Updates or creates a sink. Args: sinkName: string, Required. The resource name of the sink to update, including the parent resource and the sink identifier. If the sink does not exist, this method creates the sink. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required) body: object, The request body. (required) The object takes the form of: { # Describes a sink used to export log entries outside of Stackdriver Logging. "endTime": "A String", # Optional. Time at which this sink expires. "name": "A String", # Required. The client-assigned sink identifier, unique within the # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are # limited to 1000 characters and can include only the following characters: # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length # of the name is 100 characters. "destination": "A String", # Required. The export destination. See # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). # Examples: # # "storage.googleapis.com/my-gcs-bucket" # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" # "pubsub.googleapis.com/projects/my-project/topics/my-topic" "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). # Only log entries matching the filter are exported. The filter # must be consistent with the log entry format specified by the # `outputVersionFormat` parameter, regardless of the format of the # log entry that was originally written to Stackdriver Logging. # Example filter (V2 format): # # logName=projects/my-projectid/logs/syslog AND severity>=ERROR "startTime": "A String", # Optional. Time range for which this sink is active. # Logs are exported only if start_time <= entry.timestamp < end_time # Both start_time and end_time may be omitted to specify # (half) infinite ranges. The start_time must be less than the end_time. "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log # entries. This version does not have to correspond to the version of the # log entry that was written to Stackdriver Logging. If omitted, the # v2 format is used. "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write # access. This may be a service account or a group. # Examples (Do not assume these specific values): # "serviceAccount:cloud-logs@system.gserviceaccount.com" # "group:cloud-logs@google.com" # # For GCS destinations, the role "roles/owner" is required on the bucket # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is # required on the topic # For BigQuery, the role "roles/editor" is required on the dataset } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Describes a sink used to export log entries outside of Stackdriver Logging. "endTime": "A String", # Optional. Time at which this sink expires. "name": "A String", # Required. The client-assigned sink identifier, unique within the # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are # limited to 1000 characters and can include only the following characters: # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length # of the name is 100 characters. "destination": "A String", # Required. The export destination. See # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). # Examples: # # "storage.googleapis.com/my-gcs-bucket" # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" # "pubsub.googleapis.com/projects/my-project/topics/my-topic" "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). # Only log entries matching the filter are exported. The filter # must be consistent with the log entry format specified by the # `outputVersionFormat` parameter, regardless of the format of the # log entry that was originally written to Stackdriver Logging. # Example filter (V2 format): # # logName=projects/my-projectid/logs/syslog AND severity>=ERROR "startTime": "A String", # Optional. Time range for which this sink is active. # Logs are exported only if start_time <= entry.timestamp < end_time # Both start_time and end_time may be omitted to specify # (half) infinite ranges. The start_time must be less than the end_time. "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log # entries. This version does not have to correspond to the version of the # log entry that was written to Stackdriver Logging. If omitted, the # v2 format is used. "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write # access. This may be a service account or a group. # Examples (Do not assume these specific values): # "serviceAccount:cloud-logs@system.gserviceaccount.com" # "group:cloud-logs@google.com" # # For GCS destinations, the role "roles/owner" is required on the bucket # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is # required on the topic # For BigQuery, the role "roles/editor" is required on the dataset }