Class: Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb

Overview

Autoscaling configuration for an instance.

Defined Under Namespace

Classes: AsymmetricAutoscalingOption, AutoscalingLimits, AutoscalingTargets

Instance Attribute Summary collapse

Instance Attribute Details

#asymmetric_autoscaling_options ⇒ ::Array<::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AsymmetricAutoscalingOption>

Returns Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other.

Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them.

Returns:

  • (::Array<::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AsymmetricAutoscalingOption>) —

    Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other.

    Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them.



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 236

class AutoscalingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The autoscaling limits for the instance. Users can define the minimum and
  # maximum compute capacity allocated to the instance, and the autoscaler will
  # only scale within that range. Users can either use nodes or processing
  # units to specify the limits, but should use the same unit to set both the
  # min_limit and max_limit.
  # @!attribute [rw] min_nodes
  #   @return [::Integer]
  #     Minimum number of nodes allocated to the instance. If set, this number
  #     should be greater than or equal to 1.
  # @!attribute [rw] min_processing_units
  #   @return [::Integer]
  #     Minimum number of processing units allocated to the instance. If set,
  #     this number should be multiples of 1000.
  # @!attribute [rw] max_nodes
  #   @return [::Integer]
  #     Maximum number of nodes allocated to the instance. If set, this number
  #     should be greater than or equal to min_nodes.
  # @!attribute [rw] max_processing_units
  #   @return [::Integer]
  #     Maximum number of processing units allocated to the instance. If set,
  #     this number should be multiples of 1000 and be greater than or equal to
  #     min_processing_units.
  class AutoscalingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The autoscaling targets for an instance.
  # @!attribute [rw] high_priority_cpu_utilization_percent
  #   @return [::Integer]
  #     Required. The target high priority cpu utilization percentage that the
  #     autoscaler should be trying to achieve for the instance. This number is
  #     on a scale from 0 (no utilization) to 100 (full utilization). The valid
  #     range is [10, 90] inclusive.
  # @!attribute [rw] storage_utilization_percent
  #   @return [::Integer]
  #     Required. The target storage utilization percentage that the autoscaler
  #     should be trying to achieve for the instance. This number is on a scale
  #     from 0 (no utilization) to 100 (full utilization). The valid range is
  #     [10, 100] inclusive.
  class AutoscalingTargets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # AsymmetricAutoscalingOption specifies the scaling of replicas identified by
  # the given selection.
  # @!attribute [rw] replica_selection
  #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaSelection]
  #     Required. Selects the replicas to which this AsymmetricAutoscalingOption
  #     applies. Only read-only replicas are supported.
  # @!attribute [rw] overrides
  #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AsymmetricAutoscalingOption::AutoscalingConfigOverrides]
  #     Optional. Overrides applied to the top-level autoscaling configuration
  #     for the selected replicas.
  class AsymmetricAutoscalingOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Overrides the top-level autoscaling configuration for the replicas
    # identified by `replica_selection`. All fields in this message are
    # optional. Any unspecified fields will use the corresponding values from
    # the top-level autoscaling configuration.
    # @!attribute [rw] autoscaling_limits
    #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AutoscalingLimits]
    #     Optional. If specified, overrides the min/max limit in the top-level
    #     autoscaling configuration for the selected replicas.
    # @!attribute [rw] autoscaling_target_high_priority_cpu_utilization_percent
    #   @return [::Integer]
    #     Optional. If specified, overrides the autoscaling target
    #     high_priority_cpu_utilization_percent in the top-level autoscaling
    #     configuration for the selected replicas.
    class AutoscalingConfigOverrides
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#autoscaling_limits ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AutoscalingLimits

Returns Required. Autoscaling limits for an instance.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 236

class AutoscalingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The autoscaling limits for the instance. Users can define the minimum and
  # maximum compute capacity allocated to the instance, and the autoscaler will
  # only scale within that range. Users can either use nodes or processing
  # units to specify the limits, but should use the same unit to set both the
  # min_limit and max_limit.
  # @!attribute [rw] min_nodes
  #   @return [::Integer]
  #     Minimum number of nodes allocated to the instance. If set, this number
  #     should be greater than or equal to 1.
  # @!attribute [rw] min_processing_units
  #   @return [::Integer]
  #     Minimum number of processing units allocated to the instance. If set,
  #     this number should be multiples of 1000.
  # @!attribute [rw] max_nodes
  #   @return [::Integer]
  #     Maximum number of nodes allocated to the instance. If set, this number
  #     should be greater than or equal to min_nodes.
  # @!attribute [rw] max_processing_units
  #   @return [::Integer]
  #     Maximum number of processing units allocated to the instance. If set,
  #     this number should be multiples of 1000 and be greater than or equal to
  #     min_processing_units.
  class AutoscalingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The autoscaling targets for an instance.
  # @!attribute [rw] high_priority_cpu_utilization_percent
  #   @return [::Integer]
  #     Required. The target high priority cpu utilization percentage that the
  #     autoscaler should be trying to achieve for the instance. This number is
  #     on a scale from 0 (no utilization) to 100 (full utilization). The valid
  #     range is [10, 90] inclusive.
  # @!attribute [rw] storage_utilization_percent
  #   @return [::Integer]
  #     Required. The target storage utilization percentage that the autoscaler
  #     should be trying to achieve for the instance. This number is on a scale
  #     from 0 (no utilization) to 100 (full utilization). The valid range is
  #     [10, 100] inclusive.
  class AutoscalingTargets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # AsymmetricAutoscalingOption specifies the scaling of replicas identified by
  # the given selection.
  # @!attribute [rw] replica_selection
  #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaSelection]
  #     Required. Selects the replicas to which this AsymmetricAutoscalingOption
  #     applies. Only read-only replicas are supported.
  # @!attribute [rw] overrides
  #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AsymmetricAutoscalingOption::AutoscalingConfigOverrides]
  #     Optional. Overrides applied to the top-level autoscaling configuration
  #     for the selected replicas.
  class AsymmetricAutoscalingOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Overrides the top-level autoscaling configuration for the replicas
    # identified by `replica_selection`. All fields in this message are
    # optional. Any unspecified fields will use the corresponding values from
    # the top-level autoscaling configuration.
    # @!attribute [rw] autoscaling_limits
    #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AutoscalingLimits]
    #     Optional. If specified, overrides the min/max limit in the top-level
    #     autoscaling configuration for the selected replicas.
    # @!attribute [rw] autoscaling_target_high_priority_cpu_utilization_percent
    #   @return [::Integer]
    #     Optional. If specified, overrides the autoscaling target
    #     high_priority_cpu_utilization_percent in the top-level autoscaling
    #     configuration for the selected replicas.
    class AutoscalingConfigOverrides
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#autoscaling_targets ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AutoscalingTargets

Returns Required. The autoscaling targets for an instance.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 236

class AutoscalingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The autoscaling limits for the instance. Users can define the minimum and
  # maximum compute capacity allocated to the instance, and the autoscaler will
  # only scale within that range. Users can either use nodes or processing
  # units to specify the limits, but should use the same unit to set both the
  # min_limit and max_limit.
  # @!attribute [rw] min_nodes
  #   @return [::Integer]
  #     Minimum number of nodes allocated to the instance. If set, this number
  #     should be greater than or equal to 1.
  # @!attribute [rw] min_processing_units
  #   @return [::Integer]
  #     Minimum number of processing units allocated to the instance. If set,
  #     this number should be multiples of 1000.
  # @!attribute [rw] max_nodes
  #   @return [::Integer]
  #     Maximum number of nodes allocated to the instance. If set, this number
  #     should be greater than or equal to min_nodes.
  # @!attribute [rw] max_processing_units
  #   @return [::Integer]
  #     Maximum number of processing units allocated to the instance. If set,
  #     this number should be multiples of 1000 and be greater than or equal to
  #     min_processing_units.
  class AutoscalingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The autoscaling targets for an instance.
  # @!attribute [rw] high_priority_cpu_utilization_percent
  #   @return [::Integer]
  #     Required. The target high priority cpu utilization percentage that the
  #     autoscaler should be trying to achieve for the instance. This number is
  #     on a scale from 0 (no utilization) to 100 (full utilization). The valid
  #     range is [10, 90] inclusive.
  # @!attribute [rw] storage_utilization_percent
  #   @return [::Integer]
  #     Required. The target storage utilization percentage that the autoscaler
  #     should be trying to achieve for the instance. This number is on a scale
  #     from 0 (no utilization) to 100 (full utilization). The valid range is
  #     [10, 100] inclusive.
  class AutoscalingTargets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # AsymmetricAutoscalingOption specifies the scaling of replicas identified by
  # the given selection.
  # @!attribute [rw] replica_selection
  #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaSelection]
  #     Required. Selects the replicas to which this AsymmetricAutoscalingOption
  #     applies. Only read-only replicas are supported.
  # @!attribute [rw] overrides
  #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AsymmetricAutoscalingOption::AutoscalingConfigOverrides]
  #     Optional. Overrides applied to the top-level autoscaling configuration
  #     for the selected replicas.
  class AsymmetricAutoscalingOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Overrides the top-level autoscaling configuration for the replicas
    # identified by `replica_selection`. All fields in this message are
    # optional. Any unspecified fields will use the corresponding values from
    # the top-level autoscaling configuration.
    # @!attribute [rw] autoscaling_limits
    #   @return [::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig::AutoscalingLimits]
    #     Optional. If specified, overrides the min/max limit in the top-level
    #     autoscaling configuration for the selected replicas.
    # @!attribute [rw] autoscaling_target_high_priority_cpu_utilization_percent
    #   @return [::Integer]
    #     Optional. If specified, overrides the autoscaling target
    #     high_priority_cpu_utilization_percent in the top-level autoscaling
    #     configuration for the selected replicas.
    class AutoscalingConfigOverrides
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end