google.logging.v2.logging_config_pb2¶

Classes

class google.logging.v2.logging_config_pb2.CreateSinkRequest[source]¶

The parameters to CreateSink.

parent¶

string – The resource in which to create the sink. Example: "projects/my-project-id".

The new sink must be provided in the request.

sink¶

google.logging.v2.logging_config_pb2.LogSink – The new sink, which must not have an identifier that already exists.

class google.logging.v2.logging_config_pb2.DeleteSinkRequest[source]¶

The parameters to DeleteSink.

sink_name¶

string – The resource name of the sink to delete. Example: "projects/my-project-id/sinks/my-sink-id".

class google.logging.v2.logging_config_pb2.GetSinkRequest[source]¶

The parameters to GetSink.

sink_name¶

string – The resource name of the sink to return. Example: "projects/my-project-id/sinks/my-sink-id".

class google.logging.v2.logging_config_pb2.ListSinksRequest[source]¶

The parameters to ListSinks.

parent¶

string – Required. The resource name containing the sinks. Example: "projects/my-logging-project".

page_token¶

string – Optional. If the pageToken parameter is supplied, then the next page of results is retrieved. The pageToken parameter must be set to the value of the nextPageToken from the previous response. The value of parent must be the same as in the previous request.

page_size¶

int – Optional. The maximum number of results to return from this request. You must check for presence of nextPageToken to determine if additional results are available, which you can retrieve by passing the nextPageToken value as the pageToken parameter in the next request.

class google.logging.v2.logging_config_pb2.ListSinksResponse[source]¶

Result returned from ListSinks.

sinks¶

list[google.logging.v2.logging_config_pb2.LogSink] – A list of sinks.

next_page_token¶

string – If there are more results than were returned, then nextPageToken is included in the response. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

class google.logging.v2.logging_config_pb2.LogSink[source]¶

Describes a sink used to export log entries outside Stackdriver Logging.

name¶

string – Required. The client-assigned sink identifier. Example: "my-severe-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 _-..

destination¶

string – The export destination. See Exporting Logs With Sinks. Examples: "storage.googleapis.com/a-bucket", "bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset".

filter¶

string – An advanced logs filter. Only log entries matching that 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 (V2 format): "logName=projects/my-projectid/logs/syslog AND severity>=ERROR".

output_version_format¶

google.logging.v2.logging_config_pb2.LogSink.VersionFormat – 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 when it was written to Stackdriver Logging.

class google.logging.v2.logging_config_pb2.UpdateSinkRequest[source]¶

The parameters to UpdateSink.

sink_name¶

string – The resource name of the sink to update. Example: "projects/my-project-id/sinks/my-sink-id".

The updated sink must be provided in the request and have the same name that is specified in sinkName. If the sink does not exist, it is created.

sink¶

google.logging.v2.logging_config_pb2.LogSink – The updated sink, whose name must be the same as the sink identifier in sinkName. If sinkName does not exist, then this method creates a new sink.