Class: Google::Apis::FirebasehostingV1beta1::FirebaseHostingService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::FirebasehostingV1beta1::FirebaseHostingService
- Defined in:
- generated/google/apis/firebasehosting_v1beta1/service.rb
Overview
Firebase Hosting API
The Firebase Hosting REST API enables programmatic custom deployment for releasing versions of your Firebase hosted content and configuration files.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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.
-
#create_site_release(parent, release_object = nil, version_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Release
Creates a new release which makes the content of the specified version actively display on the site.
-
#create_site_version(parent, version_object = nil, size_bytes: nil, version_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Version
Creates a new version for a site.
-
#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.
-
#delete_site_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Empty
Deletes the specified version.
-
#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.
-
#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.
-
#initialize ⇒ FirebaseHostingService
constructor
A new instance of FirebaseHostingService.
-
#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.
-
#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.
-
#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.
-
#patch_site_version(name, version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Version
Updates the specified metadata for a version.
-
#populate_site_version_files(parent, populate_version_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse
Adds content files to a version.
-
#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.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ FirebaseHostingService
Returns a new instance of FirebaseHostingService
46 47 48 49 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 46 def initialize super('https://firebasehosting.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#create_site_domain(parent, domain_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Domain
Creates a domain mapping on the specified site.
145 146 147 148 149 150 151 152 153 154 155 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 145 def create_site_domain(parent, domain_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/domains', ) command.request_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation command.request_object = domain_object command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::Domain command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_site_release(parent, release_object = nil, version_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Release
Creates a new release which makes the content of the specified version actively display on the site.
320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 320 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', ) command.request_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation command.request_object = release_object command.response_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::Release command.params['parent'] = parent unless parent.nil? command.query['versionName'] = version_name unless version_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_site_version(parent, version_object = nil, size_bytes: nil, version_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Version
Creates a new version for a site.
398 399 400 401 402 403 404 405 406 407 408 409 410 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 398 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', ) command.request_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation command.request_object = version_object command.response_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::Version command.params['parent'] = parent unless parent.nil? command.query['sizeBytes'] = size_bytes unless size_bytes.nil? command.query['versionId'] = version_id unless version_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_site_domain(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Empty
Deletes the existing domain mapping on the specified site.
177 178 179 180 181 182 183 184 185 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 177 def delete_site_domain(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) 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.
433 434 435 436 437 438 439 440 441 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 433 def delete_site_version(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_site_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::SiteConfig
Gets the Hosting metadata for a specific site.
72 73 74 75 76 77 78 79 80 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 72 def get_site_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) 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.
207 208 209 210 211 212 213 214 215 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 207 def get_site_domain(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::Domain command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_site_domains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::ListDomainsResponse
Lists the domains for the specified site.
242 243 244 245 246 247 248 249 250 251 252 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 242 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', ) 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.
358 359 360 361 362 363 364 365 366 367 368 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 358 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', ) 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.
553 554 555 556 557 558 559 560 561 562 563 564 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 553 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', ) command.response_representation = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['status'] = status unless status.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_site_version(name, version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::Version
Updates the specified metadata for a version. Note that this method will
fail with FAILED_PRECONDITION
in the event of an invalid state
transition. The only valid transition for a version is currently from a
CREATED
status to a FINALIZED
status.
Use DeleteVersion
to set the status of a
version to DELETED
.
478 479 480 481 482 483 484 485 486 487 488 489 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 478 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}', ) command.request_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation command.request_object = version_object command.response_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::Version command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#populate_site_version_files(parent, populate_version_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse
Adds content files to a version.
513 514 515 516 517 518 519 520 521 522 523 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 513 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', ) command.request_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest::Representation command.request_object = populate_version_files_request_object command.response_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_site_config(name, site_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebasehostingV1beta1::SiteConfig
Sets the Hosting metadata for a specific site.
110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 110 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}', ) 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.
277 278 279 280 281 282 283 284 285 286 287 |
# File 'generated/google/apis/firebasehosting_v1beta1/service.rb', line 277 def update_site_domain(name, domain_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/{+name}', ) 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 |