Class: Google::Cloud::Logging::V2::UpdateSinkRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/logging/v2/logging_config.rb

Overview

The parameters to UpdateSink.

Instance Attribute Summary collapse

Instance Attribute Details

#sink ⇒ ::Google::Cloud::Logging::V2::LogSink

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

Returns:



682
683
684
685
 
# File 'proto_docs/google/logging/v2/logging_config.rb', line 682

class UpdateSinkRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sink_name ⇒ ::String

Returns 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"



682
683
684
685
 
# File 'proto_docs/google/logging/v2/logging_config.rb', line 682

class UpdateSinkRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#unique_writer_identity ⇒ ::Boolean

Returns 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.


682
683
684
685
 
# File 'proto_docs/google/logging/v2/logging_config.rb', line 682

class UpdateSinkRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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



682
683
684
685
 
# File 'proto_docs/google/logging/v2/logging_config.rb', line 682

class UpdateSinkRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end