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 deployments to your Firebase-hosted sites. Use this REST API to deploy new or updated hosting configurations and content files.

Examples:

require 'google/apis/firebasehosting_v1beta1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeFirebaseHostingService

Returns a new instance of FirebaseHostingService.



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

def initialize
  super('https://firebasehosting.googleapis.com/', '',
        client_name: 'google-apis-firebasehosting_v1beta1',
        client_version: Google::Apis::FirebasehostingV1beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



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

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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

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

Parameters:

  • parent (String)

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



677
678
679
680
681
682
683
684
685
686
687
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 677

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

Parameters:

  • parent (String)

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1520

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_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 this channel should be created.

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

    Required. Immutable. A unique id within the site to identify 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



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

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 to which the release belongs, in the format: sites/ SITE_NAME

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

    The unique identifier for a version, in the format: sites/SITE_NAME /versions/ VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME in the parent parameter. This query parameter must be empty if the type field in the request body is SITE_DISABLE.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 356

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_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



430
431
432
433
434
435
436
437
438
439
440
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 430

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 to which the release belongs, in the format: sites/ SITE_NAME

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

    The unique identifier for a version, in the format: sites/SITE_NAME /versions/ VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME in the parent parameter. This query parameter must be empty if the type field in the request body is SITE_DISABLE.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



602
603
604
605
606
607
608
609
610
611
612
613
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 602

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_NAME

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

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

  • version_id (String) (defaults to: nil)

    A unique id for the new version. This is 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



717
718
719
720
721
722
723
724
725
726
727
728
729
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 717

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 this channel should be created.

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

    Required. Immutable. A unique id within the site to identify 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



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

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 to which the release belongs, in the format: sites/ SITE_NAME

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

    The unique identifier for a version, in the format: sites/SITE_NAME /versions/ VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME in the parent parameter. This query parameter must be empty if the type field in the request body is SITE_DISABLE.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



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

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



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1273

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 to which the release belongs, in the format: sites/ SITE_NAME

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

    The unique identifier for a version, in the format: sites/SITE_NAME /versions/ VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME in the parent parameter. This query parameter must be empty if the type field in the request body is SITE_DISABLE.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1445

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_NAME

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

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

  • version_id (String) (defaults to: nil)

    A unique id for the new version. This is 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



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1560

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

Deletes a channel of a site. The live channel cannot be deleted.

Parameters:

  • name (String)

    Required. The fully-qualified identifier for the site.

  • 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



212
213
214
215
216
217
218
219
220
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 212

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_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



462
463
464
465
466
467
468
469
470
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 462

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 name of the version to be deleted, in the format: sites/ SITE_NAME/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



752
753
754
755
756
757
758
759
760
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 752

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 a channel of a site. The live channel cannot be deleted.

Parameters:

  • name (String)

    Required. The fully-qualified identifier for the site.

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



1305
1306
1307
1308
1309
1310
1311
1312
1313
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1305

def delete_site_domain(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes the specified version.

Parameters:

  • name (String)

    Required. The name of the version to be deleted, in the format: sites/ SITE_NAME/versions/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



1595
1596
1597
1598
1599
1600
1601
1602
1603
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1595

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



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

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

Retrieves information for the specified channel of a site.

Parameters:

  • name (String)

    Required. The fully-qualified identifier for 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



242
243
244
245
246
247
248
249
250
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 242

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_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



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

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_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



492
493
494
495
496
497
498
499
500
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 492

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

Retrieves information for the specified channel of a site.

Parameters:

  • name (String)

    Required. The fully-qualified identifier for 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



1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1085

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_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



949
950
951
952
953
954
955
956
957
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 949

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



1335
1336
1337
1338
1339
1340
1341
1342
1343
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1335

def get_site_domain(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::Domain
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Parameters:

  • parent (String)

    Required. The site for which to list releases, in the format: sites/ SITE_NAME

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



396
397
398
399
400
401
402
403
404
405
406
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 396

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 from which to list channels.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token from a previous request, if provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



279
280
281
282
283
284
285
286
287
288
289
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 279

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_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



527
528
529
530
531
532
533
534
535
536
537
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 527

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

Parameters:

  • parent (String)

    Required. The site for which to list releases, in the format: sites/ SITE_NAME

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



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

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_NAME/ 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



915
916
917
918
919
920
921
922
923
924
925
926
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 915

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 on the specified site. Will include filtering in the future.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token from a previous request, if provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



793
794
795
796
797
798
799
800
801
802
803
804
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 793

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

Parameters:

  • parent (String)

    Required. The site for which to list releases, in the format: sites/ SITE_NAME

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



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1239

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 from which to list channels.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token from a previous request, if provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1122

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



1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1370

def list_site_domains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/domains', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListDomainsResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListDomainsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • parent (String)

    Required. The site for which to list releases, in the format: sites/ SITE_NAME

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



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1485

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_NAME/ 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



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1758

def list_site_version_files(parent, page_size: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/files', options)
  command.response_representation = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['status'] = status unless status.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token from a previous request, if provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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



1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1636

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_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 a site. This method will implicitly create a channel if it doesn't exist.

Parameters:

  • name (String)

    The fully-qualified identifier of the Channel.

  • 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



315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 315

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_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 only valid transition for a version is currently from a CREATED status to a FINALIZED status. Use DeleteVersion to set the status of a version to DELETED.

Parameters:

  • name (String)

    The unique identifier for a version, in the format: sites/SITE_NAME /versions/ 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



838
839
840
841
842
843
844
845
846
847
848
849
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 838

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 a site. This method will implicitly create a channel if it doesn't exist.

Parameters:

  • name (String)

    The fully-qualified identifier of the Channel.

  • 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



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1158

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 only valid transition for a version is currently from a CREATED status to a FINALIZED status. Use DeleteVersion to set the status of a version to DELETED.

Parameters:

  • name (String)

    The unique identifier for a version, in the format: sites/SITE_NAME /versions/ 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



1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1681

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_NAME / 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



873
874
875
876
877
878
879
880
881
882
883
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 873

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_NAME / 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



1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1716

def populate_site_version_files(parent, populate_version_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}:populateFiles', options)
  command.request_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest::Representation
  command.request_object = populate_version_files_request_object
  command.response_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse::Representation
  command.response_class = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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



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

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



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

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



986
987
988
989
990
991
992
993
994
995
996
997
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 986

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



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
# File 'lib/google/apis/firebasehosting_v1beta1/service.rb', line 1405

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