Class AdaptMessageAction.Builder (6.116.0)

public static final class AdaptMessageAction.Builder extends GeneratedMessage.Builder<AdaptMessageAction.Builder> implements AdaptMessageActionOrBuilder

A single Adapt message request.

Protobuf type google.spanner.executor.v1.AdaptMessageAction

Static Methods

getDescriptor()

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

Methods

build()

public AdaptMessageAction build()
Returns
Type Description
AdaptMessageAction

buildPartial()

public AdaptMessageAction buildPartial()
Returns
Type Description
AdaptMessageAction

clear()

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

clearAttachments()

public AdaptMessageAction.Builder clearAttachments()
Returns
Type Description
AdaptMessageAction.Builder

clearDatabaseUri()

public AdaptMessageAction.Builder clearDatabaseUri()

The fully qualified uri of the database to send AdaptMessage to.

string database_uri = 1;

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

clearPayload()

public AdaptMessageAction.Builder clearPayload()

The payload of the request.

bytes payload = 3;

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

clearPrepareThenExecute()

public AdaptMessageAction.Builder clearPrepareThenExecute()

If true, the action will send a Prepare request first and then an Execute request right after to execute the query. This is only supported for Cloud Client path.

bool prepare_then_execute = 6;

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

clearProtocol()

public AdaptMessageAction.Builder clearProtocol()

The protocol to use for the request.

string protocol = 2;

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

clearQuery()

public AdaptMessageAction.Builder clearQuery()

The query to be sent with the request.

string query = 5;

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

containsAttachments(String key)

public boolean containsAttachments(String key)

Attachments to be sent with the request.

map<string, string> attachments = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAttachments() (deprecated)

public Map<String,String> getAttachments()

Use #getAttachmentsMap() instead.

Returns
Type Description
Map<String,String>

getAttachmentsCount()

public int getAttachmentsCount()

Attachments to be sent with the request.

map<string, string> attachments = 4;

Returns
Type Description
int

getAttachmentsMap()

public Map<String,String> getAttachmentsMap()

Attachments to be sent with the request.

map<string, string> attachments = 4;

Returns
Type Description
Map<String,String>

getAttachmentsOrDefault(String key, String defaultValue)

public String getAttachmentsOrDefault(String key, String defaultValue)

Attachments to be sent with the request.

map<string, string> attachments = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAttachmentsOrThrow(String key)

public String getAttachmentsOrThrow(String key)

Attachments to be sent with the request.

map<string, string> attachments = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getDatabaseUri()

public String getDatabaseUri()

The fully qualified uri of the database to send AdaptMessage to.

string database_uri = 1;

Returns
Type Description
String

The databaseUri.

getDatabaseUriBytes()

public ByteString getDatabaseUriBytes()

The fully qualified uri of the database to send AdaptMessage to.

string database_uri = 1;

Returns
Type Description
ByteString

The bytes for databaseUri.

getDefaultInstanceForType()

public AdaptMessageAction getDefaultInstanceForType()
Returns
Type Description
AdaptMessageAction

getDescriptorForType()

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

getMutableAttachments() (deprecated)

public Map<String,String> getMutableAttachments()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getPayload()

public ByteString getPayload()

The payload of the request.

bytes payload = 3;

Returns
Type Description
ByteString

The payload.

getPrepareThenExecute()

public boolean getPrepareThenExecute()

If true, the action will send a Prepare request first and then an Execute request right after to execute the query. This is only supported for Cloud Client path.

bool prepare_then_execute = 6;

Returns
Type Description
boolean

The prepareThenExecute.

getProtocol()

public String getProtocol()

The protocol to use for the request.

string protocol = 2;

Returns
Type Description
String

The protocol.

getProtocolBytes()

public ByteString getProtocolBytes()

The protocol to use for the request.

string protocol = 2;

Returns
Type Description
ByteString

The bytes for protocol.

getQuery()

public String getQuery()

The query to be sent with the request.

string query = 5;

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

The query to be sent with the request.

string query = 5;

Returns
Type Description
ByteString

The bytes for query.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(AdaptMessageAction other)

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

putAllAttachments(Map<String,String> values)

public AdaptMessageAction.Builder putAllAttachments(Map<String,String> values)

Attachments to be sent with the request.

map<string, string> attachments = 4;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AdaptMessageAction.Builder

putAttachments(String key, String value)

public AdaptMessageAction.Builder putAttachments(String key, String value)

Attachments to be sent with the request.

map<string, string> attachments = 4;

Parameters
Name Description
key String
value String
Returns
Type Description
AdaptMessageAction.Builder

removeAttachments(String key)

public AdaptMessageAction.Builder removeAttachments(String key)

Attachments to be sent with the request.

map<string, string> attachments = 4;

Parameter
Name Description
key String
Returns
Type Description
AdaptMessageAction.Builder

setDatabaseUri(String value)

public AdaptMessageAction.Builder setDatabaseUri(String value)

The fully qualified uri of the database to send AdaptMessage to.

string database_uri = 1;

Parameter
Name Description
value String

The databaseUri to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

setDatabaseUriBytes(ByteString value)

public AdaptMessageAction.Builder setDatabaseUriBytes(ByteString value)

The fully qualified uri of the database to send AdaptMessage to.

string database_uri = 1;

Parameter
Name Description
value ByteString

The bytes for databaseUri to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

setPayload(ByteString value)

public AdaptMessageAction.Builder setPayload(ByteString value)

The payload of the request.

bytes payload = 3;

Parameter
Name Description
value ByteString

The payload to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

setPrepareThenExecute(boolean value)

public AdaptMessageAction.Builder setPrepareThenExecute(boolean value)

If true, the action will send a Prepare request first and then an Execute request right after to execute the query. This is only supported for Cloud Client path.

bool prepare_then_execute = 6;

Parameter
Name Description
value boolean

The prepareThenExecute to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

setProtocol(String value)

public AdaptMessageAction.Builder setProtocol(String value)

The protocol to use for the request.

string protocol = 2;

Parameter
Name Description
value String

The protocol to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

setProtocolBytes(ByteString value)

public AdaptMessageAction.Builder setProtocolBytes(ByteString value)

The protocol to use for the request.

string protocol = 2;

Parameter
Name Description
value ByteString

The bytes for protocol to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

setQuery(String value)

public AdaptMessageAction.Builder setQuery(String value)

The query to be sent with the request.

string query = 5;

Parameter
Name Description
value String

The query to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public AdaptMessageAction.Builder setQueryBytes(ByteString value)

The query to be sent with the request.

string query = 5;

Parameter
Name Description
value ByteString

The bytes for query to set.

Returns
Type Description
AdaptMessageAction.Builder

This builder for chaining.