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

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

REST client for the GlobalFrontendSettingsService service.

The GlobalFrontendSettings API.

This client uses GlobalFrontendSettingsService version 2026-09-01.

Inherits

  • Object

Methods

.configure

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

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

#configure

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

Configure the GlobalFrontendSettingsService 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::GlobalFrontendSettings
def get(project: nil) -> ::Google::Cloud::Compute::V1::GlobalFrontendSettings

Gets the Global Frontend Billing Bundle Settings for a project.

Overloads 
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::GlobalFrontendSettings
Pass arguments to get via a request object, either of type Google::Cloud::Compute::V1::GetGlobalFrontendSettingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetGlobalFrontendSettingRequest, ::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) -> ::Google::Cloud::Compute::V1::GlobalFrontendSettings
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).
Parameter
  • project (::String) — Required. Project ID 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::GlobalFrontendSettingsService::Rest::Client.new

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

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

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

#initialize

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

Create a new GlobalFrontendSettingsService REST client object.

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

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#patch

def patch(request, options = nil) -> ::Google::Cloud::Compute::V1::GlobalFrontendSettingsPatchResponse
def patch(global_frontend_settings_resource: nil, project: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::Compute::V1::GlobalFrontendSettingsPatchResponse

Updates the Global Frontend Billing Bundle Settings for a project.

Overloads 
def patch(request, options = nil) -> ::Google::Cloud::Compute::V1::GlobalFrontendSettingsPatchResponse
Pass arguments to patch via a request object, either of type PatchGlobalFrontendSettingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::PatchGlobalFrontendSettingRequest, ::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 patch(global_frontend_settings_resource: nil, project: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::Compute::V1::GlobalFrontendSettingsPatchResponse
Pass arguments to patch 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
  • global_frontend_settings_resource (::Google::Cloud::Compute::V1::GlobalFrontendSettings, ::Hash) — The body resource for this request
  • project (::String) — Required. Project ID for this request.
  • request_id (::String) — An optional request ID to identify requests.
  • update_mask (::String) — Field mask to support patch. E.g., "type".
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::GlobalFrontendSettingsService::Rest::Client.new

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

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

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)