- 6.102.1 (latest)
- 6.102.0
- 6.101.1
- 6.100.0
- 6.99.0
- 6.98.1
- 6.97.1
- 6.96.1
- 6.95.1
- 6.94.0
- 6.93.0
- 6.89.0
- 6.88.0
- 6.87.0
- 6.86.0
- 6.85.0
- 6.83.0
- 6.82.0
- 6.80.1
- 6.79.0
- 6.77.0
- 6.74.1
- 6.72.0
- 6.71.0
- 6.69.0
- 6.68.0
- 6.66.0
- 6.65.1
- 6.62.0
- 6.60.0
- 6.58.0
- 6.57.0
- 6.56.0
- 6.55.0
- 6.54.0
- 6.53.0
- 6.52.1
- 6.51.0
- 6.50.1
- 6.49.0
- 6.25.1
- 6.24.0
- 6.23.4
- 6.22.0
- 6.21.2
- 6.20.0
- 6.19.1
- 6.18.0
- 6.17.4
- 6.14.1
public static final class PartitionReadRequest.Builder extends GeneratedMessageV3.Builder<PartitionReadRequest.Builder> implements PartitionReadRequestOrBuilderThe 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 | StringThe 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 | ByteStringThe 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 isn't an error for the key_set to name rows that don't
 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 | intThe 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 | intThe 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 isn't an error for the key_set to name rows that don't
 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 isn't an error for the key_set to name rows that don't
 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 isn't an error for the key_set to name rows that don't
 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 isn't an error for the key_set to name rows that don't
 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 | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PartitionReadRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
| input | CodedInputStream | 
| extensionRegistry | ExtensionRegistryLite | 
| Returns | |
|---|---|
| Type | Description | 
| PartitionReadRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description | 
| IOException | |
mergeFrom(Message other)
public PartitionReadRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
| other | Message | 
| Returns | |
|---|---|
| Type | Description | 
| PartitionReadRequest.Builder | |
mergeFrom(PartitionReadRequest other)
public PartitionReadRequest.Builder mergeFrom(PartitionReadRequest other)| Parameter | |
|---|---|
| Name | Description | 
| other | PartitionReadRequest | 
| Returns | |
|---|---|
| Type | Description | 
| PartitionReadRequest.Builder | |
mergeKeySet(KeySet value)
public PartitionReadRequest.Builder mergeKeySet(KeySet value) 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 isn't an error for the key_set to name rows that don't
 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)
public PartitionReadRequest.Builder mergePartitionOptions(PartitionOptions value)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)
public PartitionReadRequest.Builder mergeTransaction(TransactionSelector value)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)
public final PartitionReadRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| PartitionReadRequest.Builder | |
setColumns(int index, String value)
public PartitionReadRequest.Builder setColumns(int index, String value)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)
public PartitionReadRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| PartitionReadRequest.Builder | |
setIndex(String value)
public PartitionReadRequest.Builder setIndex(String value)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)
public PartitionReadRequest.Builder setIndexBytes(ByteString value)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)
public PartitionReadRequest.Builder setKeySet(KeySet value) 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 isn't an error for the key_set to name rows that don't
 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)
public PartitionReadRequest.Builder setKeySet(KeySet.Builder builderForValue) 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 isn't an error for the key_set to name rows that don't
 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)
public PartitionReadRequest.Builder setPartitionOptions(PartitionOptions value)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)
public PartitionReadRequest.Builder setPartitionOptions(PartitionOptions.Builder builderForValue)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)
public PartitionReadRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| index | int | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| PartitionReadRequest.Builder | |
setSession(String value)
public PartitionReadRequest.Builder setSession(String value)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)
public PartitionReadRequest.Builder setSessionBytes(ByteString value)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)
public PartitionReadRequest.Builder setTable(String value)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)
public PartitionReadRequest.Builder setTableBytes(ByteString value)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)
public PartitionReadRequest.Builder setTransaction(TransactionSelector value)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)
public PartitionReadRequest.Builder setTransaction(TransactionSelector.Builder builderForValue)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)
public final PartitionReadRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| PartitionReadRequest.Builder | |