Stackdriver Logging V2 Client - Class UpdateSinkRequest (1.29.0)

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 \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`Google\Cloud\Logging\V2\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"

Returns
Type	Description
`string`

setSinkName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSink

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

Returns
Type	Description
`Google\Cloud\Logging\V2\LogSink\|null`

hasSink

clearSink

setSink

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

Parameter
Name	Description
`var`	`Google\Cloud\Logging\V2\LogSink`

Returns
Type	Description
`$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_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.

Returns
Type	Description
`bool`

setUniqueWriterIdentity

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$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

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`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 Google\Cloud\Logging\V2\ConfigServiceV2Client::logSinkName() for help formatting this field.
`sink`	`Google\Cloud\Logging\V2\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`

Returns
Type	Description
`Google\Cloud\Logging\V2\UpdateSinkRequest`

static::buildFromSinkNameSink

Parameters

Name Description

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 Google\Cloud\Logging\V2\ConfigServiceV2Client::logSinkName() for help formatting this field.

sink

Google\Cloud\Logging\V2\LogSink

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

Returns
Type	Description
`Google\Cloud\Logging\V2\UpdateSinkRequest`