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

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

Overview

Firebase Hosting API

The Firebase Hosting REST API enables programmatic and customizable deployments to your Firebase-hosted sites. Use this REST API to deploy new or updated hosting configurations and content files.

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.



47
48
49
50
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 47

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.



40
41
42
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 40

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.



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

def quota_user
  @quota_user
end

Instance Method Details

#clone_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Operation

Creates a new version on the target site using the content of the specified version.

Parameters:

  • parent (String) —

    Required. The target site where the cloned version will reside, in the format: sites/site``

  • clone_version_request_object (Google::Apis::FirebasehostingV1beta1::CloneVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



426
427
428
429
430
431
432
433
434
435
436
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 426

def clone_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/versions:clone', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::CloneVersionRequest::Representation
  command.request_object = clone_version_request_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



178
179
180
181
182
183
184
185
186
187
188
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 178

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) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 353

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) (defaults to: nil) —

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

  • version_id (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 466

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



210
211
212
213
214
215
216
217
218
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 210

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



501
502
503
504
505
506
507
508
509
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 501

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_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Operation

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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

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

Gets the Hosting metadata for a specific site.

Parameters:

  • name (String) —

    Required. The site for which to get the SiteConfig, in the format: sites/site-name/config

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



240
241
242
243
244
245
246
247
248
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 240

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) (defaults to: nil) —

    The page size to return. Defaults to 50.

  • page_token (String) (defaults to: nil) —

    The next_page_token from a previous request, if provided.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



275
276
277
278
279
280
281
282
283
284
285
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 275

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) (defaults to: nil) —

    The page size to return. Defaults to 100.

  • page_token (String) (defaults to: nil) —

    The next_page_token from a previous request, if provided.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



391
392
393
394
395
396
397
398
399
400
401
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 391

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) (defaults to: nil) —

    The page size to return. Defaults to 1000.

  • page_token (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 668

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

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

Lists the versions that have been created on the specified site. Will include filtering in the future.

Parameters:

  • parent (String) —

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

  • filter (String) (defaults to: nil) —

    The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100

  • page_token (String) (defaults to: nil) —

    The next_page_token from a previous request, if provided.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 545

def list_site_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/versions', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListVersionsResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListVersionsResponse
  command.params['parent'] = parent unless parent.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

#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) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 593

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



628
629
630
631
632
633
634
635
636
637
638
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 628

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_config(name, site_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::SiteConfig

Sets the Hosting metadata for a specific site.

Parameters:

  • name (String) —

    Required. The site for which to update the SiteConfig, in the format: sites/site-name/config

  • site_config_object (Google::Apis::FirebasehostingV1beta1::SiteConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    A set of field names from your site configuration 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 max_versions will be used.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 143

def update_site_config(name, site_config_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::SiteConfig::Representation
  command.request_object = site_config_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::SiteConfig::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::SiteConfig
  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

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



310
311
312
313
314
315
316
317
318
319
320
 
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 310

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