Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client (v2.9.0)

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

REST client for the ImageFamilyViews service.

The ImageFamilyViews API.

Inherits

  • Object

Methods

.configure

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

Configure the ImageFamilyViews 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 ImageFamilyViews clients
::Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the ImageFamilyViews 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

#get

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::ImageFamilyView
def get(family: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::ImageFamilyView

Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.

Overloads 
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::ImageFamilyView
Pass arguments to get via a request object, either of type GetImageFamilyViewRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetImageFamilyViewRequest, ::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 get(family: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::ImageFamilyView
Pass arguments to get 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
  • family (::String) — Name of the image family to search for.
  • project (::String) — Project ID for this request.
  • zone (::String) — The name of the zone for this request.
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::ImageFamilyViews::Rest::Client.new

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

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

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

#initialize

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

Create a new ImageFamilyViews REST client object.

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

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)