Class PartitionOptions.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PartitionOptionsOrBuilder, Cloneable
    Enclosing class:
    PartitionOptions

    public static final class PartitionOptions.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<PartitionOptions.Builder>
    implements PartitionOptionsOrBuilder
     Options for a PartitionQueryRequest and
     PartitionReadRequest.
     
    Protobuf type google.spanner.v1.PartitionOptions
    • 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<PartitionOptions.Builder>
      • clear

        public PartitionOptions.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<PartitionOptions.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<PartitionOptions.Builder>
      • getDefaultInstanceForType

        public PartitionOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public PartitionOptions.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<PartitionOptions.Builder>
      • setField

        public PartitionOptions.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<PartitionOptions.Builder>
      • clearField

        public PartitionOptions.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<PartitionOptions.Builder>
      • clearOneof

        public PartitionOptions.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<PartitionOptions.Builder>
      • setRepeatedField

        public PartitionOptions.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<PartitionOptions.Builder>
      • addRepeatedField

        public PartitionOptions.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<PartitionOptions.Builder>
      • mergeFrom

        public PartitionOptions.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartitionOptions.Builder>
      • isInitialized

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

        public PartitionOptions.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<PartitionOptions.Builder>
        Throws:
        IOException
      • getPartitionSizeBytes

        public long getPartitionSizeBytes()
         **Note:** This hint is currently ignored by PartitionQuery and
         PartitionRead requests.
        
         The desired data size for each partition generated.  The default for this
         option is currently 1 GiB.  This is only a hint. The actual size of each
         partition may be smaller or larger than this size request.
         
        int64 partition_size_bytes = 1;
        Specified by:
        getPartitionSizeBytes in interface PartitionOptionsOrBuilder
        Returns:
        The partitionSizeBytes.
      • setPartitionSizeBytes

        public PartitionOptions.Builder setPartitionSizeBytes​(long value)
         **Note:** This hint is currently ignored by PartitionQuery and
         PartitionRead requests.
        
         The desired data size for each partition generated.  The default for this
         option is currently 1 GiB.  This is only a hint. The actual size of each
         partition may be smaller or larger than this size request.
         
        int64 partition_size_bytes = 1;
        Parameters:
        value - The partitionSizeBytes to set.
        Returns:
        This builder for chaining.
      • clearPartitionSizeBytes

        public PartitionOptions.Builder clearPartitionSizeBytes()
         **Note:** This hint is currently ignored by PartitionQuery and
         PartitionRead requests.
        
         The desired data size for each partition generated.  The default for this
         option is currently 1 GiB.  This is only a hint. The actual size of each
         partition may be smaller or larger than this size request.
         
        int64 partition_size_bytes = 1;
        Returns:
        This builder for chaining.
      • getMaxPartitions

        public long getMaxPartitions()
         **Note:** This hint is currently ignored by PartitionQuery and
         PartitionRead requests.
        
         The desired maximum number of partitions to return.  For example, this may
         be set to the number of workers available.  The default for this option
         is currently 10,000. The maximum value is currently 200,000.  This is only
         a hint.  The actual number of partitions returned may be smaller or larger
         than this maximum count request.
         
        int64 max_partitions = 2;
        Specified by:
        getMaxPartitions in interface PartitionOptionsOrBuilder
        Returns:
        The maxPartitions.
      • setMaxPartitions

        public PartitionOptions.Builder setMaxPartitions​(long value)
         **Note:** This hint is currently ignored by PartitionQuery and
         PartitionRead requests.
        
         The desired maximum number of partitions to return.  For example, this may
         be set to the number of workers available.  The default for this option
         is currently 10,000. The maximum value is currently 200,000.  This is only
         a hint.  The actual number of partitions returned may be smaller or larger
         than this maximum count request.
         
        int64 max_partitions = 2;
        Parameters:
        value - The maxPartitions to set.
        Returns:
        This builder for chaining.
      • clearMaxPartitions

        public PartitionOptions.Builder clearMaxPartitions()
         **Note:** This hint is currently ignored by PartitionQuery and
         PartitionRead requests.
        
         The desired maximum number of partitions to return.  For example, this may
         be set to the number of workers available.  The default for this option
         is currently 10,000. The maximum value is currently 200,000.  This is only
         a hint.  The actual number of partitions returned may be smaller or larger
         than this maximum count request.
         
        int64 max_partitions = 2;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final PartitionOptions.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<PartitionOptions.Builder>
      • mergeUnknownFields

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