# frozen_string_literal: true
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
require "google/cloud/errors"
require "google/cloud/accessapproval/v1/accessapproval_pb"
module Google
module Cloud
module AccessApproval
module V1
module AccessApproval
##
# Client for the AccessApproval service.
#
# This API allows a customer to manage accesses to cloud resources by
# Google personnel. It defines the following resource model:
#
# - The API has a collection of
# {::Google::Cloud::AccessApproval::V1::ApprovalRequest ApprovalRequest}
# resources, named `approvalRequests/{approval_request_id}`
# - The API has top-level settings per Project/Folder/Organization, named
# `accessApprovalSettings`
#
# The service also periodically emails a list of recipients, defined at the
# Project/Folder/Organization level in the accessApprovalSettings, when there
# is a pending ApprovalRequest for them to act on. The ApprovalRequests can
# also optionally be published to a Cloud Pub/Sub topic owned by the customer
# (for Beta, the Pub/Sub setup is managed manually).
#
# ApprovalRequests can be approved or dismissed. Google personel can only
# access the indicated resource or resources if the request is approved
# (subject to some exclusions:
# https://cloud.google.com/access-approval/docs/overview#exclusions).
#
# Note: Using Access Approval functionality will mean that Google may not be
# able to meet the SLAs for your chosen products, as any support response times
# may be dramatically increased. As such the SLAs do not apply to any service
# disruption to the extent impacted by Customer's use of Access Approval. Do
# not enable Access Approval for projects where you may require high service
# availability and rapid response by Google Cloud Support.
#
# After a request is approved or dismissed, no further action may be taken on
# it. Requests with the requested_expiration in the past or with no activity
# for 14 days are considered dismissed. When an approval expires, the request
# is considered dismissed.
#
# If a request is not approved or dismissed, we call it pending.
#
class Client
# @private
attr_reader :access_approval_stub
##
# Configure the AccessApproval Client class.
#
# See {::Google::Cloud::AccessApproval::V1::AccessApproval::Client::Configuration}
# for a description of the configuration fields.
#
# @example
#
# # Modify the configuration for all AccessApproval clients
# ::Google::Cloud::AccessApproval::V1::AccessApproval::Client.configure do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def self.configure
@configure ||= begin
namespace = ["Google", "Cloud", "AccessApproval", "V1"]
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_approval_requests.timeout = 600.0
default_config.rpcs.list_approval_requests.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
}
default_config.rpcs.get_approval_request.timeout = 600.0
default_config.rpcs.get_approval_request.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
}
default_config.rpcs.approve_approval_request.timeout = 600.0
default_config.rpcs.dismiss_approval_request.timeout = 600.0
default_config.rpcs.get_access_approval_settings.timeout = 600.0
default_config.rpcs.get_access_approval_settings.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
}
default_config.rpcs.update_access_approval_settings.timeout = 600.0
default_config.rpcs.delete_access_approval_settings.timeout = 600.0
default_config
end
yield @configure if block_given?
@configure
end
##
# Configure the AccessApproval 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::AccessApproval::V1::AccessApproval::Client::Configuration}
# for a description of the configuration fields.
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def configure
yield @config if block_given?
@config
end
##
# Create a new AccessApproval client object.
#
# @example
#
# # Create a client using the default configuration
# client = ::Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a client using a custom configuration
# client = ::Google::Cloud::AccessApproval::V1::AccessApproval::Client.new do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the AccessApproval client.
# @yieldparam config [Client::Configuration]
#
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/accessapproval/v1/accessapproval_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
@access_approval_stub = ::Gapic::ServiceStub.new(
::Google::Cloud::AccessApproval::V1::AccessApproval::Stub,
credentials: credentials,
endpoint: @config.endpoint,
channel_args: @config.channel_args,
interceptors: @config.interceptors
)
end
# Service calls
##
# Lists approval requests associated with a project, folder, or organization.
# Approval requests can be filtered by state (pending, active, dismissed).
# The order is reverse chronological.
#
# @overload list_approval_requests(request, options = nil)
# Pass arguments to `list_approval_requests` via a request object, either of type
# {::Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage} or an equivalent Hash.
#
# @param request [::Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage, ::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_approval_requests(parent: nil, filter: nil, page_size: nil, page_token: nil)
# Pass arguments to `list_approval_requests` 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]
# The parent resource. This may be "projects/\\{project_id}",
# "folders/\\{folder_id}", or "organizations/\\{organization_id}".
# @param filter [::String]
# A filter on the type of approval requests to retrieve. Must be one of the
# following values:
#
# - [not set]: Requests that are pending or have active approvals.
# - ALL: All requests.
# - PENDING: Only pending requests.
# - ACTIVE: Only active (i.e. currently approved) requests.
# - DISMISSED: Only dismissed (including expired) requests.
# @param page_size [::Integer]
# Requested page size.
# @param page_token [::String]
# A token identifying the page of results to return.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AccessApproval::V1::ApprovalRequest>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AccessApproval::V1::ApprovalRequest>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/access_approval/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage.new
#
# # Call the list_approval_requests method.
# result = client.list_approval_requests request
#
# # The returned object is of type Gapic::PagedEnumerable. You can
# # iterate over all elements by calling #each, and the enumerable
# # will lazily make API calls to fetch subsequent pages. Other
# # methods are also available for managing paging directly.
# result.each do |response|
# # Each element is of type ::Google::Cloud::AccessApproval::V1::ApprovalRequest.
# p response
# end
#
def list_approval_requests request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage
# 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_approval_requests.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::AccessApproval::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
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_approval_requests.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_approval_requests.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@access_approval_stub.call_rpc :list_approval_requests, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @access_approval_stub, :list_approval_requests, 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
##
# Gets an approval request. Returns NOT_FOUND if the request does not exist.
#
# @overload get_approval_request(request, options = nil)
# Pass arguments to `get_approval_request` via a request object, either of type
# {::Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage} or an equivalent Hash.
#
# @param request [::Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage, ::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_approval_request(name: nil)
# Pass arguments to `get_approval_request` 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]
# Name of the approval request to retrieve.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/access_approval/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage.new
#
# # Call the get_approval_request method.
# result = client.get_approval_request request
#
# # The returned object is of type Google::Cloud::AccessApproval::V1::ApprovalRequest.
# p result
#
def get_approval_request request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage
# 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_approval_request.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::AccessApproval::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
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_approval_request.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_approval_request.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@access_approval_stub.call_rpc :get_approval_request, 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
##
# Approves a request and returns the updated ApprovalRequest.
#
# Returns NOT_FOUND if the request does not exist. Returns
# FAILED_PRECONDITION if the request exists but is not in a pending state.
#
# @overload approve_approval_request(request, options = nil)
# Pass arguments to `approve_approval_request` via a request object, either of type
# {::Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage} or an equivalent Hash.
#
# @param request [::Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage, ::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 approve_approval_request(name: nil, expire_time: nil)
# Pass arguments to `approve_approval_request` 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]
# Name of the approval request to approve.
# @param expire_time [::Google::Protobuf::Timestamp, ::Hash]
# The expiration time of this approval.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/access_approval/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage.new
#
# # Call the approve_approval_request method.
# result = client.approve_approval_request request
#
# # The returned object is of type Google::Cloud::AccessApproval::V1::ApprovalRequest.
# p result
#
def approve_approval_request request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage
# 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.approve_approval_request.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::AccessApproval::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
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.approve_approval_request.timeout,
metadata: metadata,
retry_policy: @config.rpcs.approve_approval_request.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@access_approval_stub.call_rpc :approve_approval_request, 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
##
# Dismisses a request. Returns the updated ApprovalRequest.
#
# NOTE: This does not deny access to the resource if another request has been
# made and approved. It is equivalent in effect to ignoring the request
# altogether.
#
# Returns NOT_FOUND if the request does not exist.
#
# Returns FAILED_PRECONDITION if the request exists but is not in a pending
# state.
#
# @overload dismiss_approval_request(request, options = nil)
# Pass arguments to `dismiss_approval_request` via a request object, either of type
# {::Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage} or an equivalent Hash.
#
# @param request [::Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage, ::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 dismiss_approval_request(name: nil)
# Pass arguments to `dismiss_approval_request` 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]
# Name of the ApprovalRequest to dismiss.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/access_approval/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage.new
#
# # Call the dismiss_approval_request method.
# result = client.dismiss_approval_request request
#
# # The returned object is of type Google::Cloud::AccessApproval::V1::ApprovalRequest.
# p result
#
def dismiss_approval_request request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage
# 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.dismiss_approval_request.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::AccessApproval::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
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.dismiss_approval_request.timeout,
metadata: metadata,
retry_policy: @config.rpcs.dismiss_approval_request.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@access_approval_stub.call_rpc :dismiss_approval_request, 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 settings associated with a project, folder, or organization.
#
# @overload get_access_approval_settings(request, options = nil)
# Pass arguments to `get_access_approval_settings` via a request object, either of type
# {::Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage} or an equivalent Hash.
#
# @param request [::Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage, ::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_access_approval_settings(name: nil)
# Pass arguments to `get_access_approval_settings` 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]
# Name of the AccessApprovalSettings to retrieve.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/access_approval/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage.new
#
# # Call the get_access_approval_settings method.
# result = client.get_access_approval_settings request
#
# # The returned object is of type Google::Cloud::AccessApproval::V1::AccessApprovalSettings.
# p result
#
def get_access_approval_settings request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage
# 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_access_approval_settings.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::AccessApproval::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
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_access_approval_settings.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_access_approval_settings.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@access_approval_stub.call_rpc :get_access_approval_settings, 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
##
# Updates the settings associated with a project, folder, or organization.
# Settings to update are determined by the value of field_mask.
#
# @overload update_access_approval_settings(request, options = nil)
# Pass arguments to `update_access_approval_settings` via a request object, either of type
# {::Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage} or an equivalent Hash.
#
# @param request [::Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage, ::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_access_approval_settings(settings: nil, update_mask: nil)
# Pass arguments to `update_access_approval_settings` 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 settings [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings, ::Hash]
# The new AccessApprovalSettings.
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
# The update mask applies to the settings. Only the top level fields of
# AccessApprovalSettings (notification_emails & enrolled_services) are
# supported. For each field, if it is included, the currently stored value
# will be entirely overwritten with the value of the field passed in this
# request.
#
# For the `FieldMask` definition, see
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
# If this field is left unset, only the notification_emails field will be
# updated.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/access_approval/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage.new
#
# # Call the update_access_approval_settings method.
# result = client.update_access_approval_settings request
#
# # The returned object is of type Google::Cloud::AccessApproval::V1::AccessApprovalSettings.
# p result
#
def update_access_approval_settings request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage
# 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_access_approval_settings.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::AccessApproval::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.settings&.name
header_params["settings.name"] = request.settings.name
end
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_access_approval_settings.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_access_approval_settings.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@access_approval_stub.call_rpc :update_access_approval_settings, 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 the settings associated with a project, folder, or organization.
# This will have the effect of disabling Access Approval for the project,
# folder, or organization, but only if all ancestors also have Access
# Approval disabled. If Access Approval is enabled at a higher level of the
# hierarchy, then Access Approval will still be enabled at this level as
# the settings are inherited.
#
# @overload delete_access_approval_settings(request, options = nil)
# Pass arguments to `delete_access_approval_settings` via a request object, either of type
# {::Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage} or an equivalent Hash.
#
# @param request [::Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage, ::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_access_approval_settings(name: nil)
# Pass arguments to `delete_access_approval_settings` 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]
# Name of the AccessApprovalSettings to delete.
#
# @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.
#
# @example Basic example
# require "google/cloud/access_approval/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage.new
#
# # Call the delete_access_approval_settings method.
# result = client.delete_access_approval_settings request
#
# # The returned object is of type Google::Protobuf::Empty.
# p result
#
def delete_access_approval_settings request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage
# 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_access_approval_settings.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::AccessApproval::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
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_access_approval_settings.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_access_approval_settings.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@access_approval_stub.call_rpc :delete_access_approval_settings, 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
##
# Configuration class for the AccessApproval API.
#
# This class represents the configuration for AccessApproval,
# providing control over timeouts, retry behavior, logging, transport
# parameters, and other low-level controls. Certain parameters can also be
# applied individually to specific RPCs. See
# {::Google::Cloud::AccessApproval::V1::AccessApproval::Client::Configuration::Rpcs}
# for a list of RPCs that can be configured independently.
#
# Configuration can be applied globally to all clients, or to a single client
# on construction.
#
# @example
#
# # Modify the global config, setting the timeout for
# # list_approval_requests to 20 seconds,
# # and all remaining timeouts to 10 seconds.
# ::Google::Cloud::AccessApproval::V1::AccessApproval::Client.configure do |config|
# config.timeout = 10.0
# config.rpcs.list_approval_requests.timeout = 20.0
# end
#
# # Apply the above configuration only to a new client.
# client = ::Google::Cloud::AccessApproval::V1::AccessApproval::Client.new do |config|
# config.timeout = 10.0
# config.rpcs.list_approval_requests.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"accessapproval.googleapis.com"`.
# @return [::String]
# @!attribute [rw] credentials
# Credentials to send with calls. You may provide any of the following types:
# * (`String`) The path to a service account key file in JSON format
# * (`Hash`) A service account key as a Hash
# * (`Google::Auth::Credentials`) A googleauth credentials object
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
# * (`nil`) indicating no credentials
# @return [::Object]
# @!attribute [rw] scope
# The OAuth scopes
# @return [::Array<::String>]
# @!attribute [rw] lib_name
# The library name as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] lib_version
# The library version as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] channel_args
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
# `GRPC::Core::Channel` object is provided as the credential.
# @return [::Hash]
# @!attribute [rw] interceptors
# An array of interceptors that are run before calls are executed.
# @return [::Array<::GRPC::ClientInterceptor>]
# @!attribute [rw] timeout
# The call timeout in seconds.
# @return [::Numeric]
# @!attribute [rw] metadata
# Additional gRPC headers to be sent with the call.
# @return [::Hash{::Symbol=>::String}]
# @!attribute [rw] retry_policy
# The retry policy. The value is a hash with the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
# @return [::Hash]
# @!attribute [rw] quota_project
# A separate project against which to charge quota.
# @return [::String]
#
class Configuration
extend ::Gapic::Config
config_attr :endpoint, "accessapproval.googleapis.com", ::String
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
allowed.any? { |klass| klass === value }
end
config_attr :scope, nil, ::String, ::Array, nil
config_attr :lib_name, nil, ::String, nil
config_attr :lib_version, nil, ::String, nil
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
config_attr :interceptors, nil, ::Array, nil
config_attr :timeout, nil, ::Numeric, nil
config_attr :metadata, nil, ::Hash, nil
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
config_attr :quota_project, nil, ::String, nil
# @private
def initialize parent_config = nil
@parent_config = parent_config unless parent_config.nil?
yield self if block_given?
end
##
# Configurations for individual RPCs
# @return [Rpcs]
#
def rpcs
@rpcs ||= begin
parent_rpcs = nil
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
Rpcs.new parent_rpcs
end
end
##
# Configuration RPC class for the AccessApproval API.
#
# Includes fields providing the configuration for each RPC in this service.
# Each configuration object is of type `Gapic::Config::Method` and includes
# the following configuration fields:
#
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
# include the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
#
class Rpcs
##
# RPC-specific configuration for `list_approval_requests`
# @return [::Gapic::Config::Method]
#
attr_reader :list_approval_requests
##
# RPC-specific configuration for `get_approval_request`
# @return [::Gapic::Config::Method]
#
attr_reader :get_approval_request
##
# RPC-specific configuration for `approve_approval_request`
# @return [::Gapic::Config::Method]
#
attr_reader :approve_approval_request
##
# RPC-specific configuration for `dismiss_approval_request`
# @return [::Gapic::Config::Method]
#
attr_reader :dismiss_approval_request
##
# RPC-specific configuration for `get_access_approval_settings`
# @return [::Gapic::Config::Method]
#
attr_reader :get_access_approval_settings
##
# RPC-specific configuration for `update_access_approval_settings`
# @return [::Gapic::Config::Method]
#
attr_reader :update_access_approval_settings
##
# RPC-specific configuration for `delete_access_approval_settings`
# @return [::Gapic::Config::Method]
#
attr_reader :delete_access_approval_settings
# @private
def initialize parent_rpcs = nil
list_approval_requests_config = parent_rpcs.list_approval_requests if parent_rpcs.respond_to? :list_approval_requests
@list_approval_requests = ::Gapic::Config::Method.new list_approval_requests_config
get_approval_request_config = parent_rpcs.get_approval_request if parent_rpcs.respond_to? :get_approval_request
@get_approval_request = ::Gapic::Config::Method.new get_approval_request_config
approve_approval_request_config = parent_rpcs.approve_approval_request if parent_rpcs.respond_to? :approve_approval_request
@approve_approval_request = ::Gapic::Config::Method.new approve_approval_request_config
dismiss_approval_request_config = parent_rpcs.dismiss_approval_request if parent_rpcs.respond_to? :dismiss_approval_request
@dismiss_approval_request = ::Gapic::Config::Method.new dismiss_approval_request_config
get_access_approval_settings_config = parent_rpcs.get_access_approval_settings if parent_rpcs.respond_to? :get_access_approval_settings
@get_access_approval_settings = ::Gapic::Config::Method.new get_access_approval_settings_config
update_access_approval_settings_config = parent_rpcs.update_access_approval_settings if parent_rpcs.respond_to? :update_access_approval_settings
@update_access_approval_settings = ::Gapic::Config::Method.new update_access_approval_settings_config
delete_access_approval_settings_config = parent_rpcs.delete_access_approval_settings if parent_rpcs.respond_to? :delete_access_approval_settings
@delete_access_approval_settings = ::Gapic::Config::Method.new delete_access_approval_settings_config
yield self if block_given?
end
end
end
end
end
end
end
end
end