Interface UpdateSinkRequestOrBuilder (3.17.0)

public interface UpdateSinkRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSink()

public abstract LogSink getSink()

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

.google.logging.v2.LogSink sink = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LogSink

The sink.

getSinkName()

public abstract String 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"

string sink_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The sinkName.

getSinkNameBytes()

public abstract ByteString getSinkNameBytes()

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"

string sink_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for sinkName.

getSinkOrBuilder()

public abstract LogSinkOrBuilder getSinkOrBuilder()

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

.google.logging.v2.LogSink sink = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LogSinkOrBuilder

getUniqueWriterIdentity()

public abstract boolean 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.

bool unique_writer_identity = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The uniqueWriterIdentity.

getUpdateMask()

public abstract FieldMask 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

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

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

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasSink()

public abstract boolean hasSink()

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

.google.logging.v2.LogSink sink = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the sink field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

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

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updateMask field is set.