google-api-client 0.42.2 → 0.45.0

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

@@ -22,6 +22,12 @@ module Google
   module Apis
     module FileV1beta1
       
+      class Backup
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class CancelOperationRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -94,6 +100,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 ListInstancesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -142,12 +154,35 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RestoreInstanceRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Status
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Backup
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :capacity_gb, :numeric_string => true, as: 'capacityGb'
+          property :create_time, as: 'createTime'
+          property :description, as: 'description'
+          property :download_bytes, :numeric_string => true, as: 'downloadBytes'
+          hash :labels, as: 'labels'
+          property :name, as: 'name'
+          property :source_file_share, as: 'sourceFileShare'
+          property :source_instance, as: 'sourceInstance'
+          property :source_instance_tier, as: 'sourceInstanceTier'
+          property :state, as: 'state'
+          property :storage_bytes, :numeric_string => true, as: 'storageBytes'
+        end
+      end
+      
       class CancelOperationRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -167,6 +202,7 @@ module Google
           property :name, as: 'name'
           collection :nfs_export_options, as: 'nfsExportOptions', class: Google::Apis::FileV1beta1::NfsExportOptions, decorator: Google::Apis::FileV1beta1::NfsExportOptions::Representation
       
+          property :source_backup, as: 'sourceBackup'
         end
       end
       
@@ -279,6 +315,16 @@ module Google
         end
       end
       
+      class ListBackupsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :backups, as: 'backups', class: Google::Apis::FileV1beta1::Backup, decorator: Google::Apis::FileV1beta1::Backup::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+          collection :unreachable, as: 'unreachable'
+        end
+      end
+      
       class ListInstancesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -364,6 +410,15 @@ module Google
         end
       end
       
+      class RestoreInstanceRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :file_share, as: 'fileShare'
+          property :source_backup, as: 'sourceBackup'
+          property :source_snapshot, as: 'sourceSnapshot'
+        end
+      end
+      
       class Status
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -83,8 +83,7 @@ module Google
         # @param [String] filter
         #   The standard list filter.
         # @param [Boolean] include_unrevealed_locations
-        #   If true, the returned list will include locations which are not yet
-        #   revealed.
+        #   If true, the returned list will include locations which are not yet revealed.
         # @param [Fixnum] page_size
         #   The standard list page size.
         # @param [String] page_token
@@ -120,17 +119,205 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Creates a backup.
+        # @param [String] parent
+        #   Required. The backup's project and location, in the format projects/`
+        #   project_id`/locations/`location`. In Cloud Filestore, backup locations map to
+        #   GCP regions, for example **us-west1**.
+        # @param [Google::Apis::FileV1beta1::Backup] backup_object
+        # @param [String] backup_id
+        #   Required. The ID to use for the backup. The ID must be unique within the
+        #   specified project and location. This value must start with a lowercase letter
+        #   followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end
+        #   with a hyphen.
+        # @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::FileV1beta1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FileV1beta1::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_location_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+parent}/backups', options)
+          command.request_representation = Google::Apis::FileV1beta1::Backup::Representation
+          command.request_object = backup_object
+          command.response_representation = Google::Apis::FileV1beta1::Operation::Representation
+          command.response_class = Google::Apis::FileV1beta1::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 backup.
+        # @param [String] name
+        #   Required. The backup resource name, in the format projects/`project_id`/
+        #   locations/`location`/backups/`backup_id`
+        # @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::FileV1beta1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FileV1beta1::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 delete_project_location_backup(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v1beta1/{+name}', options)
+          command.response_representation = Google::Apis::FileV1beta1::Operation::Representation
+          command.response_class = Google::Apis::FileV1beta1::Operation
+          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 details of a specific backup.
+        # @param [String] name
+        #   Required. The backup resource name, in the format projects/`project_id`/
+        #   locations/`location`/backups/`backup_id`.
+        # @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::FileV1beta1::Backup] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FileV1beta1::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_location_backup(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+name}', options)
+          command.response_representation = Google::Apis::FileV1beta1::Backup::Representation
+          command.response_class = Google::Apis::FileV1beta1::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
+        
+        # Lists all backups in a project for either a specified location or for all
+        # locations.
+        # @param [String] parent
+        #   Required. The project and location for which to retrieve backup information,
+        #   in the format projects/`project_id`/locations/`location`. In Cloud Filestore,
+        #   backup locations map to GCP regions, for example **us-west1**. To retrieve
+        #   backup information for all locations, use "-" for the `location` value.
+        # @param [String] filter
+        #   List filter.
+        # @param [String] order_by
+        #   Sort results. Supported values are "name", "name desc" or "" (unsorted).
+        # @param [Fixnum] page_size
+        #   The maximum number of items to return.
+        # @param [String] page_token
+        #   The next_page_token value to use if there are additional results to retrieve
+        #   for this list request.
+        # @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::FileV1beta1::ListBackupsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FileV1beta1::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_location_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, 'v1beta1/{+parent}/backups', options)
+          command.response_representation = Google::Apis::FileV1beta1::ListBackupsResponse::Representation
+          command.response_class = Google::Apis::FileV1beta1::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 the settings of a specific backup.
+        # @param [String] name
+        #   Output only. The resource name of the backup, in the format projects/`
+        #   project_id`/locations/`location_id`/backups/`backup_id`.
+        # @param [Google::Apis::FileV1beta1::Backup] backup_object
+        # @param [String] update_mask
+        #   Required. Mask of fields to update. At least one path must be supplied in this
+        #   field.
+        # @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::FileV1beta1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FileV1beta1::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 patch_project_location_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1beta1/{+name}', options)
+          command.request_representation = Google::Apis::FileV1beta1::Backup::Representation
+          command.request_object = backup_object
+          command.response_representation = Google::Apis::FileV1beta1::Operation::Representation
+          command.response_class = Google::Apis::FileV1beta1::Operation
+          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
+        
         # Creates an instance.
         # @param [String] parent
-        #   Required. The instance's project and location, in the format
-        #   projects/`project_id`/locations/`location`. In Cloud Filestore,
-        #   locations map to GCP zones, for example **us-west1-b**.
+        #   Required. The instance's project and location, in the format projects/`
+        #   project_id`/locations/`location`. In Cloud Filestore, locations map to GCP
+        #   zones, for example **us-west1-b**.
         # @param [Google::Apis::FileV1beta1::Instance] instance_object
         # @param [String] instance_id
-        #   Required. The ID of the instance to create.
-        #   The ID must be unique within the specified project and location.
-        #   This value must start with a lowercase letter followed by up to 62
-        #   lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+        #   Required. The ID of the instance to create. The ID must be unique within the
+        #   specified project and location. This value must start with a lowercase letter
+        #   followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end
+        #   with a hyphen.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -163,8 +350,8 @@ module Google
         
         # Deletes an instance.
         # @param [String] name
-        #   Required. The instance resource name, in the format
-        #   projects/`project_id`/locations/`location`/instances/`instance_id`
+        #   Required. The instance resource name, in the format projects/`project_id`/
+        #   locations/`location`/instances/`instance_id`
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -194,8 +381,8 @@ module Google
         
         # Gets the details of a specific instance.
         # @param [String] name
-        #   Required. The instance resource name, in the format
-        #   projects/`project_id`/locations/`location`/instances/`instance_id`.
+        #   Required. The instance resource name, in the format projects/`project_id`/
+        #   locations/`location`/instances/`instance_id`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -223,14 +410,13 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists all instances in a project for either a specified location
-        # or for all locations.
+        # Lists all instances in a project for either a specified location or for all
+        # locations.
         # @param [String] parent
         #   Required. The project and location for which to retrieve instance information,
-        #   in the format projects/`project_id`/locations/`location`. In Cloud
-        #   Filestore, locations map to GCP zones, for example **us-west1-b**. To
-        #   retrieve instance information for all locations, use "-" for the `location`
-        #   value.
+        #   in the format projects/`project_id`/locations/`location`. In Cloud Filestore,
+        #   locations map to GCP zones, for example **us-west1-b**. To retrieve instance
+        #   information for all locations, use "-" for the `location` value.
         # @param [String] filter
         #   List filter.
         # @param [String] order_by
@@ -238,8 +424,8 @@ module Google
         # @param [Fixnum] page_size
         #   The maximum number of items to return.
         # @param [String] page_token
-        #   The next_page_token value to use if there are additional
-        #   results to retrieve for this list request.
+        #   The next_page_token value to use if there are additional results to retrieve
+        #   for this list request.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -273,17 +459,13 @@ module Google
         
         # Updates the settings of a specific instance.
         # @param [String] name
-        #   Output only. The resource name of the instance, in the format
-        #   projects/`project_id`/locations/`location_id`/instances/`instance_id`.
+        #   Output only. The resource name of the instance, in the format projects/`
+        #   project_id`/locations/`location_id`/instances/`instance_id`.
         # @param [Google::Apis::FileV1beta1::Instance] instance_object
         # @param [String] update_mask
-        #   Required. Mask of fields to update.  At least one path must be supplied in
-        #   this
-        #   field.  The elements of the repeated paths field may only include these
-        #   fields:
-        #   * "description"
-        #   * "file_shares"
-        #   * "labels"
+        #   Required. Mask of fields to update. At least one path must be supplied in this
+        #   field. The elements of the repeated paths field may only include these fields:
+        #   * "description" * "file_shares" * "labels"
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -314,15 +496,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Starts asynchronous cancellation on a long-running operation.  The server
-        # makes a best effort to cancel the operation, but success is not
-        # guaranteed.  If the server doesn't support this method, it returns
-        # `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
-        # Operations.GetOperation or
-        # other methods to check whether the cancellation succeeded or whether the
-        # operation completed despite cancellation. On successful cancellation,
-        # the operation is not deleted; instead, it becomes an operation with
-        # an Operation.error value with a google.rpc.Status.code of 1,
+        # Restores an existing instance's file share from a snapshot or backup.
+        # @param [String] name
+        #   Required. The resource name of the instance, in the format projects/`
+        #   project_id`/locations/`location_id`/instances/`instance_id`.
+        # @param [Google::Apis::FileV1beta1::RestoreInstanceRequest] restore_instance_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::FileV1beta1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FileV1beta1::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_instance(name, restore_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+name}:restore', options)
+          command.request_representation = Google::Apis::FileV1beta1::RestoreInstanceRequest::Representation
+          command.request_object = restore_instance_request_object
+          command.response_representation = Google::Apis::FileV1beta1::Operation::Representation
+          command.response_class = Google::Apis::FileV1beta1::Operation
+          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
+        
+        # Starts asynchronous cancellation on a long-running operation. The server makes
+        # a best effort to cancel the operation, but success is not guaranteed. If the
+        # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+        # Clients can use Operations.GetOperation or other methods to check whether the
+        # cancellation succeeded or whether the operation completed despite cancellation.
+        # On successful cancellation, the operation is not deleted; instead, it becomes
+        # an operation with an Operation.error value with a google.rpc.Status.code of 1,
         # corresponding to `Code.CANCELLED`.
         # @param [String] name
         #   The name of the operation resource to be cancelled.
@@ -356,10 +570,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes a long-running operation. This method indicates that the client is
-        # no longer interested in the operation result. It does not cancel the
-        # operation. If the server doesn't support this method, it returns
-        # `google.rpc.Code.UNIMPLEMENTED`.
+        # Deletes a long-running operation. This method indicates that the client is no
+        # longer interested in the operation result. It does not cancel the operation.
+        # If the server doesn't support this method, it returns `google.rpc.Code.
+        # UNIMPLEMENTED`.
         # @param [String] name
         #   The name of the operation resource to be deleted.
         # @param [String] fields
@@ -389,9 +603,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Gets the latest state of a long-running operation.  Clients can use this
-        # method to poll the operation result at intervals as recommended by the API
-        # service.
+        # Gets the latest state of a long-running operation. Clients can use this method
+        # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name
         #   The name of the operation resource.
         # @param [String] fields
@@ -421,15 +634,14 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists operations that match the specified filter in the request. If the
-        # server doesn't support this method, it returns `UNIMPLEMENTED`.
-        # NOTE: the `name` binding allows API services to override the binding
-        # to use different resource name schemes, such as `users/*/operations`. To
-        # override the binding, API services can add a binding such as
-        # `"/v1/`name=users/*`/operations"` to their service configuration.
-        # For backwards compatibility, the default name includes the operations
-        # collection id, however overriding users must ensure the name binding
-        # is the parent resource, without the operations collection id.
+        # Lists operations that match the specified filter in the request. If the server
+        # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
+        # binding allows API services to override the binding to use different resource
+        # name schemes, such as `users/*/operations`. To override the binding, API
+        # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
+        # service configuration. For backwards compatibility, the default name includes
+        # the operations collection id, however overriding users must ensure the name
+        # binding is the parent resource, without the operations collection id.
         # @param [String] name
         #   The name of the operation's parent resource.
         # @param [String] filter