API documentation for logging_v2.types module.
Classes
Any
API documentation for logging_v2.types.Any class.
BigQueryOptions
Options that change functionality of a sink exporting data to BigQuery.
.. attribute:: use_partitioned_tables
Optional. Whether to use BigQuery's partition tables
</bigquery/docs/partitioned-tables>. By default, Logging
creates dated tables based on the log entries' timestamps,
e.g. syslog_20170523. With partitioned tables the date suffix
is no longer present and special query syntax
</bigquery/docs/querying-partitioned-tables> has to be used
instead. In both cases, tables are sharded based on UTC
timezone.
CmekSettings
Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.
Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.
See Enabling CMEK for Logs
Router </logging/docs/routing/managed-encryption>__ for more
information.
.. attribute:: name
Output Only. The resource name of the CMEK settings.
Output Only. The service account that will be used by the Logs
Router to access your Cloud KMS key. Before enabling CMEK for
Logs Router, you must first assign the role
roles/cloudkms.cryptoKeyEncrypterDecrypter to the service
account that the Logs Router will use to access your Cloud KMS
key. Use [GetCmekSettings][google.logging.v2.ConfigServiceV2.G
etCmekSettings] to obtain the service account ID. See
Enabling CMEK for Logs Router </logging/docs/routing/managed-
encryption>__ for more information.
CreateExclusionRequest
The parameters to CreateExclusion.
.. attribute:: parent
Required. The parent resource in which to create the
exclusion: :: "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]" Examples: "projects/my-logging-
project", "organizations/123456789".
CreateLogMetricRequest
The parameters to CreateLogMetric.
.. attribute:: parent
Required. The resource name of the project in which to create the metric: :: "projects/[PROJECT_ID]" The new metric must be provided in the request.
CreateSinkRequest
The parameters to CreateSink.
.. attribute:: parent
Required. The resource in which to create the sink: ::
"projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]" Examples: "projects/my-logging-
project", "organizations/123456789".
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 the same group or
service account used by Logging 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][google.logging.v2.LogSink].
CustomHttpPattern
API documentation for logging_v2.types.CustomHttpPattern class.
DeleteExclusionRequest
The parameters to DeleteExclusion.
.. attribute:: name
Required. The resource name of an existing exclusion to
delete: ::
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID
]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example: "projects/my-project-id/exclusions/my-exclusion-
id".
DeleteLogMetricRequest
The parameters to DeleteLogMetric.
.. attribute:: metric_name
Required. The resource name of the metric to delete: :: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
DeleteLogRequest
The parameters to DeleteLog.
.. attribute:: log_name
Required. The resource name of the log to delete: ::
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-
encoded. For example, "projects/my-project-
id/logs/syslog", "organizations/1234567890/logs/cloudresou
rcemanager.googleapis.com%2Factivity". For more information
about log names, see LogEntry][google.logging.v2.LogEntry].
DeleteSinkRequest
The parameters to DeleteSink.
.. attribute:: sink_name
Required. The full resource name of the sink to delete,
including the parent resource and the sink identifier: ::
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]" Example:
"projects/my-project-id/sinks/my-sink-id".
DescriptorProto
API documentation for logging_v2.types.DescriptorProto class.
Distribution
API documentation for logging_v2.types.Distribution class.
Duration
API documentation for logging_v2.types.Duration class.
Empty
API documentation for logging_v2.types.Empty class.
EnumDescriptorProto
API documentation for logging_v2.types.EnumDescriptorProto class.
EnumOptions
API documentation for logging_v2.types.EnumOptions class.
EnumValueDescriptorProto
API documentation for logging_v2.types.EnumValueDescriptorProto class.
EnumValueOptions
API documentation for logging_v2.types.EnumValueOptions class.
ExtensionRangeOptions
API documentation for logging_v2.types.ExtensionRangeOptions class.
FieldDescriptorProto
API documentation for logging_v2.types.FieldDescriptorProto class.
FieldMask
API documentation for logging_v2.types.FieldMask class.
FieldOptions
API documentation for logging_v2.types.FieldOptions class.
FileDescriptorProto
API documentation for logging_v2.types.FileDescriptorProto class.
FileDescriptorSet
API documentation for logging_v2.types.FileDescriptorSet class.
FileOptions
API documentation for logging_v2.types.FileOptions class.
GeneratedCodeInfo
API documentation for logging_v2.types.GeneratedCodeInfo class.
GetCmekSettingsRequest
The parameters to
GetCmekSettings][google.logging.v2.ConfigServiceV2.GetCmekSettings].
See Enabling CMEK for Logs
Router </logging/docs/routing/managed-encryption>__ for more
information.
.. attribute:: name
Required. The resource for which to retrieve CMEK settings.
:: "projects/[PROJECT_ID]/cmekSettings"
"organizations/[ORGANIZATION_ID]/cmekSettings"
"billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
"folders/[FOLDER_ID]/cmekSettings" Example:
"organizations/12345/cmekSettings". Note: CMEK for the
Logs Router can currently only be configured for GCP
organizations. Once configured, it applies to all projects and
folders in the GCP organization.
GetExclusionRequest
The parameters to GetExclusion.
.. attribute:: name
Required. The resource name of an existing exclusion: ::
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID
]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example: "projects/my-project-id/exclusions/my-exclusion-
id".
GetLogMetricRequest
The parameters to GetLogMetric.
.. attribute:: metric_name
Required. The resource name of the desired metric: :: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
GetSinkRequest
The parameters to GetSink.
.. attribute:: sink_name
Required. The resource name of the sink: ::
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]" Example:
"projects/my-project-id/sinks/my-sink-id".
Http
API documentation for logging_v2.types.Http class.
HttpRequest
API documentation for logging_v2.types.HttpRequest class.
HttpRule
API documentation for logging_v2.types.HttpRule class.
LabelDescriptor
API documentation for logging_v2.types.LabelDescriptor class.
ListExclusionsRequest
The parameters to ListExclusions.
.. attribute:: parent
Required. The parent resource whose exclusions are to be listed. :: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
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.
ListExclusionsResponse
Result returned from ListExclusions.
.. attribute:: exclusions
A list of exclusions.
ListLogEntriesRequest
The parameters to ListLogEntries.
.. attribute:: project_ids
Deprecated. Use resource_names instead. One or more
project identifiers or project numbers from which to retrieve
log entries. Example: "my-project-1A".
Optional. A filter that chooses which log entries to return.
See Advanced Logs Queries </logging/docs/view/advanced-
queries>__. 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.
Optional. The maximum number of results to return from this
request. Non-positive values are ignored. The presence of
next_page_token in the response indicates that more
results might be available.
ListLogEntriesResponse
Result returned from ListLogEntries.
.. attribute:: entries
A list of log entries. If entries is empty,
nextPageToken may still be returned, indicating that more
entries may exist. See nextPageToken for more information.
ListLogMetricsRequest
The parameters to ListLogMetrics.
.. attribute:: parent
Required. The name of the project containing the metrics: :: "projects/[PROJECT_ID]"
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.
ListLogMetricsResponse
Result returned from ListLogMetrics.
.. attribute:: metrics
A list of logs-based metrics.
ListLogsRequest
The parameters to ListLogs.
.. attribute:: parent
Required. The resource name that owns the logs: :: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
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.
ListLogsResponse
Result returned from ListLogs.
.. attribute:: log_names
A list of log names. For example, "projects/my-
project/logs/syslog" or "organizations/123/logs/cloudresou
rcemanager.googleapis.com%2Factivity".
ListMonitoredResourceDescriptorsRequest
The parameters to ListMonitoredResourceDescriptors
.. attribute:: page_size
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.
ListMonitoredResourceDescriptorsResponse
Result returned from ListMonitoredResourceDescriptors.
.. attribute:: resource_descriptors
A list of resource descriptors.
ListSinksRequest
The parameters to ListSinks.
.. attribute:: parent
Required. The parent resource whose sinks are to be listed: :: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
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.
ListSinksResponse
Result returned from ListSinks.
.. attribute:: sinks
A list of sinks.
ListValue
API documentation for logging_v2.types.ListValue class.
LogEntry
An individual entry in a log.
.. attribute:: log_name
Required. The resource name of the log to which this log entry
belongs: :: "projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may
optionally be used in place of PROJECT_ID. The project number
is translated to its corresponding PROJECT_ID internally and
the log_name field will contain PROJECT_ID in queries and
exports. [LOG_ID] must be URL-encoded within
log_name. Example: "organizations/1234567890/logs/cloudr
esourcemanager.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.
Optional. The log entry payload, which can be one of multiple types.
The log entry payload, represented as a Unicode string (UTF-8).
Optional. The time the event described by the log entry
occurred. This time is used to compute the log entry's age and
to enforce the logs retention period. If this field is omitted
in a new log entry, then Logging assigns it the current time.
Timestamps have nanosecond accuracy, but trailing zeros in the
fractional seconds might be omitted when the timestamp is
displayed. Incoming log entries should have timestamps that
are no more than the logs retention period
</logging/quotas> in the past, and no more than 24 hours in
the future. Log entries outside those time boundaries will not
be available when calling entries.list, but those log
entries can still be exported with LogSinks
</logging/docs/api/tasks/exporting-logs>.
Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT.
Optional. Information about the HTTP request associated with this log entry, if applicable.
Deprecated. Output only. Additional metadata about the
monitored resource. Only k8s_container, k8s_pod, and
k8s_node MonitoredResources have this field populated for
GKE versions older than 1.12.6. For GKE versions 1.12.6 and
above, the metadata field has been deprecated. The
Kubernetes pod labels that used to be in
metadata.userLabels will now be present in the labels
field with a key prefix of k8s-pod/. The Stackdriver
system labels that were present in the
metadata.systemLabels field will no longer be available in
the LogEntry.
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
Optional. The sampling decision of the trace associated with
the log entry. True means that the trace resource name in the
trace field was sampled for storage in a trace backend.
False means that the trace was not sampled for storage when
this log entry was written, or the sampling decision was
unknown at the time. A non-sampled trace value is still
useful as a request correlation identifier. The default is
False.
LogEntryOperation
Additional information about a potentially long-running operation with which a log entry is associated.
.. attribute:: id
Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
Optional. Set this to True if this is the first log entry in the operation.
LogEntrySourceLocation
Additional information about the source code location that produced the log entry.
.. attribute:: file
Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
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).
LogExclusion
Specifies a set of log entries that are not to be stored in Logging. If your GCP resource receives a large volume of logs, you can use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Note that organization-level and folder-level exclusions don't apply to child resources, and that you can't exclude audit log entries.
.. attribute:: name
Required. A client-assigned identifier, such as "load-
balancer-exclusion". Identifiers are limited to 100
characters and can include only letters, digits, underscores,
hyphens, and periods. First character has to be alphanumeric.
Required. An advanced logs filter
</logging/docs/view/advanced-queries> that matches the log
entries to be excluded. By using the sample function
</logging/docs/view/advanced-queries#sample>, you can
exclude less than 100% of the matching log entries. For
example, the following query matches 99% of low-severity log
entries from Google Cloud Storage buckets:
"resource.type=gcs_bucket severity<ERROR sample(insertId,
0.99)"
Output only. The creation timestamp of the exclusion. This field may not be present for older exclusions.
LogMetric
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.
Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.
.. attribute:: name
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".
Required. An advanced logs filter
</logging/docs/view/advanced_filters>__ which is used to
match log entries. Example: :: "resource.type=gae_app
AND severity>=ERROR" The maximum length of the filter is
20000 characters.
Optional. A value_extractor is required when using a
distribution logs-based metric to extract the values to record
from a log entry. Two functions are supported for value
extraction: EXTRACT(field) or REGEXP_EXTRACT(field,
regex). The argument are: 1. field: The name of the log
entry field from which the value is to be extracted. 2. regex:
A regular expression using the Google RE2 syntax
(https://github.com/google/re2/wiki/Syntax) with a single
capture group to extract data from the specified log entry
field. The value of the field is converted to a string before
applying the regex. It is an error to specify a regex that
does not include exactly one capture group. The result of the
extraction must be convertible to a double type, as the
distribution always records double values. If either the
extraction or the conversion to double fails, then those
values are not recorded in the distribution. Example:
REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*")
Optional. The bucket_options are required when the logs-
based metric is using a DISTRIBUTION value type and it
describes the bucket boundaries used to create a histogram of
the extracted values.
Output only. The last update timestamp of the metric. This field may not be present for older metrics.
LogSink
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.
.. attribute:: name
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. First character
has to be alphanumeric.
Optional. An advanced logs filter
</logging/docs/view/advanced-queries>__. The only exported
log entries are those that are in the resource owning the sink
and that match the filter. For example: ::
logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND
severity>=ERROR
Optional. If set to True, then this sink is disabled and it does not export any log entries.
Output only. An IAM identity—a service account or group—under
which Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create][google.logging.v2.ConfigServiceV2.CreateSink]
and
sinks.update][google.logging.v2.ConfigServiceV2.UpdateSink]
based on the value 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
</iam/docs/granting-roles-to-service-accounts#granting_access_
to_a_service_account_for_a_resource>__. Consult the
destination service's documentation to determine the
appropriate IAM roles to assign to the identity.
Optional. Destination dependent options.
Output only. The creation timestamp of the sink. This field may not be present for older sinks.
Do not use. This field is ignored.
MessageOptions
API documentation for logging_v2.types.MessageOptions class.
MethodDescriptorProto
API documentation for logging_v2.types.MethodDescriptorProto class.
MethodOptions
API documentation for logging_v2.types.MethodOptions class.
Metric
API documentation for logging_v2.types.Metric class.
MetricDescriptor
API documentation for logging_v2.types.MetricDescriptor class.
MonitoredResource
API documentation for logging_v2.types.MonitoredResource class.
MonitoredResourceDescriptor
API documentation for logging_v2.types.MonitoredResourceDescriptor class.
MonitoredResourceMetadata
API documentation for logging_v2.types.MonitoredResourceMetadata class.
OneofDescriptorProto
API documentation for logging_v2.types.OneofDescriptorProto class.
OneofOptions
API documentation for logging_v2.types.OneofOptions class.
ServiceDescriptorProto
API documentation for logging_v2.types.ServiceDescriptorProto class.
ServiceOptions
API documentation for logging_v2.types.ServiceOptions class.
SourceCodeInfo
API documentation for logging_v2.types.SourceCodeInfo class.
Status
API documentation for logging_v2.types.Status class.
Struct
API documentation for logging_v2.types.Struct class.
Timestamp
API documentation for logging_v2.types.Timestamp class.
UninterpretedOption
API documentation for logging_v2.types.UninterpretedOption class.
UpdateCmekSettingsRequest
The parameters to
UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings].
See Enabling CMEK for Logs
Router </logging/docs/routing/managed-encryption>__ for more
information.
.. attribute:: name
Required. The resource name for the CMEK settings to update.
:: "projects/[PROJECT_ID]/cmekSettings"
"organizations/[ORGANIZATION_ID]/cmekSettings"
"billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
"folders/[FOLDER_ID]/cmekSettings" Example:
"organizations/12345/cmekSettings". Note: CMEK for the
Logs Router can currently only be configured for GCP
organizations. Once configured, it applies to all projects and
folders in the GCP organization.
Optional. Field mask identifying which fields from
cmek_settings should be updated. A field will be
overwritten if and only if it is in the update mask. Output
only fields cannot be updated. See
FieldMask][google.protobuf.FieldMask] for more information.
Example: "updateMask=kmsKeyName"
UpdateExclusionRequest
The parameters to UpdateExclusion.
.. attribute:: name
Required. The resource name of the exclusion to update: ::
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID
]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example: "projects/my-project-id/exclusions/my-exclusion-
id".
Required. A non-empty list of fields to change in the existing
exclusion. New values for the fields are taken from the
corresponding fields in the
LogExclusion][google.logging.v2.LogExclusion] included in
this request. Fields not mentioned in update_mask are not
changed and are ignored in the request. For example, to
change the filter and description of an exclusion, specify an
update_mask of "filter,description".
UpdateLogMetricRequest
The parameters to UpdateLogMetric.
.. attribute:: metric_name
Required. The resource name of the metric to update: ::
"projects/[PROJECT_ID]/metrics/[METRIC_ID]" The 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.
UpdateSinkRequest
The parameters to UpdateSink.
.. attribute:: sink_name
Required. The full resource name of the sink to update,
including the parent resource and the sink identifier: ::
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]" Example:
"projects/my-project-id/sinks/my-sink-id".
Optional. See
sinks.create][google.logging.v2.ConfigServiceV2.CreateSink]
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: - If 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. - If the old value is false and
the new value is true, then writer_identity is changed
to a unique service account. - It is an error if the old
value is true and the new value is set to false or
defaulted to false.
Value
API documentation for logging_v2.types.Value class.
WriteLogEntriesPartialErrors
Error details for WriteLogEntries with partial success.
.. attribute:: log_entry_errors
When WriteLogEntriesRequest.partial_success is true,
records the error status for entries that were not written due
to a permanent error, keyed by the entry's zero-based index in
WriteLogEntriesRequest.entries. Failed requests for which
no entries are written will not include per-entry errors.
WriteLogEntriesRequest
The parameters to WriteLogEntries.
.. attribute:: log_name
Optional. A default log resource name that is assigned to all
log entries in entries that do not specify a value for
log_name: :: "projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-
encoded. For example: :: "projects/my-project-
id/logs/syslog" "organizations/1234567890/logs/cloudresour
cemanager.googleapis.com%2Factivity" The permission
logging.logEntries.create is needed on each project,
organization, billing account, or folder that is receiving new
log entries, whether the resource is specified in logName or
in an individual log entry.
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][google.logging.v2.LogEntry].
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, then
the response status is the error associated with one of the
failed entries and the response includes error details keyed
by the entries' zero-based index in the entries.write
method.
WriteLogEntriesResponse
Result returned from WriteLogEntries. empty