# Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Advice::Rest::Client (v3.7.0)

3.7.0 (latest) 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.22.0 2.21.1 2.20.0 2.19.1 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.2 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.10.0 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.5.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.


<br />

The Advice API.

## Inherits

- Object

## Methods

### .configure

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

Configure the Advice Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client-Configuration "Google::Cloud::Compute::V1::Advice::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client-Configuration))
**Example**

```ruby
# 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-CalendarModeAdviceRpcRequest "Google::Cloud::Compute::V1::CalendarModeAdviceRpcRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Compute::V1::CalendarModeAdviceRpcRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/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**

- **calendar_mode_advice_request_resource** ([::Google::Cloud::Compute::V1::CalendarModeAdviceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-CalendarModeAdviceRequest), ::Hash) --- The body resource for this request
- **project** (::String) --- Project ID for this request.
- **region** (::String) --- Name of the region for this request.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Compute::V1::CalendarModeAdviceResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-CalendarModeAdviceResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Compute::V1::CalendarModeAdviceResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-CalendarModeAdviceResponse))
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
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
```

### #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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client#Google__Cloud__Compute__V1__Advice__Rest__Client_configure_class_ "Google::Cloud::Compute::V1::Advice::Rest::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client-Configuration "Google::Cloud::Compute::V1::Advice::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client-Configuration))

### #initialize

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

Create a new Advice REST client object.
**Yields**

- (config) --- Configure the Advice client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Advice-Rest-Client)) --- a new instance of Client
**Example**

```ruby
# 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)