lib/google/cloud/compute/v1/backend_buckets/rest/client.rb in google-cloud-compute-v1-2.5.0 vs lib/google/cloud/compute/v1/backend_buckets/rest/client.rb in google-cloud-compute-v1-2.6.0
- old
+ new
@@ -74,10 +74,15 @@
default_config.rpcs.get.timeout = 600.0
default_config.rpcs.get.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
}
+ default_config.rpcs.get_iam_policy.timeout = 600.0
+ default_config.rpcs.get_iam_policy.retry_policy = {
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
+ }
+
default_config.rpcs.insert.timeout = 600.0
default_config.rpcs.list.timeout = 600.0
default_config.rpcs.list.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
@@ -85,10 +90,14 @@
default_config.rpcs.patch.timeout = 600.0
default_config.rpcs.set_edge_security_policy.timeout = 600.0
+ default_config.rpcs.set_iam_policy.timeout = 600.0
+
+ default_config.rpcs.test_iam_permissions.timeout = 600.0
+
default_config.rpcs.update.timeout = 600.0
default_config
end
yield @configure if block_given?
@@ -524,10 +533,92 @@
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
+ # Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+ #
+ # @overload get_iam_policy(request, options = nil)
+ # Pass arguments to `get_iam_policy` via a request object, either of type
+ # {::Google::Cloud::Compute::V1::GetIamPolicyBackendBucketRequest} or an equivalent Hash.
+ #
+ # @param request [::Google::Cloud::Compute::V1::GetIamPolicyBackendBucketRequest, ::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.
+ # @param options [::Gapic::CallOptions, ::Hash]
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+ #
+ # @overload get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil)
+ # Pass arguments to `get_iam_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).
+ #
+ # @param options_requested_policy_version [::Integer]
+ # Requested IAM Policy version.
+ # @param project [::String]
+ # Project ID for this request.
+ # @param resource [::String]
+ # Name or id of the resource for this request.
+ # @yield [result, operation] Access the result along with the TransportOperation object
+ # @yieldparam result [::Google::Cloud::Compute::V1::Policy]
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
+ #
+ # @return [::Google::Cloud::Compute::V1::Policy]
+ #
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
+ #
+ # @example Basic example
+ # require "google/cloud/compute/v1"
+ #
+ # # Create a client object. The client can be reused for multiple calls.
+ # client = Google::Cloud::Compute::V1::BackendBuckets::Rest::Client.new
+ #
+ # # Create a request. To set request fields, pass in keyword arguments.
+ # request = Google::Cloud::Compute::V1::GetIamPolicyBackendBucketRequest.new
+ #
+ # # Call the get_iam_policy method.
+ # result = client.get_iam_policy request
+ #
+ # # The returned object is of type Google::Cloud::Compute::V1::Policy.
+ # p result
+ #
+ def get_iam_policy request, options = nil
+ raise ::ArgumentError, "request must be provided" if request.nil?
+
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetIamPolicyBackendBucketRequest
+
+ # Converts hash and nil to an options object
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+ # Customize the options with defaults
+ call_metadata = @config.rpcs.get_iam_policy.metadata.to_h
+
+ # Set x-goog-api-client and x-goog-user-project headers
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
+ gapic_version: ::Google::Cloud::Compute::V1::VERSION,
+ transports_version_send: [:rest]
+
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+ options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
+ metadata: call_metadata,
+ retry_policy: @config.rpcs.get_iam_policy.retry_policy
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
+ retry_policy: @config.retry_policy
+
+ @backend_buckets_stub.get_iam_policy request, options do |result, operation|
+ yield result, operation if block_given?
+ return result
+ end
+ rescue ::Gapic::Rest::Error => e
+ raise ::Google::Cloud::Error.from_error(e)
+ end
+
+ ##
# Creates a BackendBucket resource in the specified project using the data included in the request.
#
# @overload insert(request, options = nil)
# Pass arguments to `insert` via a request object, either of type
# {::Google::Cloud::Compute::V1::InsertBackendBucketRequest} or an equivalent Hash.
@@ -632,11 +723,11 @@
# 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).
#
# @param filter [::String]
- # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
+ # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
# @param 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`)
# @param 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.
# @param page_token [::String]
@@ -887,10 +978,174 @@
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
+ # Sets the access control policy on the specified resource. Replaces any existing policy.
+ #
+ # @overload set_iam_policy(request, options = nil)
+ # Pass arguments to `set_iam_policy` via a request object, either of type
+ # {::Google::Cloud::Compute::V1::SetIamPolicyBackendBucketRequest} or an equivalent Hash.
+ #
+ # @param request [::Google::Cloud::Compute::V1::SetIamPolicyBackendBucketRequest, ::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.
+ # @param options [::Gapic::CallOptions, ::Hash]
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+ #
+ # @overload set_iam_policy(global_set_policy_request_resource: nil, project: nil, resource: nil)
+ # Pass arguments to `set_iam_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).
+ #
+ # @param global_set_policy_request_resource [::Google::Cloud::Compute::V1::GlobalSetPolicyRequest, ::Hash]
+ # The body resource for this request
+ # @param project [::String]
+ # Project ID for this request.
+ # @param resource [::String]
+ # Name or id of the resource for this request.
+ # @yield [result, operation] Access the result along with the TransportOperation object
+ # @yieldparam result [::Google::Cloud::Compute::V1::Policy]
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
+ #
+ # @return [::Google::Cloud::Compute::V1::Policy]
+ #
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
+ #
+ # @example Basic example
+ # require "google/cloud/compute/v1"
+ #
+ # # Create a client object. The client can be reused for multiple calls.
+ # client = Google::Cloud::Compute::V1::BackendBuckets::Rest::Client.new
+ #
+ # # Create a request. To set request fields, pass in keyword arguments.
+ # request = Google::Cloud::Compute::V1::SetIamPolicyBackendBucketRequest.new
+ #
+ # # Call the set_iam_policy method.
+ # result = client.set_iam_policy request
+ #
+ # # The returned object is of type Google::Cloud::Compute::V1::Policy.
+ # p result
+ #
+ def set_iam_policy request, options = nil
+ raise ::ArgumentError, "request must be provided" if request.nil?
+
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetIamPolicyBackendBucketRequest
+
+ # Converts hash and nil to an options object
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+ # Customize the options with defaults
+ call_metadata = @config.rpcs.set_iam_policy.metadata.to_h
+
+ # Set x-goog-api-client and x-goog-user-project headers
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
+ gapic_version: ::Google::Cloud::Compute::V1::VERSION,
+ transports_version_send: [:rest]
+
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+ options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
+ metadata: call_metadata,
+ retry_policy: @config.rpcs.set_iam_policy.retry_policy
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
+ retry_policy: @config.retry_policy
+
+ @backend_buckets_stub.set_iam_policy request, options do |result, operation|
+ yield result, operation if block_given?
+ return result
+ end
+ rescue ::Gapic::Rest::Error => e
+ raise ::Google::Cloud::Error.from_error(e)
+ end
+
+ ##
+ # Returns permissions that a caller has on the specified resource.
+ #
+ # @overload test_iam_permissions(request, options = nil)
+ # Pass arguments to `test_iam_permissions` via a request object, either of type
+ # {::Google::Cloud::Compute::V1::TestIamPermissionsBackendBucketRequest} or an equivalent Hash.
+ #
+ # @param request [::Google::Cloud::Compute::V1::TestIamPermissionsBackendBucketRequest, ::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.
+ # @param options [::Gapic::CallOptions, ::Hash]
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+ #
+ # @overload test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil)
+ # Pass arguments to `test_iam_permissions` 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).
+ #
+ # @param project [::String]
+ # Project ID for this request.
+ # @param resource [::String]
+ # Name or id of the resource for this request.
+ # @param test_permissions_request_resource [::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash]
+ # The body resource for this request
+ # @yield [result, operation] Access the result along with the TransportOperation object
+ # @yieldparam result [::Google::Cloud::Compute::V1::TestPermissionsResponse]
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
+ #
+ # @return [::Google::Cloud::Compute::V1::TestPermissionsResponse]
+ #
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
+ #
+ # @example Basic example
+ # require "google/cloud/compute/v1"
+ #
+ # # Create a client object. The client can be reused for multiple calls.
+ # client = Google::Cloud::Compute::V1::BackendBuckets::Rest::Client.new
+ #
+ # # Create a request. To set request fields, pass in keyword arguments.
+ # request = Google::Cloud::Compute::V1::TestIamPermissionsBackendBucketRequest.new
+ #
+ # # Call the test_iam_permissions method.
+ # result = client.test_iam_permissions request
+ #
+ # # The returned object is of type Google::Cloud::Compute::V1::TestPermissionsResponse.
+ # p result
+ #
+ def test_iam_permissions request, options = nil
+ raise ::ArgumentError, "request must be provided" if request.nil?
+
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::TestIamPermissionsBackendBucketRequest
+
+ # Converts hash and nil to an options object
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+ # Customize the options with defaults
+ call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h
+
+ # Set x-goog-api-client and x-goog-user-project headers
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
+ gapic_version: ::Google::Cloud::Compute::V1::VERSION,
+ transports_version_send: [:rest]
+
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+ options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
+ metadata: call_metadata,
+ retry_policy: @config.rpcs.test_iam_permissions.retry_policy
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
+ retry_policy: @config.retry_policy
+
+ @backend_buckets_stub.test_iam_permissions request, options do |result, operation|
+ yield result, operation if block_given?
+ return result
+ end
+ rescue ::Gapic::Rest::Error => e
+ raise ::Google::Cloud::Error.from_error(e)
+ end
+
+ ##
# Updates the specified BackendBucket resource with the data included in the request.
#
# @overload update(request, options = nil)
# Pass arguments to `update` via a request object, either of type
# {::Google::Cloud::Compute::V1::UpdateBackendBucketRequest} or an equivalent Hash.
@@ -1124,10 +1379,15 @@
# RPC-specific configuration for `get`
# @return [::Gapic::Config::Method]
#
attr_reader :get
##
+ # RPC-specific configuration for `get_iam_policy`
+ # @return [::Gapic::Config::Method]
+ #
+ attr_reader :get_iam_policy
+ ##
# RPC-specific configuration for `insert`
# @return [::Gapic::Config::Method]
#
attr_reader :insert
##
@@ -1144,10 +1404,20 @@
# RPC-specific configuration for `set_edge_security_policy`
# @return [::Gapic::Config::Method]
#
attr_reader :set_edge_security_policy
##
+ # RPC-specific configuration for `set_iam_policy`
+ # @return [::Gapic::Config::Method]
+ #
+ attr_reader :set_iam_policy
+ ##
+ # RPC-specific configuration for `test_iam_permissions`
+ # @return [::Gapic::Config::Method]
+ #
+ attr_reader :test_iam_permissions
+ ##
# RPC-specific configuration for `update`
# @return [::Gapic::Config::Method]
#
attr_reader :update
@@ -1159,17 +1429,23 @@
@delete = ::Gapic::Config::Method.new delete_config
delete_signed_url_key_config = parent_rpcs.delete_signed_url_key if parent_rpcs.respond_to? :delete_signed_url_key
@delete_signed_url_key = ::Gapic::Config::Method.new delete_signed_url_key_config
get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
@get = ::Gapic::Config::Method.new get_config
+ get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
+ @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
@insert = ::Gapic::Config::Method.new insert_config
list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
@list = ::Gapic::Config::Method.new list_config
patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
@patch = ::Gapic::Config::Method.new patch_config
set_edge_security_policy_config = parent_rpcs.set_edge_security_policy if parent_rpcs.respond_to? :set_edge_security_policy
@set_edge_security_policy = ::Gapic::Config::Method.new set_edge_security_policy_config
+ set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
+ @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
+ test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
+ @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
update_config = parent_rpcs.update if parent_rpcs.respond_to? :update
@update = ::Gapic::Config::Method.new update_config
yield self if block_given?
end