REST client for the BackendServices service.
The BackendServices API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the BackendServices Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all BackendServices clients ::Google::Cloud::Compute::V1::BackendServices::Rest::Client.configure do |config| config.timeout = 10.0 end
#add_signed_url_key
def add_signed_url_key(request, options = nil) -> ::Gapic::Rest::BaseOperation
def add_signed_url_key(backend_service: nil, project: nil, request_id: nil, signed_url_key_resource: nil) -> ::Gapic::Rest::BaseOperation
Adds a key for validating requests with signed URLs for this backend service.
def add_signed_url_key(request, options = nil) -> ::Gapic::Rest::BaseOperation
add_signed_url_key
via a request object, either of type
AddSignedUrlKeyBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AddSignedUrlKeyBackendServiceRequest, ::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 add_signed_url_key(backend_service: nil, project: nil, request_id: nil, signed_url_key_resource: nil) -> ::Gapic::Rest::BaseOperation
add_signed_url_key
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).
- backend_service (::String) — Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
- 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).
- signed_url_key_resource (::Google::Cloud::Compute::V1::SignedUrlKey, ::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.
#aggregated_list
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList>
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::BackendServicesScopedList>
Retrieves the list of all BackendService resources, regional and global, available to the specified project.
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList>
aggregated_list
via a request object, either of type
AggregatedListBackendServicesRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AggregatedListBackendServicesRequest, ::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::BackendServicesScopedList>
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::BackendServicesScopedList>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the BackendServices 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(backend_service: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Deletes the specified BackendService resource.
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
delete
via a request object, either of type
DeleteBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteBackendServiceRequest, ::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(backend_service: nil, project: nil, request_id: 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).
- backend_service (::String) — Name of the BackendService resource to delete.
- 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).
- (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.
#delete_signed_url_key
def delete_signed_url_key(request, options = nil) -> ::Gapic::Rest::BaseOperation
def delete_signed_url_key(backend_service: nil, key_name: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Deletes a key for validating requests with signed URLs for this backend service.
def delete_signed_url_key(request, options = nil) -> ::Gapic::Rest::BaseOperation
delete_signed_url_key
via a request object, either of type
DeleteSignedUrlKeyBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteSignedUrlKeyBackendServiceRequest, ::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_signed_url_key(backend_service: nil, key_name: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
delete_signed_url_key
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).
- backend_service (::String) — Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
- key_name (::String) — The name of the Signed URL Key to delete.
- 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).
- (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::BackendService
def get(backend_service: nil, project: nil) -> ::Google::Cloud::Compute::V1::BackendService
Returns the specified BackendService resource. Gets a list of available backend services.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendService
get
via a request object, either of type
GetBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetBackendServiceRequest, ::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(backend_service: nil, project: nil) -> ::Google::Cloud::Compute::V1::BackendService
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).
- backend_service (::String) — Name of the BackendService resource to return.
- project (::String) — Project ID for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::BackendService)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_health
def get_health(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
def get_health(backend_service: nil, project: nil, resource_group_reference_resource: nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }
def get_health(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
get_health
via a request object, either of type
GetHealthBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetHealthBackendServiceRequest, ::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_health(backend_service: nil, project: nil, resource_group_reference_resource: nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
get_health
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).
- backend_service (::String) — Name of the BackendService resource to which the queried instance belongs.
- project (::String)
- resource_group_reference_resource (::Google::Cloud::Compute::V1::ResourceGroupReference, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::BackendServiceGroupHealth)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new BackendServices REST client object.
- (config) — Configure the BackendServices client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::BackendServices::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::BackendServices::Rest::Client.new do |config| config.timeout = 10.0 end
#insert
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
def insert(backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
insert
via a request object, either of type
InsertBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InsertBackendServiceRequest, ::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(backend_service_resource: nil, project: nil, request_id: 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).
- backend_service_resource (::Google::Cloud::Compute::V1::BackendService, ::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).
- (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::BackendService>
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::BackendService>
Retrieves the list of BackendService resources available to the specified project.
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
list
via a request object, either of type
ListBackendServicesRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListBackendServicesRequest, ::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::BackendService>
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::BackendService>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#patch
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch(backend_service: nil, backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. 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
PatchBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::PatchBackendServiceRequest, ::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(backend_service: nil, backend_service_resource: nil, project: nil, request_id: 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).
- backend_service (::String) — Name of the BackendService resource to patch.
- backend_service_resource (::Google::Cloud::Compute::V1::BackendService, ::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).
- (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.
#set_edge_security_policy
def set_edge_security_policy(request, options = nil) -> ::Gapic::Rest::BaseOperation
def set_edge_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::Rest::BaseOperation
Sets the edge security policy for the specified backend service.
def set_edge_security_policy(request, options = nil) -> ::Gapic::Rest::BaseOperation
set_edge_security_policy
via a request object, either of type
SetEdgeSecurityPolicyBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetEdgeSecurityPolicyBackendServiceRequest, ::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 set_edge_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::Rest::BaseOperation
set_edge_security_policy
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).
- backend_service (::String) — Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.
- 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).
- security_policy_reference_resource (::Google::Cloud::Compute::V1::SecurityPolicyReference, ::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.
#set_security_policy
def set_security_policy(request, options = nil) -> ::Gapic::Rest::BaseOperation
def set_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::Rest::BaseOperation
Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview
def set_security_policy(request, options = nil) -> ::Gapic::Rest::BaseOperation
set_security_policy
via a request object, either of type
SetSecurityPolicyBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetSecurityPolicyBackendServiceRequest, ::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 set_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::Rest::BaseOperation
set_security_policy
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).
- backend_service (::String) — Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
- 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).
- security_policy_reference_resource (::Google::Cloud::Compute::V1::SecurityPolicyReference, ::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(backend_service: nil, backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.
def update(request, options = nil) -> ::Gapic::Rest::BaseOperation
update
via a request object, either of type
UpdateBackendServiceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateBackendServiceRequest, ::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(backend_service: nil, backend_service_resource: nil, project: nil, request_id: 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).
- backend_service (::String) — Name of the BackendService resource to update.
- backend_service_resource (::Google::Cloud::Compute::V1::BackendService, ::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).
- (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.