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.
#unique_writer_identity=
defunique_writer_identity=(value)->::Boolean
Parameter
value (::Boolean) —
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
(::Boolean) —
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
defupdate_mask()->::Google::Protobuf::FieldMask
Returns
(::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
value (::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
(::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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Logging V2 API - Class Google::Cloud::Logging::V2::UpdateSinkRequest (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-logging-v2/latest/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [1.2.1](/ruby/docs/reference/google-cloud-logging-v2/1.2.1/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-logging-v2/1.1.0/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-logging-v2/1.0.1/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-logging-v2/0.13.0/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.12.2](/ruby/docs/reference/google-cloud-logging-v2/0.12.2/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-logging-v2/0.11.0/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.10.1](/ruby/docs/reference/google-cloud-logging-v2/0.10.1/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-logging-v2/0.9.0/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.8.1](/ruby/docs/reference/google-cloud-logging-v2/0.8.1/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-logging-v2/0.7.0/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-logging-v2/0.6.0/Google-Cloud-Logging-V2-UpdateSinkRequest)\n- [0.5.6](/ruby/docs/reference/google-cloud-logging-v2/0.5.6/Google-Cloud-Logging-V2-UpdateSinkRequest) \nReference documentation and code samples for the Cloud Logging V2 API class Google::Cloud::Logging::V2::UpdateSinkRequest.\n\nThe parameters to `UpdateSink`. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #sink\n\n def sink() -\u003e ::Google::Cloud::Logging::V2::LogSink\n\n**Returns**\n\n- ([::Google::Cloud::Logging::V2::LogSink](./Google-Cloud-Logging-V2-LogSink)) --- Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.\n\n### #sink=\n\n def sink=(value) -\u003e ::Google::Cloud::Logging::V2::LogSink\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Logging::V2::LogSink](./Google-Cloud-Logging-V2-LogSink)) --- Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`. \n**Returns**\n\n- ([::Google::Cloud::Logging::V2::LogSink](./Google-Cloud-Logging-V2-LogSink)) --- Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.\n\n### #sink_name\n\n def sink_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\n \"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n \"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\n\n For example:\n\n `\"projects/my-project/sinks/my-sink\"`\n\n### #sink_name=\n\n def sink_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\n\n \"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n \"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\n\n For example:\n\n`\"projects/my-project/sinks/my-sink\"` \n**Returns**\n\n- (::String) --- Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\n \"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n \"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\n\n For example:\n\n `\"projects/my-project/sinks/my-sink\"`\n\n### #unique_writer_identity\n\n def unique_writer_identity() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. See [sinks.create](/ruby/docs/reference/google-cloud-logging-v2/latest/Google-Cloud-Logging-V2-ConfigService-Client#Google__Cloud__Logging__V2__ConfigService__Client_create_sink_instance_ \"Google::Cloud::Logging::V2::ConfigService::Client#create_sink (method)\")\n for a description of this field. When updating a sink, the effect of this\n field on the value of `writer_identity` in the updated sink depends on both\n the old and new values of this field:\n\n - 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`.\n - If the old value is false and the new value is true, then `writer_identity` is changed to a unique service account.\n - It is an error if the old value is true and the new value is set to false or defaulted to false.\n\n### #unique_writer_identity=\n\n def unique_writer_identity=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) ---\n\n Optional. See [sinks.create](/ruby/docs/reference/google-cloud-logging-v2/latest/Google-Cloud-Logging-V2-ConfigService-Client#Google__Cloud__Logging__V2__ConfigService__Client_create_sink_instance_ \"Google::Cloud::Logging::V2::ConfigService::Client#create_sink (method)\")\n for a description of this field. When updating a sink, the effect of this\n field on the value of `writer_identity` in the updated sink depends on both\n the old and new values of this field:\n - 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`.\n - If the old value is false and the new value is true, then `writer_identity` is changed to a unique service account.\n- It is an error if the old value is true and the new value is set to false or defaulted to false. \n**Returns**\n\n- (::Boolean) --- Optional. See [sinks.create](/ruby/docs/reference/google-cloud-logging-v2/latest/Google-Cloud-Logging-V2-ConfigService-Client#Google__Cloud__Logging__V2__ConfigService__Client_create_sink_instance_ \"Google::Cloud::Logging::V2::ConfigService::Client#create_sink (method)\")\n for a description of this field. When updating a sink, the effect of this\n field on the value of `writer_identity` in the updated sink depends on both\n the old and new values of this field:\n\n - 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`.\n - If the old value is false and the new value is true, then `writer_identity` is changed to a unique service account.\n - It is an error if the old value is true and the new value is set to false or defaulted to false.\n\n### #update_mask\n\n def update_mask() -\u003e ::Google::Protobuf::FieldMask\n\n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./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.\n\n\n An empty `updateMask` is temporarily treated as using the following mask\n for backwards compatibility purposes:\n\n `destination,filter,includeChildren`\n\n At some point in the future, behavior will be removed and specifying an\n empty `updateMask` will be an error.\n\n For a detailed `FieldMask` definition, see\n https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask\n\n For example: `updateMask=filter`\n\n### #update_mask=\n\n def update_mask=(value) -\u003e ::Google::Protobuf::FieldMask\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::FieldMask](./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.\n\n\n An empty `updateMask` is temporarily treated as using the following mask\n for backwards compatibility purposes:\n\n `destination,filter,includeChildren`\n\n At some point in the future, behavior will be removed and specifying an\n empty `updateMask` will be an error.\n\n For a detailed `FieldMask` definition, see\n https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask\n\nFor example: `updateMask=filter` \n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./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.\n\n\n An empty `updateMask` is temporarily treated as using the following mask\n for backwards compatibility purposes:\n\n `destination,filter,includeChildren`\n\n At some point in the future, behavior will be removed and specifying an\n empty `updateMask` will be an error.\n\n For a detailed `FieldMask` definition, see\n https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask\n\n For example: `updateMask=filter`"]]