Class: Google::Apis::ComputeAlpha::BackendCustomMetric

Inherits:

Object

• Object
• Google::Apis::ComputeAlpha::BackendCustomMetric

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

Custom Metrics are used for CUSTOM_METRICS balancing_mode.

Instance Attribute Summary

• #dry_run ⇒ Boolean (also: #dry_run?)

  If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.

• #max_utilization ⇒ Float

  Optional parameter to define a target utilization for the Custom Metrics balancing mode.

• #name ⇒ String

  Name of a custom utilization signal.

Instance Method Summary

• #initialize(**args) ⇒ BackendCustomMetric constructor

  A new instance of BackendCustomMetric.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ BackendCustomMetric

Returns a new instance of BackendCustomMetric.

# File 'lib/google/apis/compute_alpha/classes.rb', line 3798

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

Instance Attribute Details

#dry_run ⇒ Boolean Also known as: dry_run?

If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. Corresponds to the JSON property dryRun

Returns:

• (Boolean)

# File 'lib/google/apis/compute_alpha/classes.rb', line 3777

def dry_run
  @dry_run
end

#max_utilization ⇒ Float

Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. Corresponds to the JSON property maxUtilization

Returns:

• (Float)

# File 'lib/google/apis/compute_alpha/classes.rb', line 3784

def max_utilization
  @max_utilization
end

#name ⇒ String

Name of a custom utilization signal. The name must be 1-24 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. Corresponds to the JSON property name

Returns:

• (String)

# File 'lib/google/apis/compute_alpha/classes.rb', line 3796

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/compute_alpha/classes.rb', line 3803

def update!(**args)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @max_utilization = args[:max_utilization] if args.key?(:max_utilization)
  @name = args[:name] if args.key?(:name)
end