class Google::Cloud::OrgPolicy::V2::OrgPolicy::Client
Client
for the OrgPolicy
service.
An interface for managing organization policies.
The Cloud
Org Policy service provides a simple mechanism for organizations to restrict the allowed configurations across their entire Cloud
Resource hierarchy.
You can use a `policy` to configure restrictions in Cloud
resources. For example, you can enforce a `policy` that restricts which Google
Cloud
Platform APIs can be activated in a certain part of your resource hierarchy, or prevents serial port access to VM instances in a particular folder.
`Policies` are inherited down through the resource hierarchy. A `policy` applied to a parent resource automatically applies to all its child resources unless overridden with a `policy` lower in the hierarchy.
A `constraint` defines an aspect of a resource's configuration that can be controlled by an organization's policy administrator. `Policies` are a collection of `constraints` that defines their allowable configuration on a particular resource and its child resources.
Attributes
@private
Public Class Methods
Configure the OrgPolicy
Client
class.
See {::Google::Cloud::OrgPolicy::V2::OrgPolicy::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all OrgPolicy clients ::Google::Cloud::OrgPolicy::V2::OrgPolicy::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 75 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "OrgPolicy", "V2"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.list_constraints.timeout = 60.0 default_config.rpcs.list_constraints.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.list_policies.timeout = 60.0 default_config.rpcs.list_policies.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.get_policy.timeout = 60.0 default_config.rpcs.get_policy.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.get_effective_policy.timeout = 60.0 default_config.rpcs.get_effective_policy.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.create_policy.timeout = 60.0 default_config.rpcs.create_policy.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.update_policy.timeout = 60.0 default_config.rpcs.update_policy.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.delete_policy.timeout = 60.0 default_config.rpcs.delete_policy.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4] } default_config end yield @configure if block_given? @configure end
Create a new OrgPolicy
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::OrgPolicy::V2::OrgPolicy::Client.new # Create a client using a custom configuration client = ::Google::Cloud::OrgPolicy::V2::OrgPolicy::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the OrgPolicy
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 163 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/orgpolicy/v2/orgpolicy_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @org_policy_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::OrgPolicy::V2::OrgPolicy::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the OrgPolicy
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 {::Google::Cloud::OrgPolicy::V2::OrgPolicy::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 142 def configure yield @config if block_given? @config end
Creates a Policy.
Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy already exists on the given Cloud
resource.
@overload create_policy
(request, options = nil)
Pass arguments to `create_policy` via a request object, either of type {::Google::Cloud::OrgPolicy::V2::CreatePolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::OrgPolicy::V2::CreatePolicyRequest, ::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 create_policy
(parent: nil, policy: nil)
Pass arguments to `create_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 parent [::String] Required. The Cloud resource that will parent the new Policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` @param policy [::Google::Cloud::OrgPolicy::V2::Policy, ::Hash] Required. `Policy` to create.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OrgPolicy::V2::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OrgPolicy::V2::Policy]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 550 def create_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OrgPolicy::V2::CreatePolicyRequest # 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 metadata = @config.rpcs.create_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::OrgPolicy::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.create_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @org_policy_stub.call_rpc :create_policy, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a Policy.
Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or Org Policy does not exist.
@overload delete_policy
(request, options = nil)
Pass arguments to `delete_policy` via a request object, either of type {::Google::Cloud::OrgPolicy::V2::DeletePolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::OrgPolicy::V2::DeletePolicyRequest, ::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 delete_policy
(name: nil)
Pass arguments to `delete_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 name [::String] Required. Name of the policy to delete. See `Policy` for naming rules.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 698 def delete_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OrgPolicy::V2::DeletePolicyRequest # 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 metadata = @config.rpcs.delete_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::OrgPolicy::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @org_policy_stub.call_rpc :delete_policy, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy and evaluating conditions. The returned `Policy` will not have an `etag` or `condition` set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.
@overload get_effective_policy
(request, options = nil)
Pass arguments to `get_effective_policy` via a request object, either of type {::Google::Cloud::OrgPolicy::V2::GetEffectivePolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::OrgPolicy::V2::GetEffectivePolicyRequest, ::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_effective_policy
(name: nil)
Pass arguments to `get_effective_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 name [::String] Required. The effective policy to compute. See `Policy` for naming rules.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OrgPolicy::V2::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OrgPolicy::V2::Policy]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 470 def get_effective_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OrgPolicy::V2::GetEffectivePolicyRequest # 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 metadata = @config.rpcs.get_effective_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::OrgPolicy::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_effective_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.get_effective_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @org_policy_stub.call_rpc :get_effective_policy, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a `Policy` on a resource.
If no `Policy` is set on the resource, NOT_FOUND is returned. The `etag` value can be used with `UpdatePolicy()` to update a `Policy` during read-modify-write.
@overload get_policy
(request, options = nil)
Pass arguments to `get_policy` via a request object, either of type {::Google::Cloud::OrgPolicy::V2::GetPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::OrgPolicy::V2::GetPolicyRequest, ::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_policy
(name: nil)
Pass arguments to `get_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 name [::String] Required. Resource name of the policy. See `Policy` for naming requirements.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OrgPolicy::V2::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OrgPolicy::V2::Policy]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 397 def get_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OrgPolicy::V2::GetPolicyRequest # 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 metadata = @config.rpcs.get_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::OrgPolicy::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.get_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @org_policy_stub.call_rpc :get_policy, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists `Constraints` that could be applied on the specified resource.
@overload list_constraints
(request, options = nil)
Pass arguments to `list_constraints` via a request object, either of type {::Google::Cloud::OrgPolicy::V2::ListConstraintsRequest} or an equivalent Hash. @param request [::Google::Cloud::OrgPolicy::V2::ListConstraintsRequest, ::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 list_constraints
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_constraints` 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 parent [::String] Required. The Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` @param page_size [::Integer] Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size. @param page_token [::String] Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::OrgPolicy::V2::Constraint>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::OrgPolicy::V2::Constraint>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 242 def list_constraints request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OrgPolicy::V2::ListConstraintsRequest # 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 metadata = @config.rpcs.list_constraints.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::OrgPolicy::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_constraints.timeout, metadata: metadata, retry_policy: @config.rpcs.list_constraints.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @org_policy_stub.call_rpc :list_constraints, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @org_policy_stub, :list_constraints, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Retrieves all of the `Policies` that exist on a particular resource.
@overload list_policies
(request, options = nil)
Pass arguments to `list_policies` via a request object, either of type {::Google::Cloud::OrgPolicy::V2::ListPoliciesRequest} or an equivalent Hash. @param request [::Google::Cloud::OrgPolicy::V2::ListPoliciesRequest, ::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 list_policies
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_policies` 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 parent [::String] Required. The target Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` @param page_size [::Integer] Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size. @param page_token [::String] Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::OrgPolicy::V2::Policy>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::OrgPolicy::V2::Policy>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 324 def list_policies request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OrgPolicy::V2::ListPoliciesRequest # 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 metadata = @config.rpcs.list_policies.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::OrgPolicy::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_policies.timeout, metadata: metadata, retry_policy: @config.rpcs.list_policies.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @org_policy_stub.call_rpc :list_policies, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @org_policy_stub, :list_policies, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates a Policy.
Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the policy
Note: the supplied policy will perform a full overwrite of all fields.
@overload update_policy
(request, options = nil)
Pass arguments to `update_policy` via a request object, either of type {::Google::Cloud::OrgPolicy::V2::UpdatePolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::OrgPolicy::V2::UpdatePolicyRequest, ::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 update_policy
(policy: nil)
Pass arguments to `update_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 policy [::Google::Cloud::OrgPolicy::V2::Policy, ::Hash] Required. `Policy` to update.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OrgPolicy::V2::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OrgPolicy::V2::Policy]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/org_policy/v2/org_policy/client.rb, line 626 def update_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OrgPolicy::V2::UpdatePolicyRequest # 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 metadata = @config.rpcs.update_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::OrgPolicy::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "policy.name" => request.policy.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.update_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @org_policy_stub.call_rpc :update_policy, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end