google-cloud-backupdr-v1 1.4.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4c757718470fc1fa1447db896074520748fbed59171b22363c76a848174aec2
-  data.tar.gz: 0e99dcb4c51b6dfa11a147caf6dcc7d619e8d02c3a5a07c8563f890bfcce607c
+  metadata.gz: 7e53866445581b81902e950b00e54e846f984f02cdf9048cbf4dce70c60fec9c
+  data.tar.gz: 3ddd1212302422c6f19750371aedecba316423b756d59476e414b98abbbd0f36
 SHA512:
-  metadata.gz: f4fb944c90a4616ea652b673323b58938af7ba259d4fec5044151100073d1e1f56e9ce75c8893e7ac03297a974f338dd205d5797e6388d49a29d39387aa95f9b
-  data.tar.gz: '0553468264f7dfb3d1fddfef5ba56d9c9997a4802413fba0d22ceeb2783449fe375fc26ec8f253ebbf27090a5583e2efcd57a92dadb6361da417b2b86f12db8b'
+  metadata.gz: f533dcc5190ffdb94940c3c9e1faee56e7df8259ba126b720af98e0a82cb91667f419af1fddff051494b74db8fa56f7a2aeab0a7cac89f1223a630dc810ab7ba
+  data.tar.gz: 95ee181fea8ff7756507676ef5afcfadfe3d478540faaeaef8da2dc1c5a2da4a8a49c5bb38c4056b797286130b72f5d1e146f192a38ee6e8de22875ed98ec7df

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.
             #
@@ -2123,7 +2243,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload restore_backup(name: nil, request_id: nil, compute_instance_target_environment: nil, disk_target_environment: nil, region_disk_target_environment: nil, compute_instance_restore_properties: nil, disk_restore_properties: nil)
+            # @overload restore_backup(name: nil, request_id: nil, compute_instance_target_environment: nil, disk_target_environment: nil, region_disk_target_environment: nil, compute_instance_restore_properties: nil, disk_restore_properties: nil, clear_overrides_field_mask: nil)
             #   Pass arguments to `restore_backup` 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).
@@ -2165,6 +2285,19 @@ module Google
             #     Disk properties to be overridden during restore.
             #
             #     Note: The following parameters are mutually exclusive: `disk_restore_properties`, `compute_instance_restore_properties`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+            #   @param clear_overrides_field_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     Optional. A field mask used to clear server-side default values
+            #     for fields within the `instance_properties` oneof.
+            #
+            #     When a field in this mask is cleared, the server will not apply its
+            #     default logic (like inheriting a value from the source) for that field.
+            #
+            #     The most common current use case is clearing default encryption keys.
+            #
+            #     Examples of field mask paths:
+            #     - Compute Instance Disks:
+            #     `compute_instance_restore_properties.disks.*.disk_encryption_key`
+            #     - Single Disk: `disk_restore_properties.disk_encryption_key`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -3830,6 +3963,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.
             #
@@ -4328,6 +4582,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]
                 #
@@ -4423,6 +4682,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]
                 #
@@ -4463,6 +4727,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
@@ -4501,6 +4767,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/paths.rb

@@ -125,6 +125,50 @@ module Google
               "projects/#{project}/locations/#{location}/backupVaults/#{backupvault}"
             end
 
+            ##
+            # Create a fully-qualified CryptoKey resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param ring [String]
+            # @param key [String]
+            #
+            # @return [::String]
+            def crypto_key_path project:, location:, ring:, key:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "ring cannot contain /" if ring.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/keyRings/#{ring}/cryptoKeys/#{key}"
+            end
+
+            ##
+            # Create a fully-qualified CryptoKeyVersion resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param key_ring [String]
+            # @param crypto_key [String]
+            # @param crypto_key_version [String]
+            #
+            # @return [::String]
+            def crypto_key_version_path project:, location:, key_ring:, crypto_key:, crypto_key_version:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
+              raise ::ArgumentError, "crypto_key cannot contain /" if crypto_key.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}/cryptoKeyVersions/#{crypto_key_version}"
+            end
+
             ##
             # Create a fully-qualified DataSource resource string.
             #