Reference documentation and code samples for the Stackdriver Logging V2 Client class UpdateSinkRequest.
The parameters to UpdateSink
.
Generated from protobuf message google.logging.v2.UpdateSinkRequest
Namespace
Google \ Cloud \ Logging \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ sink_name
string
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]" For example: "projects/my-project/sinks/my-sink"
↳ sink
LogSink
Required. The updated sink, whose name is the same identifier that appears as part of sink_name
.
↳ unique_writer_identity
bool
Optional. See sinks.create
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.
↳ update_mask
Google\Protobuf\FieldMask
Optional. Field mask that specifies the fields in sink
that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name
and output only fields cannot be updated. An empty updateMask
is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren
At some point in the future, behavior will be removed and specifying an empty updateMask
will be an error. For a detailed FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
For example: updateMask=filter
getSinkName
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]"
For example: "projects/my-project/sinks/my-sink"
string
setSinkName
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]"
For example: "projects/my-project/sinks/my-sink"
var
string
$this
getSink
Required. The updated sink, whose name is the same identifier that appears
as part of sink_name
.
hasSink
clearSink
setSink
Required. The updated sink, whose name is the same identifier that appears
as part of sink_name
.
$this
getUniqueWriterIdentity
Optional. See sinks.create
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_identityis 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.
bool
setUniqueWriterIdentity
Optional. See sinks.create
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_identityis 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.
var
bool
$this
getUpdateMask
Optional. Field mask that specifies the fields in sink
that need
an update. A sink field will be overwritten if, and only if, it is
in the update mask. name
and output only fields cannot be updated.
An empty updateMask
is temporarily treated as using the following mask
for backwards compatibility purposes: destination,filter,includeChildren
At some point in the future, behavior will be removed and specifying an
empty updateMask
will be an error.
For a detailed FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
For example: updateMask=filter
hasUpdateMask
clearUpdateMask
setUpdateMask
Optional. Field mask that specifies the fields in sink
that need
an update. A sink field will be overwritten if, and only if, it is
in the update mask. name
and output only fields cannot be updated.
An empty updateMask
is temporarily treated as using the following mask
for backwards compatibility purposes: destination,filter,includeChildren
At some point in the future, behavior will be removed and specifying an
empty updateMask
will be an error.
For a detailed FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
For example: updateMask=filter
$this
static::build
sinkName
string
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]"
For example:
"projects/my-project/sinks/my-sink"
Please see ConfigServiceV2Client::logSinkName()
for help formatting this field.
sink
LogSink
Required. The updated sink, whose name is the same identifier that appears
as part of sink_name
.
updateMask
Google\Protobuf\FieldMask
Optional. Field mask that specifies the fields in sink
that need
an update. A sink field will be overwritten if, and only if, it is
in the update mask. name
and output only fields cannot be updated.
An empty updateMask
is temporarily treated as using the following mask
for backwards compatibility purposes:
destination,filter,includeChildren
At some point in the future, behavior will be removed and specifying an
empty updateMask
will be an error.
For a detailed FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
For example: updateMask=filter
static::buildFromSinkNameSink
sinkName
string
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]"
For example:
"projects/my-project/sinks/my-sink"
Please see ConfigServiceV2Client::logSinkName()
for help formatting this field.
sink
LogSink
Required. The updated sink, whose name is the same identifier that appears
as part of sink_name
.
