LogSink
class LogSink extends Message
Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
Protobuf type Google\Logging\V2\LogSink
Methods
No 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.
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.
Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The 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.
Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The 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.
Optional.
Optional.
Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default.
Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default.
Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of unique_writer_identity in those methods.
Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of unique_writer_identity in those methods.
Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instance would export all Compute Engine VM instance
log entries from all projects in the sink's parent. To only export entries
from certain child projects, filter on the project part of the log name:
logName:("projects/test-project1/" OR "projects/test-project2/") AND
resource.type=gce_instance
Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instance would export all Compute Engine VM instance
log entries from all projects in the sink's parent. To only export entries
from certain child projects, filter on the project part of the log name:
logName:("projects/test-project1/" OR "projects/test-project2/") AND
resource.type=gce_instance
Optional. The time at which this sink will begin exporting log entries.
Optional. The time at which this sink will begin exporting log entries.
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.
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.
Details
at line 121
__construct()
at line 136
string
getName()
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.
Generated from protobuf field string name = 1;
at line 151
setName(string $var)
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.
Generated from protobuf field string name = 1;
at line 170
string
getDestination()
Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The 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.
Generated from protobuf field string destination = 3;
at line 188
setDestination(string $var)
Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The 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.
Generated from protobuf field string destination = 3;
at line 205
string
getFilter()
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:
logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
Generated from protobuf field string filter = 5;
at line 221
setFilter(string $var)
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:
logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
Generated from protobuf field string filter = 5;
at line 237
int
getOutputVersionFormat()
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.
Generated from protobuf field .google.logging.v2.LogSink.VersionFormat output_version_format = 6;
at line 252
setOutputVersionFormat(int $var)
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.
Generated from protobuf field .google.logging.v2.LogSink.VersionFormat output_version_format = 6;
at line 276
string
getWriterIdentity()
Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of unique_writer_identity in those methods.
Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
Generated from protobuf field string writer_identity = 8;
at line 299
setWriterIdentity(string $var)
Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of unique_writer_identity in those methods.
Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
Generated from protobuf field string writer_identity = 8;
at line 322
bool
getIncludeChildren()
Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instance would export all Compute Engine VM instance
log entries from all projects in the sink's parent. To only export entries
from certain child projects, filter on the project part of the log name:
logName:("projects/test-project1/" OR "projects/test-project2/") AND
resource.type=gce_instance
Generated from protobuf field bool include_children = 9;
at line 344
setIncludeChildren(bool $var)
Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instance would export all Compute Engine VM instance
log entries from all projects in the sink's parent. To only export entries
from certain child projects, filter on the project part of the log name:
logName:("projects/test-project1/" OR "projects/test-project2/") AND
resource.type=gce_instance
Generated from protobuf field bool include_children = 9;
at line 359
Timestamp
getStartTime()
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.
Generated from protobuf field .google.protobuf.Timestamp start_time = 10;
at line 373
setStartTime(Timestamp $var)
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.
Generated from protobuf field .google.protobuf.Timestamp start_time = 10;
at line 389
Timestamp
getEndTime()
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.
Generated from protobuf field .google.protobuf.Timestamp end_time = 11;
at line 404
setEndTime(Timestamp $var)
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.
Generated from protobuf field .google.protobuf.Timestamp end_time = 11;