Class Mutation.Ack.Builder (6.108.0)

public static final class Mutation.Ack.Builder extends GeneratedMessage.Builder<Mutation.Ack.Builder> implements Mutation.AckOrBuilder

Arguments to ack operations.

Protobuf type google.spanner.v1.Mutation.Ack

Static Methods

getDescriptor()

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

Methods

build()

public Mutation.Ack build()
Returns
Type Description
Mutation.Ack

buildPartial()

public Mutation.Ack buildPartial()
Returns
Type Description
Mutation.Ack

clear()

public Mutation.Ack.Builder clear()
Returns
Type Description
Mutation.Ack.Builder
Overrides

clearIgnoreNotFound()

public Mutation.Ack.Builder clearIgnoreNotFound()

By default, an attempt to ack a message that does not exist will fail with a NOT_FOUND error. With ignore_not_found set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.

bool ignore_not_found = 3;

Returns
Type Description
Mutation.Ack.Builder

This builder for chaining.

clearKey()

public Mutation.Ack.Builder clearKey()

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Mutation.Ack.Builder

clearQueue()

public Mutation.Ack.Builder clearQueue()

Required. The queue where the message to be acked is stored.

string queue = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Mutation.Ack.Builder

This builder for chaining.

getDefaultInstanceForType()

public Mutation.Ack getDefaultInstanceForType()
Returns
Type Description
Mutation.Ack

getDescriptorForType()

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

getIgnoreNotFound()

public boolean getIgnoreNotFound()

By default, an attempt to ack a message that does not exist will fail with a NOT_FOUND error. With ignore_not_found set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.

bool ignore_not_found = 3;

Returns
Type Description
boolean

The ignoreNotFound.

getKey()

public ListValue getKey()

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListValue

The key.

getKeyBuilder()

public ListValue.Builder getKeyBuilder()

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getKeyOrBuilder()

public ListValueOrBuilder getKeyOrBuilder()

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListValueOrBuilder

getQueue()

public String getQueue()

Required. The queue where the message to be acked is stored.

string queue = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The queue.

getQueueBytes()

public ByteString getQueueBytes()

Required. The queue where the message to be acked is stored.

string queue = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for queue.

hasKey()

public boolean hasKey()

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the key field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(Mutation.Ack other)

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

mergeKey(ListValue value)

public Mutation.Ack.Builder mergeKey(ListValue value)

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ListValue
Returns
Type Description
Mutation.Ack.Builder

setIgnoreNotFound(boolean value)

public Mutation.Ack.Builder setIgnoreNotFound(boolean value)

By default, an attempt to ack a message that does not exist will fail with a NOT_FOUND error. With ignore_not_found set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.

bool ignore_not_found = 3;

Parameter
Name Description
value boolean

The ignoreNotFound to set.

Returns
Type Description
Mutation.Ack.Builder

This builder for chaining.

setKey(ListValue value)

public Mutation.Ack.Builder setKey(ListValue value)

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ListValue
Returns
Type Description
Mutation.Ack.Builder

setKey(ListValue.Builder builderForValue)

public Mutation.Ack.Builder setKey(ListValue.Builder builderForValue)

Required. The primary key of the message to be acked.

.google.protobuf.ListValue key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Mutation.Ack.Builder

setQueue(String value)

public Mutation.Ack.Builder setQueue(String value)

Required. The queue where the message to be acked is stored.

string queue = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The queue to set.

Returns
Type Description
Mutation.Ack.Builder

This builder for chaining.

setQueueBytes(ByteString value)

public Mutation.Ack.Builder setQueueBytes(ByteString value)

Required. The queue where the message to be acked is stored.

string queue = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for queue to set.

Returns
Type Description
Mutation.Ack.Builder

This builder for chaining.