Package com.google.spanner.v1

Class PartitionReadRequest.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • clear

        public PartitionReadRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • getDefaultInstanceForType

        public PartitionReadRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public PartitionReadRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public PartitionReadRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public PartitionReadRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • setField

        public PartitionReadRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • clearField

        public PartitionReadRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • clearOneof

        public PartitionReadRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • setRepeatedField

        public PartitionReadRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • addRepeatedField

        public PartitionReadRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • mergeFrom

        public PartitionReadRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartitionReadRequest.Builder>
        Throws:
        IOException

      • getSession

        public String getSession()
         Required. The session used to create the partitions.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSession in interface PartitionReadRequestOrBuilder
        Returns:
        The session.

      • getSessionBytes

        public com.google.protobuf.ByteString getSessionBytes()
         Required. The session used to create the partitions.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSessionBytes in interface PartitionReadRequestOrBuilder
        Returns:
        The bytes for session.

      • setSession

        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) = { ... }
        Parameters:
        value - The session to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setSessionBytes

        public PartitionReadRequest.Builder setSessionBytes​(com.google.protobuf.ByteString value)
         Required. The session used to create the partitions.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for session to set.
        Returns:
        This builder for chaining.

      • hasTransaction

        public boolean hasTransaction()
         Read only snapshot transactions are supported, read/write and single use
 transactions are not.
        .google.spanner.v1.TransactionSelector transaction = 2;
        Specified by:
        hasTransaction in interface PartitionReadRequestOrBuilder
        Returns:
        Whether the transaction field is set.

      • getTransaction

        public TransactionSelector getTransaction()
         Read only snapshot transactions are supported, read/write and single use
 transactions are not.
        .google.spanner.v1.TransactionSelector transaction = 2;
        Specified by:
        getTransaction in interface PartitionReadRequestOrBuilder
        Returns:
        The transaction.

      • setTransaction

        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;

      • mergeTransaction

        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;

      • 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;

      • 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;

      • getTable

        public String getTable()
         Required. The name of the table in the database to be read.
        string table = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTable in interface PartitionReadRequestOrBuilder
        Returns:
        The table.

      • getTableBytes

        public com.google.protobuf.ByteString getTableBytes()
         Required. The name of the table in the database to be read.
        string table = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTableBytes in interface PartitionReadRequestOrBuilder
        Returns:
        The bytes for table.

      • setTable

        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];
        Parameters:
        value - The table to set.
        Returns:
        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:
        This builder for chaining.

      • setTableBytes

        public PartitionReadRequest.Builder setTableBytes​(com.google.protobuf.ByteString value)
         Required. The name of the table in the database to be read.
        string table = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for table to set.
        Returns:
        This builder for chaining.

      • getIndex

        public String getIndex()
         If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is
 used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set]
 and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
        string index = 4;
        Specified by:
        getIndex in interface PartitionReadRequestOrBuilder
        Returns:
        The index.

      • getIndexBytes

        public com.google.protobuf.ByteString getIndexBytes()
         If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is
 used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set]
 and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
        string index = 4;
        Specified by:
        getIndexBytes in interface PartitionReadRequestOrBuilder
        Returns:
        The bytes for index.

      • setIndex

        public PartitionReadRequest.Builder setIndex​(String value)
         If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is
 used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set]
 and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
        string index = 4;
        Parameters:
        value - The index to set.
        Returns:
        This builder for chaining.

      • clearIndex

        public PartitionReadRequest.Builder clearIndex()
         If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is
 used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set]
 and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
        string index = 4;
        Returns:
        This builder for chaining.

      • setIndexBytes

        public PartitionReadRequest.Builder setIndexBytes​(com.google.protobuf.ByteString value)
         If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is
 used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set]
 and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
        string index = 4;
        Parameters:
        value - The bytes for index to set.
        Returns:
        This builder for chaining.

      • getColumnsList

        public com.google.protobuf.ProtocolStringList getColumnsList()
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Specified by:
        getColumnsList in interface PartitionReadRequestOrBuilder
        Returns:
        A list containing the columns.

      • getColumnsCount

        public int getColumnsCount()
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Specified by:
        getColumnsCount in interface PartitionReadRequestOrBuilder
        Returns:
        The count of columns.

      • getColumns

        public String getColumns​(int index)
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Specified by:
        getColumns in interface PartitionReadRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The columns at the given index.

      • getColumnsBytes

        public com.google.protobuf.ByteString getColumnsBytes​(int index)
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Specified by:
        getColumnsBytes in interface PartitionReadRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the columns at the given index.

      • setColumns

        public PartitionReadRequest.Builder setColumns​(int index,
                                               String value)
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Parameters:
        index - The index to set the value at.
        value - The columns to set.
        Returns:
        This builder for chaining.

      • addColumns

        public PartitionReadRequest.Builder addColumns​(String value)
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Parameters:
        value - The columns to add.
        Returns:
        This builder for chaining.

      • addAllColumns

        public PartitionReadRequest.Builder addAllColumns​(Iterable<String> values)
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Parameters:
        values - The columns to add.
        Returns:
        This builder for chaining.

      • clearColumns

        public PartitionReadRequest.Builder clearColumns()
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Returns:
        This builder for chaining.

      • addColumnsBytes

        public PartitionReadRequest.Builder addColumnsBytes​(com.google.protobuf.ByteString value)
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        Parameters:
        value - The bytes of the columns to add.
        Returns:
        This builder for chaining.

      • hasKeySet

        public boolean hasKeySet()
         Required. `key_set` identifies the rows to be yielded. `key_set` names the
 primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];
        Specified by:
        hasKeySet in interface PartitionReadRequestOrBuilder
        Returns:
        Whether the keySet field is set.

      • getKeySet

        public KeySet getKeySet()
         Required. `key_set` identifies the rows to be yielded. `key_set` names the
 primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];
        Specified by:
        getKeySet in interface PartitionReadRequestOrBuilder
        Returns:
        The keySet.

      • setKeySet

        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][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];

      • setKeySet

        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][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];

      • mergeKeySet

        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][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];

      • 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][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];

      • 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][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];

      • getKeySetOrBuilder

        public KeySetOrBuilder getKeySetOrBuilder()
         Required. `key_set` identifies the rows to be yielded. `key_set` names the
 primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index]
 is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
 index keys in [index][google.spanner.v1.PartitionReadRequest.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];
        Specified by:
        getKeySetOrBuilder in interface PartitionReadRequestOrBuilder

      • hasPartitionOptions

        public boolean hasPartitionOptions()
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;
        Specified by:
        hasPartitionOptions in interface PartitionReadRequestOrBuilder
        Returns:
        Whether the partitionOptions field is set.

      • setPartitionOptions

        public PartitionReadRequest.Builder setPartitionOptions​(PartitionOptions value)
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;

      • mergePartitionOptions

        public PartitionReadRequest.Builder mergePartitionOptions​(PartitionOptions value)
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;

      • clearPartitionOptions

        public PartitionReadRequest.Builder clearPartitionOptions()
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;

      • getPartitionOptionsBuilder

        public PartitionOptions.Builder getPartitionOptionsBuilder()
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;

      • setUnknownFields

        public final PartitionReadRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

      • mergeUnknownFields

        public final PartitionReadRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>