google-cloud-backupdr-v1 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f10381819fccd36319f6f0e85907f5a6b285d501fac87c98f9cda3a32750617
-  data.tar.gz: 51e5e7e4e3f576f1d9a8f0ead55d5c1dd50905ccfe91b2258f4223b84b191446
+  metadata.gz: '08534cc34dc75f775b5e86920233ce9178cd666ede2e2092075c36c5a9936cc4'
+  data.tar.gz: f13d2f06ebc5a271509024c674f95bf2681beeff7a3f9b81c4cf6b8d18245d3a
 SHA512:
-  metadata.gz: 50c87efb60c9c5a2daedc530bcda3674db75ce2d8e405280ce58a6a98521fc6df85567d3652f9db3a283124ecb04eac1c348cd6c4b0687f666d6002d52a22734
-  data.tar.gz: 4063ba9eabdbed5bde4d7aea44b664375a737b4490149052d3f8a67159f78086cd83cd3c27d6951757a6ed6f93ae4d98a31d2b15d18e4d353e0b06907db00a8f
+  metadata.gz: d49c834ee1aac20e561efc8bcdf8a960507287acae94f6e77c509e7d51b8884135cbc7b2cd86018999db85a464045f8a5bc148cb9153f47efc2a9d415629f847
+  data.tar.gz: d304e913511a22a4e042913040e8a3530fdf17e0a0321d9e03b1a72fa56f83e9e84102220e9b4e2a3d2e1571a7dbf1c9c33f0fdeffd20b5b8ecf9303acaaef60

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

@@ -1799,6 +1799,126 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Fetch Backups for a given resource type.
+            #
+            # @overload fetch_backups_for_resource_type(request, options = nil)
+            #   Pass arguments to `fetch_backups_for_resource_type` via a request object, either of type
+            #   {::Google::Cloud::BackupDR::V1::FetchBackupsForResourceTypeRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::BackupDR::V1::FetchBackupsForResourceTypeRequest, ::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 fetch_backups_for_resource_type(parent: nil, resource_type: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil)
+            #   Pass arguments to `fetch_backups_for_resource_type` 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. Datasources are the parent resource for the backups.
+            #     Format:
+            #     projects/\\{project}/locations/\\{location}/backupVaults/\\{backupVaultId}/dataSources/\\{datasourceId}
+            #   @param resource_type [::String]
+            #     Required. The type of the GCP resource.
+            #     Ex: sqladmin.googleapis.com/Instance
+            #   @param page_size [::Integer]
+            #     Optional. The maximum number of Backups to return. The service may
+            #     return fewer than this value. If unspecified, at most 50
+            #     Backups will be returned. The maximum value is 100; values
+            #     above 100 will be coerced to 100.
+            #   @param page_token [::String]
+            #     Optional. A page token, received from a previous call of
+            #     `FetchBackupsForResourceType`.
+            #     Provide this to retrieve the subsequent page.
+            #
+            #     When paginating, all other parameters provided to
+            #     `FetchBackupsForResourceType` must match
+            #     the call that provided the page token.
+            #   @param filter [::String]
+            #     Optional. A filter expression that filters the results fetched in the
+            #     response. The expression must specify the field name, a comparison
+            #     operator, and the value that you want to use for filtering. Supported
+            #     fields:
+            #   @param order_by [::String]
+            #     Optional. A comma-separated list of fields to order by, sorted in ascending
+            #     order. Use "desc" after a field name for descending.
+            #   @param view [::Google::Cloud::BackupDR::V1::BackupView]
+            #     Optional. This parameter is used to specify the view of the backup.
+            #     If not specified, the default view is BASIC.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::BackupDR::V1::Backup>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::PagedEnumerable<::Google::Cloud::BackupDR::V1::Backup>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/backupdr/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::BackupDR::V1::BackupDR::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::BackupDR::V1::FetchBackupsForResourceTypeRequest.new
+            #
+            #   # Call the fetch_backups_for_resource_type method.
+            #   result = client.fetch_backups_for_resource_type request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
+            #     # Each element is of type ::Google::Cloud::BackupDR::V1::Backup.
+            #     p item
+            #   end
+            #
+            def fetch_backups_for_resource_type request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BackupDR::V1::FetchBackupsForResourceTypeRequest
+
+              # 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.fetch_backups_for_resource_type.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::BackupDR::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              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.fetch_backups_for_resource_type.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.fetch_backups_for_resource_type.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @backup_dr_stub.call_rpc :fetch_backups_for_resource_type, request, options: options do |response, operation|
+                response = ::Gapic::PagedEnumerable.new @backup_dr_stub, :fetch_backups_for_resource_type, request, response, operation, options
+                yield response, operation if block_given?
+                throw :response, response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Gets details of a Backup.
             #
@@ -3830,6 +3950,127 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Lists DataSourceReferences for a given project and location.
+            #
+            # @overload list_data_source_references(request, options = nil)
+            #   Pass arguments to `list_data_source_references` via a request object, either of type
+            #   {::Google::Cloud::BackupDR::V1::ListDataSourceReferencesRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::BackupDR::V1::ListDataSourceReferencesRequest, ::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_data_source_references(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
+            #   Pass arguments to `list_data_source_references` 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 parent resource name.
+            #     Format: projects/\\{project}/locations/\\{location}
+            #   @param page_size [::Integer]
+            #     Optional. The maximum number of DataSourceReferences to return. The service
+            #     may return fewer than this value. If unspecified, at most 50
+            #     DataSourceReferences will be returned. The maximum value is 100; values
+            #     above 100 will be coerced to 100.
+            #   @param page_token [::String]
+            #     Optional. A page token, received from a previous `ListDataSourceReferences`
+            #     call. Provide this to retrieve the subsequent page.
+            #
+            #     When paginating, all other parameters provided to
+            #     `ListDataSourceReferences` must match the call that provided the page
+            #     token.
+            #   @param filter [::String]
+            #     Optional. A filter expression that filters the results listed in the
+            #     response. The expression must specify the field name, a comparison
+            #     operator, and the value that you want to use for filtering.
+            #
+            #     The following field and operator combinations are supported:
+            #
+            #     * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=`
+            #     * data_source_gcp_resource_info.type with `=`, `!=`
+            #   @param order_by [::String]
+            #     Optional. A comma-separated list of fields to order by, sorted in ascending
+            #     order. Use "desc" after a field name for descending.
+            #
+            #     Supported fields:
+            #
+            #     * data_source
+            #     * data_source_gcp_resource_info.gcp_resourcename
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::BackupDR::V1::DataSourceReference>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::PagedEnumerable<::Google::Cloud::BackupDR::V1::DataSourceReference>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/backupdr/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::BackupDR::V1::BackupDR::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::BackupDR::V1::ListDataSourceReferencesRequest.new
+            #
+            #   # Call the list_data_source_references method.
+            #   result = client.list_data_source_references request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
+            #     # Each element is of type ::Google::Cloud::BackupDR::V1::DataSourceReference.
+            #     p item
+            #   end
+            #
+            def list_data_source_references request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BackupDR::V1::ListDataSourceReferencesRequest
+
+              # 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_data_source_references.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::BackupDR::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              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_data_source_references.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.list_data_source_references.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @backup_dr_stub.call_rpc :list_data_source_references, request, options: options do |response, operation|
+                response = ::Gapic::PagedEnumerable.new @backup_dr_stub, :list_data_source_references, request, response, operation, options
+                yield response, operation if block_given?
+                throw :response, response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Fetch DataSourceReferences for a given project, location and resource type.
             #
@@ -4109,8 +4350,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
@@ -4119,7 +4358,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::Cloud::BackupDR::V1::BackupDR::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.
@@ -4311,6 +4569,11 @@ module Google
                 #
                 attr_reader :list_backups
                 ##
+                # RPC-specific configuration for `fetch_backups_for_resource_type`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :fetch_backups_for_resource_type
+                ##
                 # RPC-specific configuration for `get_backup`
                 # @return [::Gapic::Config::Method]
                 #
@@ -4406,6 +4669,11 @@ module Google
                 #
                 attr_reader :get_data_source_reference
                 ##
+                # RPC-specific configuration for `list_data_source_references`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :list_data_source_references
+                ##
                 # RPC-specific configuration for `fetch_data_source_references_for_resource_type`
                 # @return [::Gapic::Config::Method]
                 #
@@ -4446,6 +4714,8 @@ module Google
                   @update_data_source = ::Gapic::Config::Method.new update_data_source_config
                   list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
                   @list_backups = ::Gapic::Config::Method.new list_backups_config
+                  fetch_backups_for_resource_type_config = parent_rpcs.fetch_backups_for_resource_type if parent_rpcs.respond_to? :fetch_backups_for_resource_type
+                  @fetch_backups_for_resource_type = ::Gapic::Config::Method.new fetch_backups_for_resource_type_config
                   get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
                   @get_backup = ::Gapic::Config::Method.new get_backup_config
                   update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
@@ -4484,6 +4754,8 @@ module Google
                   @trigger_backup = ::Gapic::Config::Method.new trigger_backup_config
                   get_data_source_reference_config = parent_rpcs.get_data_source_reference if parent_rpcs.respond_to? :get_data_source_reference
                   @get_data_source_reference = ::Gapic::Config::Method.new get_data_source_reference_config
+                  list_data_source_references_config = parent_rpcs.list_data_source_references if parent_rpcs.respond_to? :list_data_source_references
+                  @list_data_source_references = ::Gapic::Config::Method.new list_data_source_references_config
                   fetch_data_source_references_for_resource_type_config = parent_rpcs.fetch_data_source_references_for_resource_type if parent_rpcs.respond_to? :fetch_data_source_references_for_resource_type
                   @fetch_data_source_references_for_resource_type = ::Gapic::Config::Method.new fetch_data_source_references_for_resource_type_config
                   initialize_service_config = parent_rpcs.initialize_service if parent_rpcs.respond_to? :initialize_service

data/lib/google/cloud/backupdr/v1/backupdr/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.