Package com.google.spanner.v1

Class PartitionQueryRequest.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

      • internalGetFieldAccessorTable

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

      • clear

        public PartitionQueryRequest.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<PartitionQueryRequest.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<PartitionQueryRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public PartitionQueryRequest.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<PartitionQueryRequest.Builder>

      • clearField

        public PartitionQueryRequest.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<PartitionQueryRequest.Builder>

      • clearOneof

        public PartitionQueryRequest.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<PartitionQueryRequest.Builder>

      • setRepeatedField

        public PartitionQueryRequest.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<PartitionQueryRequest.Builder>

      • addRepeatedField

        public PartitionQueryRequest.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<PartitionQueryRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public PartitionQueryRequest.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<PartitionQueryRequest.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 PartitionQueryRequestOrBuilder
        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 PartitionQueryRequestOrBuilder
        Returns:
        The bytes for session.

      • setSession

        public PartitionQueryRequest.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 PartitionQueryRequest.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 PartitionQueryRequest.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 PartitionQueryRequestOrBuilder
        Returns:
        Whether the transaction field is set.

      • setTransaction

        public PartitionQueryRequest.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 PartitionQueryRequest.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 PartitionQueryRequest.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;

      • getSql

        public String getSql()
         Required. The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.

 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.
        string sql = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSql in interface PartitionQueryRequestOrBuilder
        Returns:
        The sql.

      • getSqlBytes

        public com.google.protobuf.ByteString getSqlBytes()
         Required. The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.

 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.
        string sql = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSqlBytes in interface PartitionQueryRequestOrBuilder
        Returns:
        The bytes for sql.

      • setSql

        public PartitionQueryRequest.Builder setSql​(String value)
         Required. The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.

 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.
        string sql = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The sql to set.
        Returns:
        This builder for chaining.

      • clearSql

        public PartitionQueryRequest.Builder clearSql()
         Required. The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.

 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.
        string sql = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setSqlBytes

        public PartitionQueryRequest.Builder setSqlBytes​(com.google.protobuf.ByteString value)
         Required. The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.

 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.
        string sql = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for sql to set.
        Returns:
        This builder for chaining.

      • hasParams

        public boolean hasParams()
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;
        Specified by:
        hasParams in interface PartitionQueryRequestOrBuilder
        Returns:
        Whether the params field is set.

      • getParams

        public com.google.protobuf.Struct getParams()
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;
        Specified by:
        getParams in interface PartitionQueryRequestOrBuilder
        Returns:
        The params.

      • setParams

        public PartitionQueryRequest.Builder setParams​(com.google.protobuf.Struct value)
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;

      • setParams

        public PartitionQueryRequest.Builder setParams​(com.google.protobuf.Struct.Builder builderForValue)
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;

      • mergeParams

        public PartitionQueryRequest.Builder mergeParams​(com.google.protobuf.Struct value)
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;

      • clearParams

        public PartitionQueryRequest.Builder clearParams()
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;

      • getParamsBuilder

        public com.google.protobuf.Struct.Builder getParamsBuilder()
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;

      • getParamsOrBuilder

        public com.google.protobuf.StructOrBuilder getParamsOrBuilder()
         Parameter names and values that bind to placeholders in the SQL string.

 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.

 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:

 `"WHERE id > @msg_id AND id < @msg_id + 100"`

 It is an error to execute a SQL statement with unbound parameters.
        .google.protobuf.Struct params = 4;
        Specified by:
        getParamsOrBuilder in interface PartitionQueryRequestOrBuilder

      • getParamTypesCount

        public int getParamTypesCount()
        Description copied from interface: PartitionQueryRequestOrBuilder
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;
        Specified by:
        getParamTypesCount in interface PartitionQueryRequestOrBuilder

      • containsParamTypes

        public boolean containsParamTypes​(String key)
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;
        Specified by:
        containsParamTypes in interface PartitionQueryRequestOrBuilder

      • getParamTypesMap

        public Map<String,​Type> getParamTypesMap()
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;
        Specified by:
        getParamTypesMap in interface PartitionQueryRequestOrBuilder

      • getParamTypesOrDefault

        public Type getParamTypesOrDefault​(String key,
                                   Type defaultValue)
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;
        Specified by:
        getParamTypesOrDefault in interface PartitionQueryRequestOrBuilder

      • getParamTypesOrThrow

        public Type getParamTypesOrThrow​(String key)
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;
        Specified by:
        getParamTypesOrThrow in interface PartitionQueryRequestOrBuilder

      • removeParamTypes

        public PartitionQueryRequest.Builder removeParamTypes​(String key)
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • getMutableParamTypes

        @Deprecated
public Map<String,​Type> getMutableParamTypes()
        Deprecated.
        Use alternate mutation accessors instead.

      • putParamTypes

        public PartitionQueryRequest.Builder putParamTypes​(String key,
                                                   Type value)
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • putAllParamTypes

        public PartitionQueryRequest.Builder putAllParamTypes​(Map<String,​Type> values)
         It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.

 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • hasPartitionOptions

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

      • setPartitionOptions

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

      • mergePartitionOptions

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

      • clearPartitionOptions

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

      • getPartitionOptionsBuilder

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

      • setUnknownFields

        public final PartitionQueryRequest.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<PartitionQueryRequest.Builder>

      • mergeUnknownFields

        public final PartitionQueryRequest.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<PartitionQueryRequest.Builder>