Package com.google.spanner.v1

Class PartitionOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PartitionOptions.Builder>
com.google.spanner.v1.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.GeneratedMessage.Builder<PartitionOptions.Builder> implements PartitionOptionsOrBuilder
 Options for a `PartitionQueryRequest` and `PartitionReadRequest`.
Protobuf type google.spanner.v1.PartitionOptions

  • Method Summary

    Modifier and Type
    Method
    Description
    PartitionOptions
    build()
     
    PartitionOptions
    buildPartial()
     
    PartitionOptions.Builder
    clear()
     
    PartitionOptions.Builder
    clearMaxPartitions()
    **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests.
    PartitionOptions.Builder
    clearPartitionSizeBytes()
    **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests.
    PartitionOptions
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    long
    getMaxPartitions()
    **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests.
    long
    getPartitionSizeBytes()
    **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    PartitionOptions.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    PartitionOptions.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    PartitionOptions.Builder
    mergeFrom(PartitionOptions other)
     
    PartitionOptions.Builder
    setMaxPartitions(long value)
    **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests.
    PartitionOptions.Builder
    setPartitionSizeBytes(long value)
    **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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

    • mergeFrom

      public PartitionOptions.Builder mergeFrom(PartitionOptions other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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 can 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 can 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 can 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
 might 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 can 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
 might 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 can 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
 might 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 can be smaller or
 larger than this maximum count request.
      int64 max_partitions = 2;
      Returns:
      This builder for chaining.