class Google::Apis::FileV1beta1::CloudFilestoreService
Cloud Filestore API
The Cloud Filestore API is used for creating and managing cloud file servers.
@example
require 'google/apis/file_v1beta1' File = Google::Apis::FileV1beta1 # Alias the module service = File::CloudFilestoreService.new
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
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.
Public Class Methods
# File lib/google/apis/file_v1beta1/service.rb, line 45 def initialize super('https://file.googleapis.com/', '', client_name: 'google-apis-file_v1beta1', client_version: Google::Apis::FileV1beta1::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
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.
@param [Google::Apis::FileV1beta1::CancelOperationRequest] cancel_operation_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::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::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
# File lib/google/apis/file_v1beta1/service.rb, line 760 def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options) command.request_representation = Google::Apis::FileV1beta1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::FileV1beta1::Empty::Representation command.response_class = Google::Apis::FileV1beta1::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
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
# File lib/google/apis/file_v1beta1/service.rb, line 156 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
Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier). @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**.
@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.
@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
# File lib/google/apis/file_v1beta1/service.rb, line 346 def create_project_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/instances', options) command.request_representation = Google::Apis::FileV1beta1::Instance::Representation command.request_object = instance_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['instanceId'] = instance_id unless instance_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
Creates a snapshot. @param [String] parent
Required. The Filestore Instance to create the snapshots of, in the format ` projects/`project_id`/locations/`location`/instances/`instance_id``
@param [Google::Apis::FileV1beta1::Snapshot] snapshot_object @param [String] snapshot_id
Required. The ID to use for the snapshot. The ID must be unique within the specified instance. 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
# File lib/google/apis/file_v1beta1/service.rb, line 573 def create_project_location_instance_snapshot(parent, snapshot_object = nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/snapshots', options) command.request_representation = Google::Apis::FileV1beta1::Snapshot::Representation command.request_object = snapshot_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['snapshotId'] = snapshot_id unless snapshot_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
# File lib/google/apis/file_v1beta1/service.rb, line 190 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
Deletes an instance. @param [String] name
Required. The instance resource name, in the format `projects/`project_id`/ locations/`location`/instances/`instance_id``
@param [Boolean] force
If set to true, any snapshots of the instance will also be deleted. (Otherwise, the request will only work if the instance has no snapshots.)
@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
# File lib/google/apis/file_v1beta1/service.rb, line 383 def delete_project_location_instance(name, force: nil, 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['force'] = force unless force.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 snapshot. @param [String] name
Required. The snapshot resource name, in the format `projects/`project_id`/ locations/`location`/instances/`instance_id`/snapshots/`snapshot_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
# File lib/google/apis/file_v1beta1/service.rb, line 607 def delete_project_location_instance_snapshot(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
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
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::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::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
# File lib/google/apis/file_v1beta1/service.rb, line 795 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::FileV1beta1::Empty::Representation command.response_class = Google::Apis::FileV1beta1::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 information about a location. @param [String] name
Resource name for the location.
@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::Location] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::Location]
@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
# File lib/google/apis/file_v1beta1/service.rb, line 72 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::FileV1beta1::Location::Representation command.response_class = Google::Apis::FileV1beta1::Location 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
# File lib/google/apis/file_v1beta1/service.rb, line 221 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
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``.
@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::Instance] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::Instance]
@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
# File lib/google/apis/file_v1beta1/service.rb, line 415 def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::FileV1beta1::Instance::Representation command.response_class = Google::Apis::FileV1beta1::Instance 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 snapshot. @param [String] name
Required. The snapshot resource name, in the format `projects/`project_id`/ locations/`location`/instances/`instance_id`/snapshots/`snapshot_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::Snapshot] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::Snapshot]
@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
# File lib/google/apis/file_v1beta1/service.rb, line 638 def get_project_location_instance_snapshot(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::FileV1beta1::Snapshot::Representation command.response_class = Google::Apis::FileV1beta1::Snapshot 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 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
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
# File lib/google/apis/file_v1beta1/service.rb, line 826 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, '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
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
# File lib/google/apis/file_v1beta1/service.rb, line 264 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
Lists all snapshots in a project for either a specified location or for all locations. @param [String] parent
Required. The instance for which to retrieve snapshot information, in the format `projects/`project_id`/locations/`location`/instances/`instance_id``.
@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::ListSnapshotsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::ListSnapshotsResponse]
@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
# File lib/google/apis/file_v1beta1/service.rb, line 679 def list_project_location_instance_snapshots(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}/snapshots', options) command.response_representation = Google::Apis::FileV1beta1::ListSnapshotsResponse::Representation command.response_class = Google::Apis::FileV1beta1::ListSnapshotsResponse 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
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.
@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::ListInstancesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::ListInstancesResponse]
@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
# File lib/google/apis/file_v1beta1/service.rb, line 458 def list_project_location_instances(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}/instances', options) command.response_representation = Google::Apis::FileV1beta1::ListInstancesResponse::Representation command.response_class = Google::Apis::FileV1beta1::ListInstancesResponse 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
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
The standard list filter.
@param [Fixnum] page_size
The standard list page size.
@param [String] page_token
The standard list page token.
@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::ListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::ListOperationsResponse]
@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
# File lib/google/apis/file_v1beta1/service.rb, line 869 def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}/operations', options) command.response_representation = Google::Apis::FileV1beta1::ListOperationsResponse::Representation command.response_class = Google::Apis::FileV1beta1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.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
Lists information about the supported locations for this service. @param [String] name
The resource that owns the locations collection, if applicable.
@param [String] filter
A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [ AIP-160](https://google.aip.dev/160).
@param [Boolean] include_unrevealed_locations
If true, the returned list will include locations which are not yet revealed.
@param [Fixnum] page_size
The maximum number of results to return. If not set, the service selects a default.
@param [String] page_token
A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
@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::ListLocationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FileV1beta1::ListLocationsResponse]
@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
# File lib/google/apis/file_v1beta1/service.rb, line 114 def list_project_locations(name, filter: nil, include_unrevealed_locations: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}/locations', options) command.response_representation = Google::Apis::FileV1beta1::ListLocationsResponse::Representation command.response_class = Google::Apis::FileV1beta1::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['includeUnrevealedLocations'] = include_unrevealed_locations unless include_unrevealed_locations.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
# File lib/google/apis/file_v1beta1/service.rb, line 303 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
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``.
@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"
@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
# File lib/google/apis/file_v1beta1/service.rb, line 498 def patch_project_location_instance(name, instance_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::Instance::Representation command.request_object = instance_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
Updates the settings of a specific snapshot. @param [String] name
Output only. The resource name of the snapshot, in the format `projects/` project_id`/locations/`location_id`/instances/`instance_id`/snapshots/` snapshot_id``.
@param [Google::Apis::FileV1beta1::Snapshot] snapshot_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
# File lib/google/apis/file_v1beta1/service.rb, line 719 def patch_project_location_instance_snapshot(name, snapshot_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::Snapshot::Representation command.request_object = snapshot_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
Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier). @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
# File lib/google/apis/file_v1beta1/service.rb, line 535 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
Protected Instance Methods
# File lib/google/apis/file_v1beta1/service.rb, line 884 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end