Google Cloud Logging v2 API - Class UpdateSinkRequest (4.2.0) 

public sealed class UpdateSinkRequest : IMessage<UpdateSinkRequest>, IEquatable<UpdateSinkRequest>, IDeepCloneable<UpdateSinkRequest>, IBufferMessage, IMessage

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

The parameters to UpdateSink.

Inheritance

object > UpdateSinkRequest

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

UpdateSinkRequest()

public UpdateSinkRequest()

UpdateSinkRequest(UpdateSinkRequest)

public UpdateSinkRequest(UpdateSinkRequest other)
Parameter
NameDescription
otherUpdateSinkRequest

Properties

Sink

public LogSink Sink { get; set; }

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

Property Value
TypeDescription
LogSink

SinkName

public string SinkName { get; set; }

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"

Property Value
TypeDescription
string

SinkNameAsLogSinkName

public LogSinkName SinkNameAsLogSinkName { get; set; }

LogSinkName-typed view over the SinkName resource name property.

Property Value
TypeDescription
LogSinkName

UniqueWriterIdentity

public bool UniqueWriterIdentity { get; set; }

Optional. See [sinks.create][google.logging.v2.ConfigServiceV2.CreateSink] 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.
Property Value
TypeDescription
bool

UpdateMask

public FieldMask UpdateMask { get; set; }

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

Property Value
TypeDescription
FieldMask