Class: Google::Apis::SpannerV1::PartitionOptions

Inherits:

Object

• Object
• Google::Apis::SpannerV1::PartitionOptions

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb

Overview

Options for a PartitionQueryRequest and PartitionReadRequest.

Instance Attribute Summary

• #max_partitions ⇒ Fixnum

  Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

• #partition_size_bytes ⇒ Fixnum

  Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

Instance Method Summary

• #initialize(**args) ⇒ PartitionOptions constructor

  A new instance of PartitionOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PartitionOptions

Returns a new instance of PartitionOptions

# File 'generated/google/apis/spanner_v1/classes.rb', line 1878

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#max_partitions ⇒ Fixnum

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. Corresponds to the JSON property maxPartitions

Returns:

• (Fixnum)

# File 'generated/google/apis/spanner_v1/classes.rb', line 1867

def max_partitions
  @max_partitions
end

#partition_size_bytes ⇒ Fixnum

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. Corresponds to the JSON property partitionSizeBytes

Returns:

• (Fixnum)

# File 'generated/google/apis/spanner_v1/classes.rb', line 1876

def partition_size_bytes
  @partition_size_bytes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/spanner_v1/classes.rb', line 1883

def update!(**args)
  @max_partitions = args[:max_partitions] if args.key?(:max_partitions)
  @partition_size_bytes = args[:partition_size_bytes] if args.key?(:partition_size_bytes)
end