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

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

REST client for the ProjectViews service.

The ProjectViews API.

This client uses ProjectViews version 2026-09-01.

Inherits

  • Object

Methods

.configure

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

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

#configure

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

Configure the ProjectViews 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::ProjectView
def get(project: nil, region: nil) -> ::Google::Cloud::Compute::V1::ProjectView

Returns the specified global ProjectViews resource, with a regional context. This regional API endpoint reads resource metadata from regional read-only replicas. Because changes are copied to these regional replicas asynchronously, for real-time resource reads or any write operations (creating, updating, or deleting resources), use the global projects.get endpoint.

Overloads 
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::ProjectView
Pass arguments to get via a request object, either of type GetProjectViewRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetProjectViewRequest, ::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(project: nil, region: nil) -> ::Google::Cloud::Compute::V1::ProjectView
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
  • project (::String) — Required. Project ID for this request. This is part of the URL path.
  • region (::String) — Required. Name of the region for this request. This is part of the URL path.
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::ProjectViews::Rest::Client.new

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

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

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

#initialize

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

Create a new ProjectViews REST client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::Compute::V1::ProjectViews::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)