Class: Google::Apis::FirebasehostingV1beta1::FirebaseHostingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/firebasehosting_v1beta1/service.rb

Overview

Firebase Hosting API

Examples:

require 'google/apis/firebasehosting_v1beta1'

Firebasehosting = Google::Apis::FirebasehostingV1beta1 # Alias the module
service = Firebasehosting::FirebaseHostingService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ FirebaseHostingService

Returns a new instance of FirebaseHostingService



45
46
47
48
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 45

def initialize
  super('https://firebasehosting.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



38
39
40
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (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.



43
44
45
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#create_site_domain(parent, domain_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Domain

Creates a domain mapping on the specified site.

Parameters:

  • parent (String) —

    Required. The parent to create the domain association for, in the format: sites/site-name

  • domain_object (Google::Apis::FirebasehostingV1beta1::Domain) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



72
73
74
75
76
77
78
79
80
81
82
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 72

def create_site_domain(parent, domain_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}/domains', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation
  command.request_object = domain_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Domain
  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

#create_site_release(parent, release_object = nil, version_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Release

Creates a new release which makes the content of the specified version actively display on the site.

Parameters:

  • parent (String) —

    The site that the release belongs to, in the format: sites/site-name

  • release_object (Google::Apis::FirebasehostingV1beta1::Release) (defaults to: nil)
  • version_name (String) —

    The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the parent parameter.

    This query parameter must be empty if the type field in the request body is SITE_DISABLE.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 247

def create_site_release(parent, release_object = nil, version_name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}/releases', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation
  command.request_object = release_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Release
  command.params['parent'] = parent unless parent.nil?
  command.query['versionName'] = version_name unless version_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

#create_site_version(parent, version_object = nil, size_bytes: nil, version_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Version

Creates a new version for a site.

Parameters:

  • parent (String) —

    Required. The parent to create the version for, in the format: sites/site-name

  • version_object (Google::Apis::FirebasehostingV1beta1::Version) (defaults to: nil)
  • size_bytes (Fixnum) —

    The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.

  • version_id (String) —

    A unique id for the new version. This is only specified for legacy version creations.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 325

def create_site_version(parent, version_object = nil, size_bytes: nil, version_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}/versions', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Version
  command.params['parent'] = parent unless parent.nil?
  command.query['sizeBytes'] = size_bytes unless size_bytes.nil?
  command.query['versionId'] = version_id unless version_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

#delete_site_domain(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Empty

Deletes the existing domain mapping on the specified site.

Parameters:

  • name (String) —

    Required. The name of the domain association to delete.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



104
105
106
107
108
109
110
111
112
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 104

def delete_site_domain(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::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

#delete_site_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Empty

Deletes the specified version.

Parameters:

  • name (String) —

    Required. The name of the version to be deleted, in the format: sites/site-name/versions/versionID

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



360
361
362
363
364
365
366
367
368
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 360

def delete_site_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::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

#get_site_domain(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Domain

Gets a domain mapping on the specified site.

Parameters:

  • name (String) —

    Required. The name of the domain configuration to get.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



134
135
136
137
138
139
140
141
142
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 134

def get_site_domain(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Domain
  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

#list_site_domains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListDomainsResponse

Lists the domains for the specified site.

Parameters:

  • parent (String) —

    Required. The parent for which to list domains, in the format: sites/site-name

  • page_size (Fixnum) —

    The page size to return. Defaults to 50.

  • page_token (String) —

    The next_page_token from a previous request, if provided.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



169
170
171
172
173
174
175
176
177
178
179
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 169

def list_site_domains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/domains', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListDomainsResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListDomainsResponse
  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

#list_site_releases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListReleasesResponse

Lists the releases that have been created on the specified site.

Parameters:

  • parent (String) —

    Required. The parent for which to list files, in the format: sites/site-name

  • page_size (Fixnum) —

    The page size to return. Defaults to 100.

  • page_token (String) —

    The next_page_token from a previous request, if provided.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



285
286
287
288
289
290
291
292
293
294
295
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 285

def list_site_releases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/releases', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse
  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

#list_site_version_files(parent, page_size: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse

Lists the remaining files to be uploaded for the specified version.

Parameters:

  • parent (String) —

    Required. The parent to list files for, in the format: sites/site-name/versions/versionID

  • page_size (Fixnum) —

    The page size to return. Defaults to 1000.

  • page_token (String) —

    The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.

  • status (String) —

    The type of files in the version that should be listed.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 480

def list_site_version_files(parent, page_size: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/files', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse
  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['status'] = status unless status.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_site_version(name, version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Version

Updates the specified metadata for a version. Note that this method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The only valid transition for a version is currently from a CREATED status to a FINALIZED status. Use DeleteVersion to set the status of a version to DELETED.

Parameters:

  • name (String) —

    The unique identifier for a version, in the format: sites/site-name/versions/versionID This name is provided in the response body when you call the CreateVersion endpoint.

  • version_object (Google::Apis::FirebasehostingV1beta1::Version) (defaults to: nil)
  • update_mask (String) —

    A set of field names from your version that you want to update.
    A field will be overwritten if, and only if, it's in the mask.
    If a mask is not provided then a default mask of only status will be used.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 405

def patch_site_version(name, version_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::FirebasehostingV1beta1::Version::Representation
  command.request_object = version_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Version
  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

#populate_site_version_files(parent, populate_version_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse

Adds content files to a version.

Parameters:

  • parent (String) —

    Required. The version to add files to, in the format: sites/site-name/versions/versionID

  • populate_version_files_request_object (Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



440
441
442
443
444
445
446
447
448
449
450
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 440

def populate_site_version_files(parent, populate_version_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}:populateFiles', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest::Representation
  command.request_object = populate_version_files_request_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse
  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

#update_site_domain(name, domain_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Domain

Updates the specified domain mapping, creating the mapping as if it does not exist.

Parameters:

  • name (String) —

    Required. The name of the domain association to update or create, if an association doesn't already exist.

  • domain_object (Google::Apis::FirebasehostingV1beta1::Domain) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



204
205
206
207
208
209
210
211
212
213
214
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 204

def update_site_domain(name, domain_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation
  command.request_object = domain_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Domain
  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