Class UpdateSinkRequest.Builder (3.17.0)

public static final class UpdateSinkRequest.Builder extends GeneratedMessageV3.Builder<UpdateSinkRequest.Builder> implements UpdateSinkRequestOrBuilder

The parameters to UpdateSink.

Protobuf type google.logging.v2.UpdateSinkRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateSinkRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateSinkRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

build()

public UpdateSinkRequest build()
Returns
Type Description
UpdateSinkRequest

buildPartial()

public UpdateSinkRequest buildPartial()
Returns
Type Description
UpdateSinkRequest

clear()

public UpdateSinkRequest.Builder clear()
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateSinkRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateSinkRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

clearSink()

public UpdateSinkRequest.Builder clearSink()

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
UpdateSinkRequest.Builder

clearSinkName()

public UpdateSinkRequest.Builder clearSinkName()

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
UpdateSinkRequest.Builder

This builder for chaining.

clearUniqueWriterIdentity()

public UpdateSinkRequest.Builder clearUniqueWriterIdentity()

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
UpdateSinkRequest.Builder

This builder for chaining.

clearUpdateMask()

public UpdateSinkRequest.Builder clearUpdateMask()

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
UpdateSinkRequest.Builder

clone()

public UpdateSinkRequest.Builder clone()
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateSinkRequest getDefaultInstanceForType()
Returns
Type Description
UpdateSinkRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getSink()

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

getSinkBuilder()

public LogSink.Builder getSinkBuilder()

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

getSinkName()

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

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Builder

getUpdateMaskOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateSinkRequest other)

public UpdateSinkRequest.Builder mergeFrom(UpdateSinkRequest other)
Parameter
Name Description
other UpdateSinkRequest
Returns
Type Description
UpdateSinkRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateSinkRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSinkRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateSinkRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

mergeSink(LogSink value)

public UpdateSinkRequest.Builder mergeSink(LogSink value)

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];

Parameter
Name Description
value LogSink
Returns
Type Description
UpdateSinkRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateSinkRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateSinkRequest.Builder mergeUpdateMask(FieldMask value)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateSinkRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateSinkRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateSinkRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

setSink(LogSink value)

public UpdateSinkRequest.Builder setSink(LogSink value)

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];

Parameter
Name Description
value LogSink
Returns
Type Description
UpdateSinkRequest.Builder

setSink(LogSink.Builder builderForValue)

public UpdateSinkRequest.Builder setSink(LogSink.Builder builderForValue)

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];

Parameter
Name Description
builderForValue LogSink.Builder
Returns
Type Description
UpdateSinkRequest.Builder

setSinkName(String value)

public UpdateSinkRequest.Builder setSinkName(String value)

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) = { ... }

Parameter
Name Description
value String

The sinkName to set.
Returns
Type Description
UpdateSinkRequest.Builder

This builder for chaining.

setSinkNameBytes(ByteString value)

public UpdateSinkRequest.Builder setSinkNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for sinkName to set.
Returns
Type Description
UpdateSinkRequest.Builder

This builder for chaining.

setUniqueWriterIdentity(boolean value)

public UpdateSinkRequest.Builder setUniqueWriterIdentity(boolean value)

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];

Parameter
Name Description
value boolean

The uniqueWriterIdentity to set.
Returns
Type Description
UpdateSinkRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateSinkRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateSinkRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateSinkRequest.Builder setUpdateMask(FieldMask value)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateSinkRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateSinkRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateSinkRequest.Builder