Class Google::Cloud::Compute::V1::RegionUrlMaps::Rest::Client (v0.5.0)

REST client for the RegionUrlMaps service.

The RegionUrlMaps API.

Inherits

Object

Methods

.configure

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

Configure the RegionUrlMaps Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all RegionUrlMaps clients
::Google::Cloud::Compute::V1::RegionUrlMaps::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

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

config (Client::Configuration)

Returns

(Client::Configuration)

#delete

def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
def delete(project: nil, region: nil, request_id: nil, url_map: nil) -> ::Gapic::Rest::BaseOperation

Deletes the specified UrlMap resource.

Overloads

def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation

Pass arguments to delete via a request object, either of type DeleteRegionUrlMapRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::DeleteRegionUrlMapRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def delete(project: nil, region: nil, request_id: nil, url_map: nil) -> ::Gapic::Rest::BaseOperation

Pass arguments to delete 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) — Project ID for this request.
region (::String) — Name of the region scoping this request.
request_id (::String) — begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
url_map (::String) — Name of the UrlMap resource to delete.

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Gapic::Rest::BaseOperation)
response (::Faraday::Response)

Returns

(::Gapic::Rest::BaseOperation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#get

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMap
def get(project: nil, region: nil, url_map: nil) -> ::Google::Cloud::Compute::V1::UrlMap

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Overloads

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMap

Pass arguments to get via a request object, either of type GetRegionUrlMapRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::GetRegionUrlMapRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def get(project: nil, region: nil, url_map: nil) -> ::Google::Cloud::Compute::V1::UrlMap

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) — Project ID for this request.
region (::String) — Name of the region scoping this request.
url_map (::String) — Name of the UrlMap resource to return.

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Google::Cloud::Compute::V1::UrlMap)
response (::Faraday::Response)

Returns

(::Google::Cloud::Compute::V1::UrlMap)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#initialize

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

Create a new RegionUrlMaps REST client object.

Yields

(config) — Configure the RegionUrlMaps client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::RegionUrlMaps::Rest::Client.new

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

#insert

def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
def insert(project: nil, region: nil, request_id: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation

Creates a UrlMap resource in the specified project using the data included in the request.

Overloads

def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation

Pass arguments to insert via a request object, either of type InsertRegionUrlMapRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::InsertRegionUrlMapRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def insert(project: nil, region: nil, request_id: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation

Pass arguments to insert 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) — Project ID for this request.
region (::String) — Name of the region scoping this request.
request_id (::String) — begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
url_map_resource (::Google::Cloud::Compute::V1::UrlMap, ::Hash) — The body resource for this request

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Gapic::Rest::BaseOperation)
response (::Faraday::Response)

Returns

(::Gapic::Rest::BaseOperation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#list

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>

Retrieves the list of UrlMap resources available to the specified project in the specified region.

Overloads

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>

Pass arguments to list via a request object, either of type ListRegionUrlMapsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::ListRegionUrlMapsRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>

Pass arguments to list 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

filter (::String) — A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
max_results (::Integer) — The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
order_by (::String) — Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
page_token (::String) — Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
project (::String) — Project ID for this request.
region (::String) — Name of the region scoping this request.
return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>)
response (::Faraday::Response)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#patch

def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch(project: nil, region: nil, request_id: nil, url_map: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Overloads

def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation

Pass arguments to patch via a request object, either of type PatchRegionUrlMapRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::PatchRegionUrlMapRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def patch(project: nil, region: nil, request_id: nil, url_map: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation

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

project (::String) — Project ID for this request.
region (::String) — Name of the region scoping this request.
request_id (::String) — begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
url_map (::String) — Name of the UrlMap resource to patch.
url_map_resource (::Google::Cloud::Compute::V1::UrlMap, ::Hash) — The body resource for this request

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Gapic::Rest::BaseOperation)
response (::Faraday::Response)

Returns

(::Gapic::Rest::BaseOperation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#update

def update(request, options = nil) -> ::Gapic::Rest::BaseOperation
def update(project: nil, region: nil, request_id: nil, url_map: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation

Updates the specified UrlMap resource with the data included in the request.

Overloads

def update(request, options = nil) -> ::Gapic::Rest::BaseOperation

Pass arguments to update via a request object, either of type UpdateRegionUrlMapRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::UpdateRegionUrlMapRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def update(project: nil, region: nil, request_id: nil, url_map: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation

Pass arguments to update 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) — Project ID for this request.
region (::String) — Name of the region scoping this request.
request_id (::String) — begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
url_map (::String) — Name of the UrlMap resource to update.
url_map_resource (::Google::Cloud::Compute::V1::UrlMap, ::Hash) — The body resource for this request

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Gapic::Rest::BaseOperation)
response (::Faraday::Response)

Returns

(::Gapic::Rest::BaseOperation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#validate

def validate(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMapsValidateResponse
def validate(project: nil, region: nil, region_url_maps_validate_request_resource: nil, url_map: nil) -> ::Google::Cloud::Compute::V1::UrlMapsValidateResponse

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Overloads

def validate(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMapsValidateResponse

Pass arguments to validate via a request object, either of type ValidateRegionUrlMapRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::ValidateRegionUrlMapRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def validate(project: nil, region: nil, region_url_maps_validate_request_resource: nil, url_map: nil) -> ::Google::Cloud::Compute::V1::UrlMapsValidateResponse

Pass arguments to validate 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) — Project ID for this request.
region (::String) — Name of the region scoping this request.
region_url_maps_validate_request_resource (::Google::Cloud::Compute::V1::RegionUrlMapsValidateRequest, ::Hash) — The body resource for this request
url_map (::String) — Name of the UrlMap resource to be validated as.

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Google::Cloud::Compute::V1::UrlMapsValidateResponse)
response (::Faraday::Response)

Returns

(::Google::Cloud::Compute::V1::UrlMapsValidateResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.