public static final class PartitionReadRequest.Builder extends GeneratedMessageV3.Builder<PartitionReadRequest.Builder> implements PartitionReadRequestOrBuilder
The request for PartitionRead
Protobuf type google.spanner.v1.PartitionReadRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartitionReadRequest.BuilderImplements
PartitionReadRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllColumns(Iterable<String> values)
public PartitionReadRequest.Builder addAllColumns(Iterable<String> values)
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The columns to add. |
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
This builder for chaining. |
addColumns(String value)
public PartitionReadRequest.Builder addColumns(String value)
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Parameter | |
---|---|
Name | Description |
value |
String The columns to add. |
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
This builder for chaining. |
addColumnsBytes(ByteString value)
public PartitionReadRequest.Builder addColumnsBytes(ByteString value)
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the columns to add. |
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PartitionReadRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
build()
public PartitionReadRequest build()
Returns | |
---|---|
Type | Description |
PartitionReadRequest |
buildPartial()
public PartitionReadRequest buildPartial()
Returns | |
---|---|
Type | Description |
PartitionReadRequest |
clear()
public PartitionReadRequest.Builder clear()
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
clearColumns()
public PartitionReadRequest.Builder clearColumns()
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PartitionReadRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
clearIndex()
public PartitionReadRequest.Builder clearIndex()
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
string index = 4;
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
This builder for chaining. |
clearKeySet()
public PartitionReadRequest.Builder clearKeySet()
Required. key_set
identifies the rows to be yielded. key_set
names the
primary keys of the rows in
table to be yielded, unless
index is present. If
index is present, then
key_set instead names
index keys in index.
It is not an error for the key_set
to name rows that do not
exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public PartitionReadRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
clearPartitionOptions()
public PartitionReadRequest.Builder clearPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
clearSession()
public PartitionReadRequest.Builder clearSession()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
This builder for chaining. |
clearTable()
public PartitionReadRequest.Builder clearTable()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
This builder for chaining. |
clearTransaction()
public PartitionReadRequest.Builder clearTransaction()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
clone()
public PartitionReadRequest.Builder clone()
Returns | |
---|---|
Type | Description |
PartitionReadRequest.Builder |
getColumns(int index)
public String getColumns(int index)
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The columns at the given index. |
getColumnsBytes(int index)
public ByteString getColumnsBytes(int index)
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the columns at the given index. |
getColumnsCount()
public int getColumnsCount()
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Returns | |
---|---|
Type | Description |
int |
The count of columns. |
getColumnsList()
public ProtocolStringList getColumnsList()
The columns of table to be returned for each row matching this request.
repeated string columns = 5;
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the columns. |
getDefaultInstanceForType()
public PartitionReadRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
PartitionReadRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getIndex()
public String getIndex()
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
string index = 4;
Returns | |
---|---|
Type | Description |
String |
The index. |
getIndexBytes()
public ByteString getIndexBytes()
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
string index = 4;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for index. |
getKeySet()
public KeySet getKeySet()
Required. key_set
identifies the rows to be yielded. key_set
names the
primary keys of the rows in
table to be yielded, unless
index is present. If
index is present, then
key_set instead names
index keys in index.
It is not an error for the key_set
to name rows that do not
exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
KeySet |
The keySet. |
getKeySetBuilder()
public KeySet.Builder getKeySetBuilder()
Required. key_set
identifies the rows to be yielded. key_set
names the
primary keys of the rows in
table to be yielded, unless
index is present. If
index is present, then
key_set instead names
index keys in index.
It is not an error for the key_set
to name rows that do not
exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
KeySet.Builder |
getKeySetOrBuilder()
public KeySetOrBuilder getKeySetOrBuilder()
Required. key_set
identifies the rows to be yielded. key_set
names the
primary keys of the rows in
table to be yielded, unless
index is present. If
index is present, then
key_set instead names
index keys in index.
It is not an error for the key_set
to name rows that do not
exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
KeySetOrBuilder |
getPartitionOptions()
public PartitionOptions getPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
Returns | |
---|---|
Type | Description |
PartitionOptions |
The partitionOptions. |
getPartitionOptionsBuilder()
public PartitionOptions.Builder getPartitionOptionsBuilder()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
Returns | |
---|---|
Type | Description |
PartitionOptions.Builder |
getPartitionOptionsOrBuilder()
public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
Returns | |
---|---|
Type | Description |
PartitionOptionsOrBuilder |
getSession()
public String getSession()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The session. |
getSessionBytes()
public ByteString getSessionBytes()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for session. |
getTable()
public String getTable()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The table. |
getTableBytes()
public ByteString getTableBytes()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for table. |
getTransaction()
public TransactionSelector getTransaction()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
TransactionSelector |
The transaction. |
getTransactionBuilder()
public TransactionSelector.Builder getTransactionBuilder()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
TransactionSelector.Builder |
getTransactionOrBuilder()
public TransactionSelectorOrBuilder getTransactionOrBuilder()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
TransactionSelectorOrBuilder |
hasKeySet()
public boolean hasKeySet()
Required. key_set
identifies the rows to be yielded. key_set
names the
primary keys of the rows in
table to be yielded, unless
index is present. If
index is present, then
key_set instead names
index keys in index.
It is not an error for the key_set
to name rows that do not
exist in the database. Read yields nothing for nonexistent rows.
.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the keySet field is set. |
hasPartitionOptions()
public boolean hasPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
Returns | |
---|---|
Type | Description |
boolean |
Whether the partitionOptions field is set. |
hasTransaction()
public boolean hasTransaction()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
boolean |
Whether the transaction field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |