google-api-client 0.42.0 → 0.44.1

data/generated/google/apis/bigtableadmin_v2/representations.rb

@@ -40,6 +40,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Backup
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class BackupInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Binding
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -76,6 +88,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class CreateBackupMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class CreateClusterMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -124,6 +142,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class FailureTrace
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Frame
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GcRule
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -172,6 +202,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ListBackupsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListClustersResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -232,6 +268,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class OperationProgress
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class OptimizeRestoredTableMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class PartialUpdateInstanceRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -244,6 +292,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RestoreInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class RestoreTableMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class RestoreTableRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class SetIamPolicyRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -346,6 +412,29 @@ module Google
         end
       end
       
+      class Backup
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_time, as: 'endTime'
+          property :expire_time, as: 'expireTime'
+          property :name, as: 'name'
+          property :size_bytes, :numeric_string => true, as: 'sizeBytes'
+          property :source_table, as: 'sourceTable'
+          property :start_time, as: 'startTime'
+          property :state, as: 'state'
+        end
+      end
+      
+      class BackupInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :backup, as: 'backup'
+          property :end_time, as: 'endTime'
+          property :source_table, as: 'sourceTable'
+          property :start_time, as: 'startTime'
+        end
+      end
+      
       class Binding
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -396,6 +485,16 @@ module Google
         end
       end
       
+      class CreateBackupMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_time, as: 'endTime'
+          property :name, as: 'name'
+          property :source_table, as: 'sourceTable'
+          property :start_time, as: 'startTime'
+        end
+      end
+      
       class CreateClusterMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -475,6 +574,23 @@ module Google
         end
       end
       
+      class FailureTrace
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :frames, as: 'frames', class: Google::Apis::BigtableadminV2::Frame, decorator: Google::Apis::BigtableadminV2::Frame::Representation
+      
+        end
+      end
+      
+      class Frame
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :target_name, as: 'targetName'
+          property :workflow_guid, as: 'workflowGuid'
+          property :zone_id, as: 'zoneId'
+        end
+      end
+      
       class GcRule
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -544,6 +660,15 @@ module Google
         end
       end
       
+      class ListBackupsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :backups, as: 'backups', class: Google::Apis::BigtableadminV2::Backup, decorator: Google::Apis::BigtableadminV2::Backup::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class ListClustersResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -640,6 +765,24 @@ module Google
         end
       end
       
+      class OperationProgress
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_time, as: 'endTime'
+          property :progress_percent, as: 'progressPercent'
+          property :start_time, as: 'startTime'
+        end
+      end
+      
+      class OptimizeRestoredTableMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :name, as: 'name'
+          property :progress, as: 'progress', class: Google::Apis::BigtableadminV2::OperationProgress, decorator: Google::Apis::BigtableadminV2::OperationProgress::Representation
+      
+        end
+      end
+      
       class PartialUpdateInstanceRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -661,6 +804,36 @@ module Google
         end
       end
       
+      class RestoreInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :backup_info, as: 'backupInfo', class: Google::Apis::BigtableadminV2::BackupInfo, decorator: Google::Apis::BigtableadminV2::BackupInfo::Representation
+      
+          property :source_type, as: 'sourceType'
+        end
+      end
+      
+      class RestoreTableMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :backup_info, as: 'backupInfo', class: Google::Apis::BigtableadminV2::BackupInfo, decorator: Google::Apis::BigtableadminV2::BackupInfo::Representation
+      
+          property :name, as: 'name'
+          property :optimize_table_operation_name, as: 'optimizeTableOperationName'
+          property :progress, as: 'progress', class: Google::Apis::BigtableadminV2::OperationProgress, decorator: Google::Apis::BigtableadminV2::OperationProgress::Representation
+      
+          property :source_type, as: 'sourceType'
+        end
+      end
+      
+      class RestoreTableRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :backup, as: 'backup'
+          property :table_id, as: 'tableId'
+        end
+      end
+      
       class SetIamPolicyRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -703,6 +876,8 @@ module Google
       
           property :granularity, as: 'granularity'
           property :name, as: 'name'
+          property :restore_info, as: 'restoreInfo', class: Google::Apis::BigtableadminV2::RestoreInfo, decorator: Google::Apis::BigtableadminV2::RestoreInfo::Representation
+      
         end
       end
       

data/generated/google/apis/bigtableadmin_v2/service.rb

@@ -879,6 +879,121 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Starts creating a new Cloud Bigtable Backup.  The returned backup
+        # long-running operation can be used to
+        # track creation of the backup. The
+        # metadata field type is
+        # CreateBackupMetadata. The
+        # response field type is
+        # Backup, if successful. Cancelling the returned operation will stop the
+        # creation and delete the backup.
+        # @param [String] parent
+        #   Required. This must be one of the clusters in the instance in which this
+        #   table is located. The backup will be stored in this cluster. Values are
+        #   of the form `projects/`project`/instances/`instance`/clusters/`cluster``.
+        # @param [Google::Apis::BigtableadminV2::Backup] backup_object
+        # @param [String] backup_id
+        #   Required. The id of the backup to be created. The `backup_id` along with
+        #   the parent `parent` are combined as `parent`/backups/`backup_id` to create
+        #   the full backup name, of the form:
+        #   `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup_id`
+        #   `.
+        #   This string must be between 1 and 50 characters in length and match the
+        #   regex _a-zA-Z0-9*.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BigtableadminV2::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_project_instance_cluster_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+parent}/backups', options)
+          command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation
+          command.request_object = backup_object
+          command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
+          command.response_class = Google::Apis::BigtableadminV2::Operation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['backupId'] = backup_id unless backup_id.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes a pending or completed Cloud Bigtable backup.
+        # @param [String] name
+        #   Required. Name of the backup to delete.
+        #   Values are of the form
+        #   `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup``.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BigtableadminV2::Empty]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def delete_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v2/{+name}', options)
+          command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
+          command.response_class = Google::Apis::BigtableadminV2::Empty
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Gets metadata on a pending or completed Cloud Bigtable Backup.
+        # @param [String] name
+        #   Required. Name of the backup.
+        #   Values are of the form
+        #   `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup``.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BigtableadminV2::Backup] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BigtableadminV2::Backup]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+name}', options)
+          command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation
+          command.response_class = Google::Apis::BigtableadminV2::Backup
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the access control policy for a Table resource.
         # Returns an empty policy if the resource exists but does not have a policy
         # set.
@@ -915,6 +1030,147 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Lists Cloud Bigtable backups. Returns both completed and pending
+        # backups.
+        # @param [String] parent
+        #   Required. The cluster to list backups from.  Values are of the
+        #   form `projects/`project`/instances/`instance`/clusters/`cluster``.
+        #   Use ``cluster` = '-'` to list backups for all clusters in an instance,
+        #   e.g., `projects/`project`/instances/`instance`/clusters/-`.
+        # @param [String] filter
+        #   A filter expression that filters backups 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 value must be a
+        #   string, a number, or a boolean. The comparison operator must be
+        #   <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is
+        #   roughly synonymous with equality. Filter rules are case insensitive.
+        #   The fields eligible for filtering are:
+        #   * `name`
+        #   * `source_table`
+        #   * `state`
+        #   * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
+        #   * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
+        #   * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
+        #   * `size_bytes`
+        #   To filter on multiple expressions, provide each separate expression within
+        #   parentheses. By default, each expression is an AND expression. However,
+        #   you can include AND, OR, and NOT expressions explicitly.
+        #   Some examples of using filters are:
+        #   * `name:"exact"` --> The backup's name is the string "exact".
+        #   * `name:howl` --> The backup's name contains the string "howl".
+        #   * `source_table:prod`
+        #   --> The source_table's name contains the string "prod".
+        #   * `state:CREATING` --> The backup is pending creation.
+        #   * `state:READY` --> The backup is fully created and ready for use.
+        #   * `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")`
+        #   --> The backup name contains the string "howl" and start_time
+        #   of the backup is before 2018-03-28T14:50:00Z.
+        #   * `size_bytes > 10000000000` --> The backup's size is greater than 10GB
+        # @param [String] order_by
+        #   An expression for specifying the sort order of the results of the request.
+        #   The string value should specify one or more fields in Backup. The full
+        #   syntax is described at https://aip.dev/132#ordering.
+        #   Fields supported are:
+        #   * name
+        #   * source_table
+        #   * expire_time
+        #   * start_time
+        #   * end_time
+        #   * size_bytes
+        #   * state
+        #   For example, "start_time". The default sorting order is ascending.
+        #   To specify descending order for the field, a suffix " desc" should
+        #   be appended to the field name. For example, "start_time desc".
+        #   Redundant space characters in the syntax are insigificant.
+        #   If order_by is empty, results will be sorted by `start_time` in descending
+        #   order starting from the most recently created backup.
+        # @param [Fixnum] page_size
+        #   Number of backups to be returned in the response. If 0 or
+        #   less, defaults to the server's maximum allowed page size.
+        # @param [String] page_token
+        #   If non-empty, `page_token` should contain a
+        #   next_page_token from a
+        #   previous ListBackupsResponse to the same `parent` and with the same
+        #   `filter`.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BigtableadminV2::ListBackupsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BigtableadminV2::ListBackupsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_instance_cluster_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+parent}/backups', options)
+          command.response_representation = Google::Apis::BigtableadminV2::ListBackupsResponse::Representation
+          command.response_class = Google::Apis::BigtableadminV2::ListBackupsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['filter'] = filter unless filter.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Updates a pending or completed Cloud Bigtable Backup.
+        # @param [String] name
+        #   A globally unique identifier for the backup which cannot be
+        #   changed. Values are of the form
+        #   `projects/`project`/instances/`instance`/clusters/`cluster`/
+        #   backups/_a-zA-Z0-9*`
+        #   The final segment of the name must be between 1 and 50 characters
+        #   in length.
+        #   The backup is stored in the cluster identified by the prefix of the backup
+        #   name of the form
+        #   `projects/`project`/instances/`instance`/clusters/`cluster``.
+        # @param [Google::Apis::BigtableadminV2::Backup] backup_object
+        # @param [String] update_mask
+        #   Required. A mask specifying which fields (e.g. `expire_time`) in the
+        #   Backup resource should be updated. This mask is relative to the Backup
+        #   resource, not to the request message. The field mask must always be
+        #   specified; this prevents any future fields from being erased accidentally
+        #   by clients that do not know about them.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BigtableadminV2::Backup] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BigtableadminV2::Backup]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def patch_project_instance_cluster_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2/{+name}', options)
+          command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation
+          command.request_object = backup_object
+          command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation
+          command.response_class = Google::Apis::BigtableadminV2::Backup
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Sets the access control policy on a Table resource.
         # Replaces any existing policy.
         # @param [String] resource
@@ -1322,6 +1578,48 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Create a new table by restoring from a completed backup. The new table
+        # must be in the same instance as the instance containing the backup.  The
+        # returned table long-running operation can
+        # be used to track the progress of the operation, and to cancel it.  The
+        # metadata field type is
+        # RestoreTableMetadata.  The
+        # response type is
+        # Table, if successful.
+        # @param [String] parent
+        #   Required. The name of the instance in which to create the restored
+        #   table. This instance must be the parent of the source backup. Values are
+        #   of the form `projects/<project>/instances/<instance>`.
+        # @param [Google::Apis::BigtableadminV2::RestoreTableRequest] restore_table_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::BigtableadminV2::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def restore_table(parent, restore_table_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+parent}/tables:restore', options)
+          command.request_representation = Google::Apis::BigtableadminV2::RestoreTableRequest::Representation
+          command.request_object = restore_table_request_object
+          command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
+          command.response_class = Google::Apis::BigtableadminV2::Operation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Sets the access control policy on a Table resource.
         # Replaces any existing policy.
         # @param [String] resource