google-cloud-access_approval-v1 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f3f791c68c3279d51a1709f64cda59106bcf82dc40cdddfd1e789c12d8b610
-  data.tar.gz: 1a25ce51a1e55d706153e67491001868ec19db7a76f3ce28b5446b3f87b41dfb
+  metadata.gz: 1b6a923c0a58aca2e91116fcd9fc31d8899e30b0488061dc86bacde71380314b
+  data.tar.gz: 74e54b7d714a184ef7b08c723819a93222c27b55c350e5175098f85ecee75f36
 SHA512:
-  metadata.gz: 58f40dea2c7f9bf6fe894ef94d33cea1acd4d3884e61a4163f20a3ad9e7c5e850cb39ce79602af8b69b4c21d357abd27c12cdd394ddad28bf3b2fd1612465bcf
-  data.tar.gz: e7ab6fea838d9e05de49e2389615aae7b92e49f9f74090ed92842b1a7b2655210c50e9b29d24c2f732866d497cd6bde5097388af9d1f2081c691fae59a9b8eac
+  metadata.gz: c15d261539fc29d098d44dc10374c4626b548fb86e682674f64f1d40e7edd519bdf55a3b13215fcc4375ee0dd25766dea7f0167c5a638ffee2da30bd12aba719
+  data.tar.gz: faf098ad779bce4d738f09b3a02336c15e0b5d05f881f7690c117ea92241d0e28ab02749d86f8b673e073b076d4c51f5680791be303d2c75e2a901d267d419b6

data/README.md

@@ -1,4 +1,4 @@
-# Access Approval API V1
+# Ruby Client for the Access Approval API V1 API
 
 API Client library for the Access Approval API V1 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-access_approval-v1
 ```
 
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/access_approval/v1"
+
+client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
+request = my_create_request
+response = client.list_approval_requests request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-access_approval-v1/latest)
+for class and method documentation.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

data/lib/google-cloud-access_approval-v1.rb

@@ -1 +1,21 @@
-require "google/cloud/access_approval/v1/version"
+# 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!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/access_approval/v1"

data/lib/google/cloud/access_approval/v1.rb

@@ -17,3 +17,19 @@
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
 require "google/cloud/access_approval/v1/access_approval"
+require "google/cloud/access_approval/v1/version"
+
+module Google
+  module Cloud
+    module AccessApproval
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/access_approval/v1"
+      #     client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

data/lib/google/cloud/access_approval/v1/access_approval.rb

@@ -16,5 +16,65 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/access_approval/v1/access_approval/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/access_approval/v1/version"
+
 require "google/cloud/access_approval/v1/access_approval/credentials"
+require "google/cloud/access_approval/v1/access_approval/client"
+
+module Google
+  module Cloud
+    module AccessApproval
+      module V1
+        ##
+        # 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.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/access_approval/v1/access_approval"
+        #     client = Google::Cloud::AccessApproval::V1::AccessApproval::Client.new
+        #
+        module AccessApproval
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "access_approval", "helpers.rb"
+require "google/cloud/access_approval/v1/access_approval/helpers" if ::File.file? helper_path

data/lib/google/cloud/access_approval/v1/access_approval/client.rb

@@ -16,14 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/access_approval/v1/version"
 require "google/cloud/accessapproval/v1/accessapproval_pb"
-require "google/cloud/access_approval/v1/access_approval/credentials"
 
 module Google
   module Cloud
@@ -185,14 +179,20 @@ module Google
             # The order is reverse chronological.
             #
             # @overload list_approval_requests(request, options = nil)
-            #   @param request [Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage | Hash]
-            #     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.
+            #   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}".
@@ -211,7 +211,6 @@ module Google
             #   @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]
@@ -262,16 +261,23 @@ module Google
             # Gets an approval request. Returns NOT_FOUND if the request does not exist.
             #
             # @overload get_approval_request(request, options = nil)
-            #   @param request [Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage | Hash]
-            #     Gets an approval request. Returns NOT_FOUND if the request does not exist.
+            #   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]
@@ -324,21 +330,25 @@ module Google
             # FAILED_PRECONDITION if the request exists but is not in a pending state.
             #
             # @overload approve_approval_request(request, options = nil)
-            #   @param request [Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage | Hash]
-            #     Approves a request and returns the updated ApprovalRequest.
+            #   Pass arguments to `approve_approval_request` via a request object, either of type
+            #   {Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage} or an equivalent Hash.
             #
-            #     Returns NOT_FOUND if the request does not exist. Returns
-            #     FAILED_PRECONDITION if the request exists but is not in a pending state.
+            #   @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]
+            #   @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]
@@ -397,25 +407,23 @@ module Google
             # state.
             #
             # @overload dismiss_approval_request(request, options = nil)
-            #   @param request [Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage | Hash]
-            #     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.
+            #   Pass arguments to `dismiss_approval_request` via a request object, either of type
+            #   {Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage} or an equivalent Hash.
             #
-            #     Returns NOT_FOUND if the request does not exist.
-            #
-            #     Returns FAILED_PRECONDITION if the request exists but is not in a pending
-            #     state.
+            #   @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]
@@ -465,16 +473,23 @@ module Google
             # Gets the settings associated with a project, folder, or organization.
             #
             # @overload get_access_approval_settings(request, options = nil)
-            #   @param request [Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage | Hash]
-            #     Gets the settings associated with a project, folder, or organization.
+            #   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]
@@ -525,16 +540,23 @@ module Google
             # Settings to update are determined by the value of field_mask.
             #
             # @overload update_access_approval_settings(request, options = nil)
-            #   @param request [Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage | Hash]
-            #     Updates the settings associated with a project, folder, or organization.
-            #     Settings to update are determined by the value of field_mask.
+            #   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)
-            #   @param settings [Google::Cloud::AccessApproval::V1::AccessApprovalSettings | Hash]
+            #   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]
+            #   @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
@@ -546,7 +568,6 @@ module Google
             #     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]
@@ -601,21 +622,23 @@ module Google
             # the settings are inherited.
             #
             # @overload delete_access_approval_settings(request, options = nil)
-            #   @param request [Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage | Hash]
-            #     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.
+            #   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]
@@ -856,13 +879,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/access_approval/v1/access_approval/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

data/lib/google/cloud/access_approval/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module AccessApproval
       module V1
-        VERSION = "0.1.1"
+        VERSION = "0.1.2"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-access_approval-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common