class Google::Apis::FirebasestorageV1beta::FirebasestorageService
Cloud Storage for Firebase API
The Cloud Storage for Firebase API enables programmatic management of Cloud
Storage buckets for use in Firebase projects
@example
require 'google/apis/firebasestorage_v1beta' Firebasestorage = Google::Apis::FirebasestorageV1beta # Alias the module service = Firebasestorage::FirebasestorageService.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/firebasestorage_v1beta/service.rb, line 46 def initialize super('https://firebasestorage.googleapis.com/', '', client_name: 'google-apis-firebasestorage_v1beta', client_version: Google::Apis::FirebasestorageV1beta::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Links a Google
Cloud Storage bucket to a Firebase project. @param [String] bucket
Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/`project_number`/buckets/`bucket_id``.
@param [Google::Apis::FirebasestorageV1beta::AddFirebaseRequest] add_firebase_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::FirebasestorageV1beta::Bucket] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasestorageV1beta::Bucket]
@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/firebasestorage_v1beta/service.rb, line 75 def add_bucket_firebase(bucket, add_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+bucket}:addFirebase', options) command.request_representation = Google::Apis::FirebasestorageV1beta::AddFirebaseRequest::Representation command.request_object = add_firebase_request_object command.response_representation = Google::Apis::FirebasestorageV1beta::Bucket::Representation command.response_class = Google::Apis::FirebasestorageV1beta::Bucket command.params['bucket'] = bucket unless bucket.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 a single linked storage bucket. @param [String] name
Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/`project_number`/buckets/`bucket_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::FirebasestorageV1beta::Bucket] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasestorageV1beta::Bucket]
@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/firebasestorage_v1beta/service.rb, line 108 def get_project_bucket(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', options) command.response_representation = Google::Apis::FirebasestorageV1beta::Bucket::Representation command.response_class = Google::Apis::FirebasestorageV1beta::Bucket 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 the linked storage buckets for a project. @param [String] parent
Required. Resource name of the parent Firebase project, `projects/` project_number``.
@param [Fixnum] page_size
The maximum number of buckets to return. If not set, the server will use a reasonable default.
@param [String] page_token
A page token, received from a previous `ListBuckets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBuckets` must match the call that provided the 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::FirebasestorageV1beta::ListBucketsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasestorageV1beta::ListBucketsResponse]
@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/firebasestorage_v1beta/service.rb, line 146 def list_project_buckets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+parent}/buckets', options) command.response_representation = Google::Apis::FirebasestorageV1beta::ListBucketsResponse::Representation command.response_class = Google::Apis::FirebasestorageV1beta::ListBucketsResponse command.params['parent'] = parent unless parent.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
Unlinks a linked Google
Cloud Storage bucket from a Firebase project. @param [String] bucket
Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/`project_number`/buckets/`bucket_id``.
@param [Google::Apis::FirebasestorageV1beta::RemoveFirebaseRequest] remove_firebase_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::FirebasestorageV1beta::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::FirebasestorageV1beta::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/firebasestorage_v1beta/service.rb, line 180 def remove_bucket_firebase(bucket, remove_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+bucket}:removeFirebase', options) command.request_representation = Google::Apis::FirebasestorageV1beta::RemoveFirebaseRequest::Representation command.request_object = remove_firebase_request_object command.response_representation = Google::Apis::FirebasestorageV1beta::Empty::Representation command.response_class = Google::Apis::FirebasestorageV1beta::Empty command.params['bucket'] = bucket unless bucket.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/firebasestorage_v1beta/service.rb, line 194 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end