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

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

Overview

Firebase Hosting API

The Firebase Hosting REST API enables programmatic and customizable management and deployments to your Firebase-hosted sites. Use this REST API to create and manage channels and sites as well as 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:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://firebasehosting.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FirebaseHostingService

Returns a new instance of FirebaseHostingService.



50
51
52
53
54
55
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 50

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-firebasehosting_v1beta1',
        client_version: Google::Apis::FirebasehostingV1beta1::GEM_VERSION)
  @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.



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

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.



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

def quota_user
  @quota_user
end

Instance Method Details

#clone_project_site_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 specified target site using the content of the specified version.

Parameters:

  • parent (String) —

    Required. The target site for the cloned version, in the format: sites/ SITE_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1278

def clone_project_site_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

#clone_site_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 specified target site using the content of the specified version.

Parameters:

  • parent (String) —

    Required. The target site for the cloned version, in the format: sites/ SITE_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2242

def clone_site_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_project_site(parent, site_object = nil, site_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Site

Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.

Parameters:

  • parent (String) —

    Required. The Firebase project in which to create a Hosting site, in the format: projects/PROJECT_IDENTIFIER Refer to the Site name field for details about PROJECT_IDENTIFIER values.

  • site_object (Google::Apis::FirebasehostingV1beta1::Site) (defaults to: nil)
  • site_id (String) (defaults to: nil) —

    Required. Immutable. A globally unique identifier for the Hosting site. This identifier is used to construct the Firebase-provisioned subdomains for the site, so it must also be a valid domain name label.

  • validate_only (Boolean) (defaults to: nil) —

    Optional. If set, validates that the site_id is available and that the request would succeed, returning the expected resulting site or error.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 119

def create_project_site(parent, site_object = nil, site_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/sites', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Site
  command.params['parent'] = parent unless parent.nil?
  command.query['siteId'] = site_id unless site_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.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_project_site_channel(parent, channel_object = nil, channel_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Channel

Creates a new channel in the specified site.

Parameters:

  • parent (String) —

    Required. The site in which to create this channel, in the format: sites/ SITE_ID

  • channel_object (Google::Apis::FirebasehostingV1beta1::Channel) (defaults to: nil)
  • channel_id (String) (defaults to: nil) —

    Required. Immutable. A unique ID within the site that identifies the channel.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 380

def create_project_site_channel(parent, channel_object = nil, channel_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/channels', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Channel
  command.params['parent'] = parent unless parent.nil?
  command.query['channelId'] = channel_id unless channel_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

#create_project_site_channel_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 appropriate URL(s).

Parameters:

  • parent (String) —

    Required. The site or channel to which the release belongs, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

  • 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_ID/versions/ VERSION_ID The SITE_ID in this version identifier must match the SITE_ID 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 563

def create_project_site_channel_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_project_site_custom_domain(parent, custom_domain_object = nil, custom_domain_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Operation

Creates a CustomDomain.

Parameters:

  • parent (String) —

    Required. The custom domain's parent, specifically a Firebase Hosting Site.

  • custom_domain_object (Google::Apis::FirebasehostingV1beta1::CustomDomain) (defaults to: nil)
  • custom_domain_id (String) (defaults to: nil) —

    Required. The ID of the CustomDomain, which is the domain name you'd like to use with Firebase Hosting.

  • validate_only (Boolean) (defaults to: nil) —

    If true, Hosting validates that it's possible to complete your request but doesn't actually create a new CustomDomain.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 680

def create_project_site_custom_domain(parent, custom_domain_object = nil, custom_domain_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/customDomains', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::CustomDomain::Representation
  command.request_object = custom_domain_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['customDomainId'] = custom_domain_id unless custom_domain_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.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_project_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 993

def create_project_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_project_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 appropriate URL(s).

Parameters:

  • parent (String) —

    Required. The site or channel to which the release belongs, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

  • 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_ID/versions/ VERSION_ID The SITE_ID in this version identifier must match the SITE_ID 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1165

def create_project_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_project_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 the specified site.

Parameters:

  • parent (String) —

    Required. The site in which to create the version, in the format: sites/ SITE_ID

  • 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 was only specified for legacy version creations, and should be blank.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1318

def create_project_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

#create_site_channel(parent, channel_object = nil, channel_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Channel

Creates a new channel in the specified site.

Parameters:

  • parent (String) —

    Required. The site in which to create this channel, in the format: sites/ SITE_ID

  • channel_object (Google::Apis::FirebasehostingV1beta1::Channel) (defaults to: nil)
  • channel_id (String) (defaults to: nil) —

    Required. Immutable. A unique ID within the site that identifies the channel.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1662

def create_site_channel(parent, channel_object = nil, channel_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/channels', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Channel
  command.params['parent'] = parent unless parent.nil?
  command.query['channelId'] = channel_id unless channel_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

#create_site_channel_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 appropriate URL(s).

Parameters:

  • parent (String) —

    Required. The site or channel to which the release belongs, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

  • 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_ID/versions/ VERSION_ID The SITE_ID in this version identifier must match the SITE_ID 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1845

def create_site_channel_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_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1957

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 appropriate URL(s).

Parameters:

  • parent (String) —

    Required. The site or channel to which the release belongs, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

  • 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_ID/versions/ VERSION_ID The SITE_ID in this version identifier must match the SITE_ID 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2129

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 the specified site.

Parameters:

  • parent (String) —

    Required. The site in which to create the version, in the format: sites/ SITE_ID

  • 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 was only specified for legacy version creations, and should be blank.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2282

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

Deletes the specified Hosting Site from the specified parent Firebase project.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the Site name field for details about PROJECT_IDENTIFIER values.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



156
157
158
159
160
161
162
163
164
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 156

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

Deletes the specified channel of the specified site. The live channel cannot be deleted.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



415
416
417
418
419
420
421
422
423
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 415

def delete_project_site_channel(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_project_site_custom_domain(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Operation

Deletes the specified CustomDomain.

Parameters:

  • name (String) —

    Required. The name of the CustomDomain to delete.

  • allow_missing (Boolean) (defaults to: nil) —

    If true, the request succeeds even if the CustomDomain doesn't exist.

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

    A tag that represents the state of the CustomDomain as you know it. If present, the supplied tag must match the current value on your CustomDomain, or the request fails.

  • validate_only (Boolean) (defaults to: nil) —

    If true, Hosting validates that it's possible to complete your request but doesn't actually delete the CustomDomain.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 723

def delete_project_site_custom_domain(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '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['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['validateOnly'] = validate_only unless validate_only.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_project_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1025

def delete_project_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_project_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 fully-qualified resource name for the version, in the format: sites/SITE_ID/versions/VERSION_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1353

def delete_project_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

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

Deletes the specified channel of the specified site. The live channel cannot be deleted.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1697
1698
1699
1700
1701
1702
1703
1704
1705
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1697

def delete_site_channel(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_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1989
1990
1991
1992
1993
1994
1995
1996
1997
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1989

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 fully-qualified resource name for the version, in the format: sites/SITE_ID/versions/VERSION_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2317
2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2317

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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



78
79
80
81
82
83
84
85
86
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 78

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

Gets the specified Hosting Site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the Site name field for details about PROJECT_IDENTIFIER values. Since a SITE_ID is a globally unique identifier, you can also use the unique sub-collection resource access pattern, in the format: projects/-/sites/ SITE_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 191

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

Retrieves information for the specified channel of the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



446
447
448
449
450
451
452
453
454
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 446

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

Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the Hosting release, in either of the following formats: - sites/SITE_ID/channels/CHANNEL_ID/releases/ RELEASE_ID - sites/SITE_ID/releases/RELEASE_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



600
601
602
603
604
605
606
607
608
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 600

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



222
223
224
225
226
227
228
229
230
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 222

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

Gets the specified CustomDomain.

Parameters:

  • name (String) —

    Required. The name of the CustomDomain 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



756
757
758
759
760
761
762
763
764
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 756

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

Gets the latest state of a long-running operation. 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



913
914
915
916
917
918
919
920
921
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 913

def get_project_site_custom_domain_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_project_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1055

def get_project_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

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

Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the Hosting release, in either of the following formats: - sites/SITE_ID/channels/CHANNEL_ID/releases/ RELEASE_ID - sites/SITE_ID/releases/RELEASE_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1202

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

Get the specified version that has been created for the specified site. This can include versions that were created for the default live channel or for any active preview channels for the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the version, in the format: sites/SITE_ID/versions/VERSION_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1386
1387
1388
1389
1390
1391
1392
1393
1394
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1386

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

Retrieves information for the specified channel of the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1728

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

Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the Hosting release, in either of the following formats: - sites/SITE_ID/channels/CHANNEL_ID/releases/ RELEASE_ID - sites/SITE_ID/releases/RELEASE_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1882

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1588
1589
1590
1591
1592
1593
1594
1595
1596
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1588

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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2019
2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2019

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

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

Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the Hosting release, in either of the following formats: - sites/SITE_ID/channels/CHANNEL_ID/releases/ RELEASE_ID - sites/SITE_ID/releases/RELEASE_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2166
2167
2168
2169
2170
2171
2172
2173
2174
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2166

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

Get the specified version that has been created for the specified site. This can include versions that were created for the default live channel or for any active preview channels for the specified site.

Parameters:

  • name (String) —

    Required. The fully-qualified resource name for the version, in the format: sites/SITE_ID/versions/VERSION_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2350

def get_site_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Version
  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_project_site_channel_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 for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • parent (String) —

    Required. The site or channel for which to list releases, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

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

    The maximum number of releases to return. The service may return a lower number if fewer releases exist than this maximum number. If unspecified, defaults to 100.

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

    A token from a previous call to releases.list or channels.releases.list that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 641

def list_project_site_channel_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_project_site_channels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListChannelsResponse

Lists the channels for the specified site. All sites have a default live channel.

Parameters:

  • parent (String) —

    Required. The site for which to list channels, in the format: sites/SITE_ID

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

    The maximum number of channels to return. The service may return a lower number if fewer channels exist than this maximum number. If unspecified, defaults to 10. The maximum value is 100; values above 100 will be coerced to 100.

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

    A token from a previous call to ListChannels that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 485

def list_project_site_channels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/channels', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListChannelsResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListChannelsResponse
  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_project_site_custom_domain_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 957

def list_project_site_custom_domain_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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_project_site_custom_domains(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListCustomDomainsResponse

Lists each CustomDomain associated with the specified parent Hosting site. Returns CustomDomains in a consistent, but undefined, order to facilitate pagination.

Parameters:

  • parent (String) —

    Required. The Firebase Hosting Site with CustomDomain entities you'd like to list.

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

    The max number of CustomDomain entities to return in a request. Defaults to 10.

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

    A token from a previous call to ListCustomDomains that tells the server where to resume listing.

  • show_deleted (Boolean) (defaults to: nil) —

    If true, the request returns soft-deleted CustomDomains that haven't been fully-deleted yet. To restore deleted CustomDomains, make an UndeleteCustomDomain request.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 799

def list_project_site_custom_domains(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/customDomains', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListCustomDomainsResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListCustomDomainsResponse
  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['showDeleted'] = show_deleted unless show_deleted.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_project_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1090

def list_project_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_project_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 for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • parent (String) —

    Required. The site or channel for which to list releases, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

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

    The maximum number of releases to return. The service may return a lower number if fewer releases exist than this maximum number. If unspecified, defaults to 100.

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

    A token from a previous call to releases.list or channels.releases.list that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1243

def list_project_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_project_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 version for which to list files, in the format: sites/SITE_ID / versions/VERSION_ID

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

    The maximum number of version files to return. The service may return a lower number if fewer version files exist than this maximum number. If unspecified, defaults to 1000.

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

    A token from a previous call to ListVersionFiles that tells the server where to resume listing.

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

    The type of files that should be listed for the specified version.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1554

def list_project_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_project_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 for the specified site. This list includes versions for both the default live channel and any active preview channels for the specified site.

Parameters:

  • parent (String) —

    Required. The site or channel for which to list versions, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

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

    A filter string used to return a subset of versions in the response. The currently supported fields for filtering are: name, status, and create_time. Learn more about filtering in Google's AIP 160 standard.

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

    The maximum number of versions to return. The service may return a lower number if fewer versions exist than this maximum number. If unspecified, defaults to 25. The maximum value is 100; values above 100 will be coerced to 100.

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

    A token from a previous call to ListVersions that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1432

def list_project_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

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

Lists each Hosting Site associated with the specified parent Firebase project.

Parameters:

  • parent (String) —

    Required. The Firebase project for which to list sites, in the format: projects/PROJECT_IDENTIFIER Refer to the Site name field for details about PROJECT_IDENTIFIER values.

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

    Optional. The maximum number of sites to return. The service may return a lower number if fewer sites exist than this maximum number. If unspecified, defaults to 40.

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

    Optional. A token from a previous call to ListSites that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 261

def list_project_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/sites', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListSitesResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListSitesResponse
  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_channel_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 for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • parent (String) —

    Required. The site or channel for which to list releases, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

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

    The maximum number of releases to return. The service may return a lower number if fewer releases exist than this maximum number. If unspecified, defaults to 100.

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

    A token from a previous call to releases.list or channels.releases.list that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1923

def list_site_channel_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_channels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListChannelsResponse

Lists the channels for the specified site. All sites have a default live channel.

Parameters:

  • parent (String) —

    Required. The site for which to list channels, in the format: sites/SITE_ID

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

    The maximum number of channels to return. The service may return a lower number if fewer channels exist than this maximum number. If unspecified, defaults to 10. The maximum value is 100; values above 100 will be coerced to 100.

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

    A token from a previous call to ListChannels that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1767

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2054

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 for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.

Parameters:

  • parent (String) —

    Required. The site or channel for which to list releases, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

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

    The maximum number of releases to return. The service may return a lower number if fewer releases exist than this maximum number. If unspecified, defaults to 100.

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

    A token from a previous call to releases.list or channels.releases.list that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2207

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 version for which to list files, in the format: sites/SITE_ID / versions/VERSION_ID

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

    The maximum number of version files to return. The service may return a lower number if fewer version files exist than this maximum number. If unspecified, defaults to 1000.

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

    A token from a previous call to ListVersionFiles that tells the server where to resume listing.

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

    The type of files that should be listed for the specified version.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2518

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 for the specified site. This list includes versions for both the default live channel and any active preview channels for the specified site.

Parameters:

  • parent (String) —

    Required. The site or channel for which to list versions, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID

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

    A filter string used to return a subset of versions in the response. The currently supported fields for filtering are: name, status, and create_time. Learn more about filtering in Google's AIP 160 standard.

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

    The maximum number of versions to return. The service may return a lower number if fewer versions exist than this maximum number. If unspecified, defaults to 25. The maximum value is 100; values above 100 will be coerced to 100.

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

    A token from a previous call to ListVersions that tells the server where to resume listing.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2396

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

Updates attributes of the specified Hosting Site.

Parameters:

  • name (String) —

    Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard.

  • site_object (Google::Apis::FirebasehostingV1beta1::Site) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    A set of field names from your Site that you want to update.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 303

def patch_project_site(name, site_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::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Site
  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

#patch_project_site_channel(name, channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Channel

Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn't already exist.

Parameters:

  • name (String) —

    The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID

  • channel_object (Google::Apis::FirebasehostingV1beta1::Channel) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    A comma-separated list of fields to be updated in this request.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 522

def patch_project_site_channel(name, channel_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::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Channel
  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

#patch_project_site_custom_domain(name, custom_domain_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Operation

Updates the specified CustomDomain.

Parameters:

  • name (String) —

    Output only. The fully-qualified name of the CustomDomain.

  • custom_domain_object (Google::Apis::FirebasehostingV1beta1::CustomDomain) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If true, Hosting creates the CustomDomain if it doesn't already exist.

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

    The set of field names from your CustomDomain that you want to update. A field will be overwritten if, and only if, it's in the mask. If you don't provide a mask, Hosting updates the entire CustomDomain.

  • validate_only (Boolean) (defaults to: nil) —

    If true, Hosting validates that it's possible to complete your request but doesn't actually create or update the CustomDomain.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 842

def patch_project_site_custom_domain(name, custom_domain_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::CustomDomain::Representation
  command.request_object = custom_domain_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.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_project_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 the specified version. This method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The supported state transitions for a version are from CREATED to FINALIZED. Use DeleteVersion to set the status of a version to DELETED.

Parameters:

  • name (String) —

    The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call CreateVersion.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1477

def patch_project_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

#patch_site_channel(name, channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Channel

Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn't already exist.

Parameters:

  • name (String) —

    The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID

  • channel_object (Google::Apis::FirebasehostingV1beta1::Channel) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    A comma-separated list of fields to be updated in this request.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1804

def patch_site_channel(name, channel_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::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Channel
  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

#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 the specified version. This method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The supported state transitions for a version are from CREATED to FINALIZED. Use DeleteVersion to set the status of a version to DELETED.

Parameters:

  • name (String) —

    The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call CreateVersion.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2441

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_project_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 the specified version. Each file must be under 2 GB.

Parameters:

  • parent (String) —

    Required. The version to which to add files, in the format: sites/SITE_ID / versions/VERSION_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1512

def populate_project_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

#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 the specified version. Each file must be under 2 GB.

Parameters:

  • parent (String) —

    Required. The version to which to add files, in the format: sites/SITE_ID / versions/VERSION_ID

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2476

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

#undelete_custom_domain(name, undelete_custom_domain_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Operation

Undeletes the specified CustomDomain if it has been soft-deleted. Hosting retains soft-deleted custom domains for around 30 days before permanently deleting them.

Parameters:

  • name (String) —

    Required. The name of the CustomDomain to delete.

  • undelete_custom_domain_request_object (Google::Apis::FirebasehostingV1beta1::UndeleteCustomDomainRequest) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 880

def undelete_custom_domain(name, undelete_custom_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:undelete', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::UndeleteCustomDomainRequest::Representation
  command.request_object = undelete_custom_domain_request_object
  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

#update_project_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 343

def update_project_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_project_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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1125

def update_project_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

#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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1625

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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 2089

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