publicstaticfinalclassPartitionReadRequest.BuilderextendsGeneratedMessageV3.Builder<PartitionReadRequest.Builder>implementsPartitionReadRequestOrBuilderThe 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()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllColumns(Iterable<String> values)
publicPartitionReadRequest.BuilderaddAllColumns(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)
publicPartitionReadRequest.BuilderaddColumns(Stringvalue)The columns of table to be returned for each row matching this request.
repeated string columns = 5;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe columns to add. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
addColumnsBytes(ByteString value)
publicPartitionReadRequest.BuilderaddColumnsBytes(ByteStringvalue)The columns of table to be returned for each row matching this request.
repeated string columns = 5;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the columns to add. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicPartitionReadRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
build()
publicPartitionReadRequestbuild()| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest | |
buildPartial()
publicPartitionReadRequestbuildPartial()| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest | |
clear()
publicPartitionReadRequest.Builderclear()| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
clearColumns()
publicPartitionReadRequest.BuilderclearColumns()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)
publicPartitionReadRequest.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
clearIndex()
publicPartitionReadRequest.BuilderclearIndex()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()
publicPartitionReadRequest.BuilderclearKeySet() 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)
publicPartitionReadRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
clearPartitionOptions()
publicPartitionReadRequest.BuilderclearPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
clearSession()
publicPartitionReadRequest.BuilderclearSession()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()
publicPartitionReadRequest.BuilderclearTable()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()
publicPartitionReadRequest.BuilderclearTransaction()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()
publicPartitionReadRequest.Builderclone()| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
getColumns(int index)
publicStringgetColumns(intindex)The columns of table to be returned for each row matching this request.
repeated string columns = 5;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The columns at the given index. |
getColumnsBytes(int index)
publicByteStringgetColumnsBytes(intindex)The columns of table to be returned for each row matching this request.
repeated string columns = 5;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the columns at the given index. |
getColumnsCount()
publicintgetColumnsCount()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()
publicProtocolStringListgetColumnsList()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()
publicPartitionReadRequestgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest | |
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getIndex()
publicStringgetIndex()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()
publicByteStringgetIndexBytes()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()
publicKeySetgetKeySet() 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()
publicKeySet.BuildergetKeySetBuilder() 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()
publicKeySetOrBuildergetKeySetOrBuilder() 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()
publicPartitionOptionsgetPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
| Returns | |
|---|---|
| Type | Description |
PartitionOptions | The partitionOptions. |
getPartitionOptionsBuilder()
publicPartitionOptions.BuildergetPartitionOptionsBuilder()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
| Returns | |
|---|---|
| Type | Description |
PartitionOptions.Builder | |
getPartitionOptionsOrBuilder()
publicPartitionOptionsOrBuildergetPartitionOptionsOrBuilder()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
| Returns | |
|---|---|
| Type | Description |
PartitionOptionsOrBuilder | |
getSession()
publicStringgetSession()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()
publicByteStringgetSessionBytes()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()
publicStringgetTable()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()
publicByteStringgetTableBytes()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()
publicTransactionSelectorgetTransaction()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()
publicTransactionSelector.BuildergetTransactionBuilder()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()
publicTransactionSelectorOrBuildergetTransactionOrBuilder()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()
publicbooleanhasKeySet() 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()
publicbooleanhasPartitionOptions()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()
publicbooleanhasTransaction()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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicPartitionReadRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
publicPartitionReadRequest.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
mergeFrom(PartitionReadRequest other)
publicPartitionReadRequest.BuildermergeFrom(PartitionReadRequestother)| Parameter | |
|---|---|
| Name | Description |
other | PartitionReadRequest |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
mergeKeySet(KeySet value)
publicPartitionReadRequest.BuildermergeKeySet(KeySetvalue) 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];
| Parameter | |
|---|---|
| Name | Description |
value | KeySet |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
mergePartitionOptions(PartitionOptions value)
publicPartitionReadRequest.BuildermergePartitionOptions(PartitionOptionsvalue)Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
| Parameter | |
|---|---|
| Name | Description |
value | PartitionOptions |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
mergeTransaction(TransactionSelector value)
publicPartitionReadRequest.BuildermergeTransaction(TransactionSelectorvalue)Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Parameter | |
|---|---|
| Name | Description |
value | TransactionSelector |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalPartitionReadRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setColumns(int index, String value)
publicPartitionReadRequest.BuildersetColumns(intindex,Stringvalue)The columns of table to be returned for each row matching this request.
repeated string columns = 5;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe columns to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
publicPartitionReadRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setIndex(String value)
publicPartitionReadRequest.BuildersetIndex(Stringvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe index to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
setIndexBytes(ByteString value)
publicPartitionReadRequest.BuildersetIndexBytes(ByteStringvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for index to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
setKeySet(KeySet value)
publicPartitionReadRequest.BuildersetKeySet(KeySetvalue) 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];
| Parameter | |
|---|---|
| Name | Description |
value | KeySet |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setKeySet(KeySet.Builder builderForValue)
publicPartitionReadRequest.BuildersetKeySet(KeySet.BuilderbuilderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | KeySet.Builder |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setPartitionOptions(PartitionOptions value)
publicPartitionReadRequest.BuildersetPartitionOptions(PartitionOptionsvalue)Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
| Parameter | |
|---|---|
| Name | Description |
value | PartitionOptions |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setPartitionOptions(PartitionOptions.Builder builderForValue)
publicPartitionReadRequest.BuildersetPartitionOptions(PartitionOptions.BuilderbuilderForValue)Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | PartitionOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicPartitionReadRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setSession(String value)
publicPartitionReadRequest.BuildersetSession(Stringvalue)Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe session to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
setSessionBytes(ByteString value)
publicPartitionReadRequest.BuildersetSessionBytes(ByteStringvalue)Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for session to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
setTable(String value)
publicPartitionReadRequest.BuildersetTable(Stringvalue)Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe table to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
setTableBytes(ByteString value)
publicPartitionReadRequest.BuildersetTableBytes(ByteStringvalue)Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for table to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | This builder for chaining. |
setTransaction(TransactionSelector value)
publicPartitionReadRequest.BuildersetTransaction(TransactionSelectorvalue)Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Parameter | |
|---|---|
| Name | Description |
value | TransactionSelector |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setTransaction(TransactionSelector.Builder builderForValue)
publicPartitionReadRequest.BuildersetTransaction(TransactionSelector.BuilderbuilderForValue)Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | TransactionSelector.Builder |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalPartitionReadRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PartitionReadRequest.Builder | |
