google-cloud-cloud_security_compliance-v1 0.1.0 → 0.2.0

data/lib/google/cloud/cloud_security_compliance/v1/deployment/operations.rb

@@ -642,8 +642,6 @@ module Google
             #   @return [::String,nil]
             # @!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://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
             #
-            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+            #     is deprecated. Providing an unvalidated credential configuration to
+            #     Google APIs can compromise the security of your systems and data.
+            #
+            #   @example
+            #
+            #     # The recommended way to provide credentials is to use the `make_creds` method
+            #     # on the appropriate credentials class for your environment.
+            #
+            #     require "googleauth"
+            #
+            #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+            #       json_key_io: ::File.open("/path/to/keyfile.json")
+            #     )
+            #
+            #     client = ::Google::Longrunning::Operations::Client.new do |config|
+            #       config.credentials = credentials
+            #     end
+            #
+            #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
             #   external source for authentication to Google Cloud, you must validate it before
             #   providing it to a Google API client library. Providing an unvalidated credential
             #   configuration to Google APIs can compromise the security of your systems and data.

data/lib/google/cloud/cloud_security_compliance/v1/deployment/rest/client.rb

@@ -233,7 +233,10 @@ module Google
               # Service calls
 
               ##
-              # Creates a new FrameworkDeployment in a given parent resource.
+              # Creates a framework deployment in a given parent resource. A
+              # framework deployment lets you assign a particular framework version to an
+              # organization, folder, or project so that you can control and monitor
+              # those resources using the framework's cloud controls.
               #
               # @overload create_framework_deployment(request, options = nil)
               #   Pass arguments to `create_framework_deployment` via a request object, either of type
@@ -251,15 +254,15 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The parent resource of the FrameworkDeployment in the format:
-              #     organizations/\\{organization}/locations/\\{location}
-              #     Only global location is supported.
+              #     Required. The parent resource of the framework deployment in the format
+              #     `organizations/{organization}/locations/{location}`.
+              #     Only the global location is supported.
               #   @param framework_deployment_id [::String]
-              #     Optional. User provided identifier. It should be unique in scope of a
-              #     parent. This is optional and if not provided, a random UUID will be
+              #     Optional. An identifier for the framework deployment that's unique in scope
+              #     of the parent. If you don't specify a value, then a random UUID is
               #     generated.
               #   @param framework_deployment [::Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment, ::Hash]
-              #     Required. The FrameworkDeployment to be created.
+              #     Required. The framework deployment that you're creating.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -328,7 +331,7 @@ module Google
               end
 
               ##
-              # Deletes a single FrameworkDeployment.
+              # Deletes a framework deployment.
               #
               # @overload delete_framework_deployment(request, options = nil)
               #   Pass arguments to `delete_framework_deployment` via a request object, either of type
@@ -346,15 +349,16 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. name of the FrameworkDeployment to be deleted in the following
-              #     format:
-              #     organizations/\\{organization}/locations/\\{location}/frameworkDeployments/\\{framework_deployment_id}
+              #     Required. The name of the framework deployment that you want to delete,
+              #     in the format
+              #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
+              #     The only supported location is `global`.
               #   @param etag [::String]
               #     Optional. An opaque identifier for the current version of the resource.
               #
               #     If you provide this value, then it must match the existing value. If the
               #     values don't match, then the request fails with an
-              #     [ABORTED][google.rpc.Code.ABORTED] error.
+              #     [`ABORTED`][google.rpc.Code.ABORTED] error.
               #
               #     If you omit this value, then the resource is deleted regardless of its
               #     current `etag` value.
@@ -426,7 +430,7 @@ module Google
               end
 
               ##
-              # Gets details of a single FrameworkDeployment.
+              # Gets details about a framework deployment.
               #
               # @overload get_framework_deployment(request, options = nil)
               #   Pass arguments to `get_framework_deployment` via a request object, either of type
@@ -444,8 +448,9 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. FrameworkDeployment name in the following format:
-              #     organizations/\\{organization}/locations/\\{location}/frameworkDeployments/\\{framework_deployment_id}
+              #     Required. The name of the framework deployment, in the format
+              #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
+              #     The only supported location is `global`.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -505,7 +510,7 @@ module Google
               end
 
               ##
-              # Lists FrameworkDeployments in a given parent resource.
+              # Lists the framework deployments in a given parent resource.
               #
               # @overload list_framework_deployments(request, options = nil)
               #   Pass arguments to `list_framework_deployments` via a request object, either of type
@@ -523,19 +528,27 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. parent resource of the FrameworkDeployment in the format:
-              #     organizations/\\{organization}/locations/\\{location}
-              #     Only global location is supported.
+              #     Required. The parent resource of the framework deployment, in the format
+              #     `organizations/{organization}/locations/{location}`.
+              #     The only supported location is `global`.
               #   @param page_size [::Integer]
-              #     Optional. Requested page size. Server may return fewer items than
-              #     requested. If unspecified, server will pick an appropriate default.
+              #     Optional. The requested page size. The server might return fewer items than
+              #     requested.
+              #     If unspecified, the server picks an appropriate default.
               #   @param page_token [::String]
-              #     Optional. A token identifying a page of results the server should return.
+              #     Optional. A token that identifies a page of results the server should
+              #     return.
               #   @param filter [::String]
-              #     Optional. Filter to be applied on the resource, defined by EBNF grammar
-              #     https://google.aip.dev/assets/misc/ebnf-filtering.txt.
+              #     Optional. The filter to be applied on the resource, as defined by
+              #     [AIP-160: Filtering](https://google.aip.dev/160).
               #   @param order_by [::String]
-              #     Optional. Sort results. Supported are "name", "name desc" or "" (unsorted).
+              #     Optional. The sort order for the results. The following values are
+              #     supported:
+              #
+              #     * `name`
+              #     * `name desc`
+              #
+              #     If you do not specify a value, then the results are not sorted.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -601,7 +614,7 @@ module Google
               end
 
               ##
-              # Gets details of a single CloudControlDeployment.
+              # Gets details about a cloud control deployment.
               #
               # @overload get_cloud_control_deployment(request, options = nil)
               #   Pass arguments to `get_cloud_control_deployment` via a request object, either of type
@@ -619,8 +632,9 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. CloudControlDeployment name in the following format:
-              #     organizations/\\{organization}/locations/\\{location}/cloudControlDeployments/\\{cloud_control_deployment_id}
+              #     Required. The name for the cloud control deployment, in the format
+              #     `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}`.
+              #     The only supported location is `global`.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDeployment]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -680,7 +694,7 @@ module Google
               end
 
               ##
-              # Lists CloudControlDeployments in a given parent resource.
+              # Lists the cloud conrol deployments in a given parent resource.
               #
               # @overload list_cloud_control_deployments(request, options = nil)
               #   Pass arguments to `list_cloud_control_deployments` via a request object, either of type
@@ -698,19 +712,27 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. parent resource of the CloudControlDeployment in the format:
-              #     organizations/\\{organization}/locations/\\{location}
-              #     Only global location is supported.
+              #     Required. The parent resource for the cloud control deployment, in the
+              #     format `organizations/{organization}/locations/{location}`. The only
+              #     supported location is `global`.
               #   @param page_size [::Integer]
-              #     Optional. Requested page size. Server may return fewer items than
-              #     requested. If unspecified, server will pick an appropriate default.
+              #     Optional. The requested page size. The server might return fewer items than
+              #     you requested.
+              #     If unspecified, the server picks an appropriate default.
               #   @param page_token [::String]
-              #     Optional. A token identifying a page of results the server should return.
+              #     Optional. A token that identifies the page of results that the server
+              #     should return.
               #   @param filter [::String]
-              #     Optional. Filter to be applied on the resource, defined by EBNF grammar
-              #     https://google.aip.dev/assets/misc/ebnf-filtering.txt.
+              #     Optional. The filter to apply on the resource, as defined by
+              #     [AIP-160: Filtering](https://google.aip.dev/160).
               #   @param order_by [::String]
-              #     Optional. Sort results. Supported are "name", "name desc" or "" (unsorted).
+              #     Optional. The sort order for the results. The following values are
+              #     supported:
+              #
+              #     * `name`
+              #     * `name desc`
+              #
+              #     If you do not specify a value, then the results are not sorted.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDeployment>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]