REST client for the UrlMaps service.
The UrlMaps API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the UrlMaps Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all UrlMaps clients ::Google::Cloud::Compute::V1::UrlMaps::Rest::Client.configure do |config| config.timeout = 10.0 end
#aggregated_list
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::UrlMapsScopedList>
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::UrlMapsScopedList>
Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::UrlMapsScopedList>
aggregated_list
via a request object, either of type
AggregatedListUrlMapsRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AggregatedListUrlMapsRequest, ::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 aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::UrlMapsScopedList>
aggregated_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).
-
filter (::String) — A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either
=
,!=
,>
,<
,<=
,>=
or:
. For example, if you are filtering Compute Engine instances, you can exclude instances namedexample-instance
by specifyingname != example-instance
. The:
operator can be used with string fields to match substrings. For non-string fields it is equivalent to the=
operator. The:*
comparison can be used to test whether a key has been defined. For example, to find all objects withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
- include_all_scopes (::Boolean) — Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
-
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 anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, 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 thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. - project (::String) — Name of the project 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::UrlMapsScopedList>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::UrlMapsScopedList>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the UrlMaps 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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#delete
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
def delete(project: nil, request_id: nil, url_map: nil) -> ::Gapic::Rest::BaseOperation
Deletes the specified UrlMap resource.
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
delete
via a request object, either of type
DeleteUrlMapRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteUrlMapRequest, ::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, request_id: nil, url_map: nil) -> ::Gapic::Rest::BaseOperation
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).
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- url_map (::String) — Name of the UrlMap resource to delete.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMap
def get(project: 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.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMap
get
via a request object, either of type
GetUrlMapRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetUrlMapRequest, ::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, url_map: nil) -> ::Google::Cloud::Compute::V1::UrlMap
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).
- project (::String) — Project ID for this request.
- url_map (::String) — Name of the UrlMap resource to return.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::UrlMap)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new UrlMaps REST client object.
- (config) — Configure the UrlMaps client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::UrlMaps::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::UrlMaps::Rest::Client.new do |config| config.timeout = 10.0 end
#insert
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
def insert(project: 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.
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
insert
via a request object, either of type
InsertUrlMapRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InsertUrlMapRequest, ::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, request_id: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation
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).
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- url_map_resource (::Google::Cloud::Compute::V1::UrlMap, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#invalidate_cache
def invalidate_cache(request, options = nil) -> ::Gapic::Rest::BaseOperation
def invalidate_cache(cache_invalidation_rule_resource: nil, project: nil, request_id: nil, url_map: nil) -> ::Gapic::Rest::BaseOperation
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.
def invalidate_cache(request, options = nil) -> ::Gapic::Rest::BaseOperation
invalidate_cache
via a request object, either of type
InvalidateCacheUrlMapRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InvalidateCacheUrlMapRequest, ::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 invalidate_cache(cache_invalidation_rule_resource: nil, project: nil, request_id: nil, url_map: nil) -> ::Gapic::Rest::BaseOperation
invalidate_cache
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).
- cache_invalidation_rule_resource (::Google::Cloud::Compute::V1::CacheInvalidationRule, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- url_map (::String) — Name of the UrlMap scoping this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::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, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>
Retrieves the list of UrlMap resources available to the specified project.
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>
list
via a request object, either of type
ListUrlMapsRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListUrlMapsRequest, ::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, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>
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).
-
filter (::String) — A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either
=
,!=
,>
,<
,<=
,>=
or:
. For example, if you are filtering Compute Engine instances, you can exclude instances namedexample-instance
by specifyingname != example-instance
. The:
operator can be used with string fields to match substrings. For non-string fields it is equivalent to the=
operator. The:*
comparison can be used to test whether a key has been defined. For example, to find all objects withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
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 anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, 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 thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. - project (::String) — Project ID for 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UrlMap>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#patch
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch(project: 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 the JSON merge patch format and processing rules.
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
patch
via a request object, either of type
PatchUrlMapRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::PatchUrlMapRequest, ::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, request_id: nil, url_map: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation
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).
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- 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
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update
def update(request, options = nil) -> ::Gapic::Rest::BaseOperation
def update(project: 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.
def update(request, options = nil) -> ::Gapic::Rest::BaseOperation
update
via a request object, either of type
Google::Cloud::Compute::V1::UpdateUrlMapRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateUrlMapRequest, ::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, request_id: nil, url_map: nil, url_map_resource: nil) -> ::Gapic::Rest::BaseOperation
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).
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- 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
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#validate
def validate(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMapsValidateResponse
def validate(project: nil, url_map: nil, url_maps_validate_request_resource: 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.
def validate(request, options = nil) -> ::Google::Cloud::Compute::V1::UrlMapsValidateResponse
validate
via a request object, either of type
ValidateUrlMapRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ValidateUrlMapRequest, ::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, url_map: nil, url_maps_validate_request_resource: nil) -> ::Google::Cloud::Compute::V1::UrlMapsValidateResponse
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).
- project (::String) — Project ID for this request.
- url_map (::String) — Name of the UrlMap resource to be validated as.
- url_maps_validate_request_resource (::Google::Cloud::Compute::V1::UrlMapsValidateRequest, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::UrlMapsValidateResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.