Class Google::Cloud::Compute::V1::BackendBuckets::Rest::Client (v1.2.0)

Stay organized with collections Save and categorize content based on your preferences.

REST client for the BackendBuckets service.

The BackendBuckets API.

Inherits

  • Object

Methods

.configure

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

Configure the BackendBuckets Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Example
# Modify the configuration for all BackendBuckets clients
::Google::Cloud::Compute::V1::BackendBuckets::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#add_signed_url_key

def add_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_signed_url_key(backend_bucket: nil, project: nil, request_id: nil, signed_url_key_resource: nil) -> ::Gapic::GenericLRO::Operation

Adds a key for validating requests with signed URLs for this backend bucket.

Overloads
def add_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to add_signed_url_key via a request object, either of type AddSignedUrlKeyBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::AddSignedUrlKeyBackendBucketRequest, ::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_bucket: nil, project: nil, request_id: nil, signed_url_key_resource: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to 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).
Parameters
  • backend_bucket (::String) — Name of the BackendBucket 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
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#configure

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

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

#delete

def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete(backend_bucket: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

Deletes the specified BackendBucket resource.

Overloads
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to delete via a request object, either of type DeleteBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::DeleteBackendBucketRequest, ::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_bucket: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
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
  • backend_bucket (::String) — Name of the BackendBucket 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).
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_signed_url_key

def delete_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete_signed_url_key(backend_bucket: nil, key_name: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

Deletes a key for validating requests with signed URLs for this backend bucket.

Overloads
def delete_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to delete_signed_url_key via a request object, either of type DeleteSignedUrlKeyBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::DeleteSignedUrlKeyBackendBucketRequest, ::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_bucket: nil, key_name: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to 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).
Parameters
  • backend_bucket (::String) — Name of the BackendBucket 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).
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get

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

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Overloads
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendBucket
Pass arguments to get via a request object, either of type GetBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetBackendBucketRequest, ::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_bucket: nil, project: nil) -> ::Google::Cloud::Compute::V1::BackendBucket
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
  • backend_bucket (::String) — Name of the BackendBucket resource to return.
  • project (::String) — Project ID for this request.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#global_operations

def global_operations() -> ::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client

Get the associated client for long-running operations via GlobalOperations.

#initialize

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

Create a new BackendBuckets REST client object.

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

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

#insert

def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def insert(backend_bucket_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

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

Overloads
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to insert via a request object, either of type InsertBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::InsertBackendBucketRequest, ::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_bucket_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
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
  • backend_bucket_resource (::Google::Cloud::Compute::V1::BackendBucket, ::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).
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendBucket>
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::BackendBucket>

Retrieves the list of BackendBucket resources available to the specified project.

Overloads
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendBucket>
Pass arguments to list via a request object, either of type ListBackendBucketsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::ListBackendBucketsRequest, ::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::BackendBucket>
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, 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 named example-instance by specifying name != 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 with owner label use: labels.owner:* 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.
  • 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
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#patch

def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
def patch(backend_bucket: nil, backend_bucket_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

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

Overloads
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to patch via a request object, either of type PatchBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::PatchBackendBucketRequest, ::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_bucket: nil, backend_bucket_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
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
  • backend_bucket (::String) — Name of the BackendBucket resource to patch.
  • backend_bucket_resource (::Google::Cloud::Compute::V1::BackendBucket, ::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).
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#set_edge_security_policy

def set_edge_security_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_edge_security_policy(backend_bucket: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::GenericLRO::Operation

Sets the edge security policy for the specified backend bucket.

Overloads
def set_edge_security_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to set_edge_security_policy via a request object, either of type SetEdgeSecurityPolicyBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::SetEdgeSecurityPolicyBackendBucketRequest, ::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_bucket: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to 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).
Parameters
  • backend_bucket (::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
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update

def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update(backend_bucket: nil, backend_bucket_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

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

Overloads
def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to update via a request object, either of type UpdateBackendBucketRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::UpdateBackendBucketRequest, ::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_bucket: nil, backend_bucket_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
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
  • backend_bucket (::String) — Name of the BackendBucket resource to update.
  • backend_bucket_resource (::Google::Cloud::Compute::V1::BackendBucket, ::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).
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.