Cloud Logging V2 API - Class Google::Cloud::Logging::V2::UpdateSinkRequest (v0.7.0)

Reference documentation and code samples for the Cloud Logging V2 API class Google::Cloud::Logging::V2::UpdateSinkRequest.

The parameters to UpdateSink.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#sink

def sink() -> ::Google::Cloud::Logging::V2::LogSink
Returns

#sink=

def sink=(value) -> ::Google::Cloud::Logging::V2::LogSink
Parameter
Returns

#sink_name

def sink_name() -> ::String
Returns
  • (::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_name=

def sink_name=(value) -> ::String
Parameter
  • value (::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"

Returns
  • (::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"

#unique_writer_identity

def unique_writer_identity() -> ::Boolean
Returns
  • (::Boolean) —

    Optional. See {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#create_sink 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=

def unique_writer_identity=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    Optional. See {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#create_sink 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 {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#create_sink 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

def update_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

    For example: updateMask=filter

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • 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

    For example: updateMask=filter