Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Advice::Rest::Client (v4.0.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Advice::Rest::Client.

REST client for the Advice service.

The Advice API.

This client uses Advice version 2026-09-01.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Advice Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Advice clients
::Google::Cloud::Compute::V1::Advice::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#calendar_mode

def calendar_mode(request, options = nil) -> ::Google::Cloud::Compute::V1::CalendarModeAdviceResponse
def calendar_mode(calendar_mode_advice_request_resource: nil, project: nil, region: nil) -> ::Google::Cloud::Compute::V1::CalendarModeAdviceResponse

Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method recommends creating future reservations for the requested resources.

Overloads 
def calendar_mode(request, options = nil) -> ::Google::Cloud::Compute::V1::CalendarModeAdviceResponse
Pass arguments to calendar_mode via a request object, either of type CalendarModeAdviceRpcRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::CalendarModeAdviceRpcRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def calendar_mode(calendar_mode_advice_request_resource: nil, project: nil, region: nil) -> ::Google::Cloud::Compute::V1::CalendarModeAdviceResponse
Pass arguments to calendar_mode via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::Advice::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::CalendarModeAdviceRpcRequest.new

# Call the calendar_mode method.
result = client.calendar_mode request

# The returned object is of type Google::Cloud::Compute::V1::CalendarModeAdviceResponse.
p result

#capacity

def capacity(request, options = nil) -> ::Google::Cloud::Compute::V1::CapacityAdviceResponse
def capacity(capacity_advice_request_resource: nil, project: nil, region: nil) -> ::Google::Cloud::Compute::V1::CapacityAdviceResponse

Advice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity.

Overloads 
def capacity(request, options = nil) -> ::Google::Cloud::Compute::V1::CapacityAdviceResponse
Pass arguments to capacity via a request object, either of type CapacityAdviceRpcRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::CapacityAdviceRpcRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def capacity(capacity_advice_request_resource: nil, project: nil, region: nil) -> ::Google::Cloud::Compute::V1::CapacityAdviceResponse
Pass arguments to capacity via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::Advice::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::CapacityAdviceRpcRequest.new

# Call the capacity method.
result = client.capacity request

# The returned object is of type Google::Cloud::Compute::V1::CapacityAdviceResponse.
p result

#capacity_history

def capacity_history(request, options = nil) -> ::Google::Cloud::Compute::V1::CapacityHistoryResponse
def capacity_history(capacity_history_request_resource: nil, project: nil, region: nil) -> ::Google::Cloud::Compute::V1::CapacityHistoryResponse

Gets the capacity history.

Overloads 
def capacity_history(request, options = nil) -> ::Google::Cloud::Compute::V1::CapacityHistoryResponse
Pass arguments to capacity_history via a request object, either of type CapacityHistoryAdviceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::CapacityHistoryAdviceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def capacity_history(capacity_history_request_resource: nil, project: nil, region: nil) -> ::Google::Cloud::Compute::V1::CapacityHistoryResponse
Pass arguments to capacity_history via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::Advice::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::CapacityHistoryAdviceRequest.new

# Call the capacity_history method.
result = client.capacity_history request

# The returned object is of type Google::Cloud::Compute::V1::CapacityHistoryResponse.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Advice Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new Advice REST client object.

Yields
  • (config) — Configure the Advice client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::Advice::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Compute::V1::Advice::Rest::Client.new do |config|
  config.timeout = 10.0
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)