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> 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 302

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.
  #
  #     Note: The following fields are mutually exclusive: `min_nodes`, `min_processing_units`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `min_processing_units`, `min_nodes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `max_nodes`, `max_processing_units`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `max_processing_units`, `max_nodes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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, 99] 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 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 302

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.
  #
  #     Note: The following fields are mutually exclusive: `min_nodes`, `min_processing_units`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `min_processing_units`, `min_nodes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `max_nodes`, `max_processing_units`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `max_processing_units`, `max_nodes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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, 99] 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 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 302

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.
  #
  #     Note: The following fields are mutually exclusive: `min_nodes`, `min_processing_units`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `min_processing_units`, `min_nodes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `max_nodes`, `max_processing_units`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!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.
  #
  #     Note: The following fields are mutually exclusive: `max_processing_units`, `max_nodes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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, 99] 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