google-apis-firebasehosting_v1beta1 0.25.0 → 0.26.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '029037321d26e55b2fc2c8dd792b5117a6966fa29e60aee74fc4ff61d99ed1db'
4
- data.tar.gz: b8d2278dafe5e23d0f6e396d734561ecbcf54d4198f04e7d28f73f1747705e5d
3
+ metadata.gz: c2facef2c62dcd04e14061645d2297506e670cf37c6d22a02e2f0a03b8b48201
4
+ data.tar.gz: 04c893c3219cc83cd0b9453f8b8fe6050867fd54c7d31701387ac262be6330e6
5
5
  SHA512:
6
- metadata.gz: 4abd8f3dc4caaac786fa891348bd78d0b73c4f99cf507b7fd7039371b6f25743cd1f17ab6c8ff1510f1ad2c365f3b7b41905a16f4fe959d6aa8dfc7901ac0462
7
- data.tar.gz: 4e6c2f44d6b6c6bf4233bb03bc207041f1f4a0b976e0a35d78c4605e71d0c1cb888572128f58fe26c471b5fbde81bbe1d8e414ed8c2e2b6688e6532657c05534
6
+ metadata.gz: bc75e9c2cd82d24df78de3eca1992a552ce3806c519e8a4babe6a1ad92918c3e37d0c1c2d88c2354c785c05eca5c688b1da4aa3514fc9a01ce78bf9500298c94
7
+ data.tar.gz: 254d8c48029d64b9ed05c634adf3b27e5962a395740ba7f8b3df3d666f12f00fd6a7fdbfdd7dfa85391eb63f04c8481698fef70cfd4b38145288b33fba99b440
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-firebasehosting_v1beta1
2
2
 
3
+ ### v0.26.0 (2023-09-17)
4
+
5
+ * Regenerated from discovery document revision 20230913
6
+
3
7
  ### v0.25.0 (2023-09-03)
4
8
 
5
9
  * Regenerated from discovery document revision 20230827
@@ -102,6 +102,102 @@ module Google
102
102
  end
103
103
  end
104
104
 
105
+ # A set of ACME challenges you can use to allow Hosting to create an SSL
106
+ # certificate for your domain name before directing traffic to Hosting servers.
107
+ # Use either the DNS or HTTP challenge; it's not necessary to provide both.
108
+ class CertVerification
109
+ include Google::Apis::Core::Hashable
110
+
111
+ # A set of DNS record updates that you should make to allow Hosting to serve
112
+ # secure content in response to requests against your domain name. These updates
113
+ # present the current state of your domain name's DNS records when Hosting last
114
+ # queried them, and the desired set of records that Hosting needs to see before
115
+ # your custom domain can be fully active.
116
+ # Corresponds to the JSON property `dns`
117
+ # @return [Google::Apis::FirebasehostingV1beta1::DnsUpdates]
118
+ attr_accessor :dns
119
+
120
+ # A file you can add to your existing, non-Hosting hosting service that confirms
121
+ # your intent to allow Hosting's Certificate Authorities to create an SSL
122
+ # certificate for your domain.
123
+ # Corresponds to the JSON property `http`
124
+ # @return [Google::Apis::FirebasehostingV1beta1::HttpUpdate]
125
+ attr_accessor :http
126
+
127
+ def initialize(**args)
128
+ update!(**args)
129
+ end
130
+
131
+ # Update properties of this object
132
+ def update!(**args)
133
+ @dns = args[:dns] if args.key?(:dns)
134
+ @http = args[:http] if args.key?(:http)
135
+ end
136
+ end
137
+
138
+ # An SSL certificate used to provide end-to-end encryption for requests against
139
+ # your domain name. A `Certificate` can be an actual SSL certificate or, for
140
+ # newly-created custom domains, Hosting's intent to create one.
141
+ class Certificate
142
+ include Google::Apis::Core::Hashable
143
+
144
+ # Output only. The certificate's creation time. For `TEMPORARY` certs this is
145
+ # the time Hosting first generated challenges for your domain name. For all
146
+ # other cert types, it's the time the actual cert was created.
147
+ # Corresponds to the JSON property `createTime`
148
+ # @return [String]
149
+ attr_accessor :create_time
150
+
151
+ # Output only. The certificate's expiration time. After this time, the cert can
152
+ # no longer be used to provide secure communication between Hosting and your
153
+ # site's visitors.
154
+ # Corresponds to the JSON property `expireTime`
155
+ # @return [String]
156
+ attr_accessor :expire_time
157
+
158
+ # Output only. A set of errors Hosting encountered when attempting to create a
159
+ # cert for your domain name. Resolve these issues to ensure Hosting is able to
160
+ # provide secure communication with your site's visitors.
161
+ # Corresponds to the JSON property `issues`
162
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::Status>]
163
+ attr_accessor :issues
164
+
165
+ # Output only. The state of the certificate. Only the `CERT_ACTIVE` and `
166
+ # CERT_EXPIRING_SOON` states provide SSL coverage for a domain name. If the
167
+ # state is `PROPAGATING` and Hosting had an active cert for the domain name
168
+ # before, that formerly-active cert provides SSL coverage for the domain name
169
+ # until the current cert propagates.
170
+ # Corresponds to the JSON property `state`
171
+ # @return [String]
172
+ attr_accessor :state
173
+
174
+ # Output only. The certificate's type.
175
+ # Corresponds to the JSON property `type`
176
+ # @return [String]
177
+ attr_accessor :type
178
+
179
+ # A set of ACME challenges you can use to allow Hosting to create an SSL
180
+ # certificate for your domain name before directing traffic to Hosting servers.
181
+ # Use either the DNS or HTTP challenge; it's not necessary to provide both.
182
+ # Corresponds to the JSON property `verification`
183
+ # @return [Google::Apis::FirebasehostingV1beta1::CertVerification]
184
+ attr_accessor :verification
185
+
186
+ def initialize(**args)
187
+ update!(**args)
188
+ end
189
+
190
+ # Update properties of this object
191
+ def update!(**args)
192
+ @create_time = args[:create_time] if args.key?(:create_time)
193
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
194
+ @issues = args[:issues] if args.key?(:issues)
195
+ @state = args[:state] if args.key?(:state)
196
+ @type = args[:type] if args.key?(:type)
197
+ @verification = args[:verification] if args.key?(:verification)
198
+ end
199
+ end
200
+
105
201
  # A `Channel` represents a stream of releases for a site. All sites have a
106
202
  # default `live` channel that serves content to the Firebase-provided subdomains
107
203
  # and any connected custom domains.
@@ -261,6 +357,324 @@ module Google
261
357
  end
262
358
  end
263
359
 
360
+ # A `CustomDomain` is an entity that links a domain name to a Firebase Hosting
361
+ # site. Add a `CustomDomain` to your site to allow Hosting to serve the site's
362
+ # content in response to requests against your domain name.
363
+ class CustomDomain
364
+ include Google::Apis::Core::Hashable
365
+
366
+ # Annotations you can add to leave both human- and machine-readable metadata
367
+ # about your `CustomDomain`.
368
+ # Corresponds to the JSON property `annotations`
369
+ # @return [Hash<String,String>]
370
+ attr_accessor :annotations
371
+
372
+ # An SSL certificate used to provide end-to-end encryption for requests against
373
+ # your domain name. A `Certificate` can be an actual SSL certificate or, for
374
+ # newly-created custom domains, Hosting's intent to create one.
375
+ # Corresponds to the JSON property `cert`
376
+ # @return [Google::Apis::FirebasehostingV1beta1::Certificate]
377
+ attr_accessor :cert
378
+
379
+ # A field that lets you specify which SSL certificate type Hosting creates for
380
+ # your domain name. Spark plan custom domains only have access to the `GROUPED`
381
+ # cert type, while Blaze plan domains can select any option.
382
+ # Corresponds to the JSON property `certPreference`
383
+ # @return [String]
384
+ attr_accessor :cert_preference
385
+
386
+ # Output only. The custom domain's create time.
387
+ # Corresponds to the JSON property `createTime`
388
+ # @return [String]
389
+ attr_accessor :create_time
390
+
391
+ # Output only. The time the `CustomDomain` was deleted; null for custom domains
392
+ # that haven't been deleted. Deleted custom domains persist for approximately 30
393
+ # days, after which time Hosting removes them completely. To restore a deleted
394
+ # custom domain, make an `UndeleteCustomDomain` request.
395
+ # Corresponds to the JSON property `deleteTime`
396
+ # @return [String]
397
+ attr_accessor :delete_time
398
+
399
+ # Output only. A string that represents the current state of the `CustomDomain`
400
+ # and allows you to confirm its initial state in requests that would modify it.
401
+ # Use the tag to ensure consistency when making `UpdateCustomDomain`, `
402
+ # DeleteCustomDomain`, and `UndeleteCustomDomain` requests.
403
+ # Corresponds to the JSON property `etag`
404
+ # @return [String]
405
+ attr_accessor :etag
406
+
407
+ # Output only. The minimum time before a soft-deleted `CustomDomain` is
408
+ # completely removed from Hosting; null for custom domains that haven't been
409
+ # deleted.
410
+ # Corresponds to the JSON property `expireTime`
411
+ # @return [String]
412
+ attr_accessor :expire_time
413
+
414
+ # Output only. The `HostState` of the domain name this `CustomDomain` refers to.
415
+ # Corresponds to the JSON property `hostState`
416
+ # @return [String]
417
+ attr_accessor :host_state
418
+
419
+ # Output only. A set of errors Hosting systems encountered when trying to
420
+ # establish Hosting's ability to serve secure content for your domain name.
421
+ # Resolve these issues to ensure your `CustomDomain` behaves properly.
422
+ # Corresponds to the JSON property `issues`
423
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::Status>]
424
+ attr_accessor :issues
425
+
426
+ # Labels used for extra metadata and/or filtering.
427
+ # Corresponds to the JSON property `labels`
428
+ # @return [Hash<String,String>]
429
+ attr_accessor :labels
430
+
431
+ # Output only. The fully-qualified name of the `CustomDomain`.
432
+ # Corresponds to the JSON property `name`
433
+ # @return [String]
434
+ attr_accessor :name
435
+
436
+ # Output only. The `OwnershipState` of the domain name this `CustomDomain`
437
+ # refers to.
438
+ # Corresponds to the JSON property `ownershipState`
439
+ # @return [String]
440
+ attr_accessor :ownership_state
441
+
442
+ # Output only. A field that, if true, indicates that Hosting's systems are
443
+ # attmepting to make the custom domain's state match your preferred state. This
444
+ # is most frequently `true` when initially provisioning a `CustomDomain` after a
445
+ # `CreateCustomDomain` request or when creating a new SSL certificate to match
446
+ # an updated `cert_preference` after an `UpdateCustomDomain` request.
447
+ # Corresponds to the JSON property `reconciling`
448
+ # @return [Boolean]
449
+ attr_accessor :reconciling
450
+ alias_method :reconciling?, :reconciling
451
+
452
+ # A domain name that this `CustomDomain` should direct traffic towards. If
453
+ # specified, Hosting will respond to requests against this custom domain with an
454
+ # HTTP 301 code, and route traffic to the specified `redirect_target` instead.
455
+ # Corresponds to the JSON property `redirectTarget`
456
+ # @return [String]
457
+ attr_accessor :redirect_target
458
+
459
+ # A set of DNS record updates that you should make to allow Hosting to serve
460
+ # secure content in response to requests against your domain name. These updates
461
+ # present the current state of your domain name's DNS records when Hosting last
462
+ # queried them, and the desired set of records that Hosting needs to see before
463
+ # your custom domain can be fully active.
464
+ # Corresponds to the JSON property `requiredDnsUpdates`
465
+ # @return [Google::Apis::FirebasehostingV1beta1::DnsUpdates]
466
+ attr_accessor :required_dns_updates
467
+
468
+ # Output only. The last time the `CustomDomain` was updated.
469
+ # Corresponds to the JSON property `updateTime`
470
+ # @return [String]
471
+ attr_accessor :update_time
472
+
473
+ def initialize(**args)
474
+ update!(**args)
475
+ end
476
+
477
+ # Update properties of this object
478
+ def update!(**args)
479
+ @annotations = args[:annotations] if args.key?(:annotations)
480
+ @cert = args[:cert] if args.key?(:cert)
481
+ @cert_preference = args[:cert_preference] if args.key?(:cert_preference)
482
+ @create_time = args[:create_time] if args.key?(:create_time)
483
+ @delete_time = args[:delete_time] if args.key?(:delete_time)
484
+ @etag = args[:etag] if args.key?(:etag)
485
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
486
+ @host_state = args[:host_state] if args.key?(:host_state)
487
+ @issues = args[:issues] if args.key?(:issues)
488
+ @labels = args[:labels] if args.key?(:labels)
489
+ @name = args[:name] if args.key?(:name)
490
+ @ownership_state = args[:ownership_state] if args.key?(:ownership_state)
491
+ @reconciling = args[:reconciling] if args.key?(:reconciling)
492
+ @redirect_target = args[:redirect_target] if args.key?(:redirect_target)
493
+ @required_dns_updates = args[:required_dns_updates] if args.key?(:required_dns_updates)
494
+ @update_time = args[:update_time] if args.key?(:update_time)
495
+ end
496
+ end
497
+
498
+ # Metadata associated with a`CustomDomain` operation.
499
+ class CustomDomainMetadata
500
+ include Google::Apis::Core::Hashable
501
+
502
+ # The `CertState` of the domain name's SSL certificate.
503
+ # Corresponds to the JSON property `certState`
504
+ # @return [String]
505
+ attr_accessor :cert_state
506
+
507
+ # The `HostState` of the domain name this `CustomDomain` refers to.
508
+ # Corresponds to the JSON property `hostState`
509
+ # @return [String]
510
+ attr_accessor :host_state
511
+
512
+ # A list of issues that are currently preventing Hosting from completing the
513
+ # operation. These are generally DNS-related issues that Hosting encounters when
514
+ # querying a domain name's records or attempting to mint an SSL certificate.
515
+ # Corresponds to the JSON property `issues`
516
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::Status>]
517
+ attr_accessor :issues
518
+
519
+ # A set of DNS record updates and ACME challenges that allow you to transition
520
+ # domain names to Firebase Hosting with zero downtime. These updates allow
521
+ # Hosting to create an SSL certificate and establish ownership for your custom
522
+ # domain before Hosting begins serving traffic on it. If your domain name is
523
+ # already in active use with another provider, add one of the challenges and
524
+ # make the recommended DNS updates. After adding challenges and adjusting DNS
525
+ # records as necessary, wait for the `ownershipState` to be `OWNERSHIP_ACTIVE`
526
+ # and the `certState` to be `CERT_ACTIVE` before sending traffic to Hosting.
527
+ # Corresponds to the JSON property `liveMigrationSteps`
528
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::LiveMigrationStep>]
529
+ attr_accessor :live_migration_steps
530
+
531
+ # The `OwnershipState` of the domain name this `CustomDomain` refers to.
532
+ # Corresponds to the JSON property `ownershipState`
533
+ # @return [String]
534
+ attr_accessor :ownership_state
535
+
536
+ # A set of DNS record updates that you should make to allow Hosting to serve
537
+ # secure content in response to requests against your domain name. These updates
538
+ # present the current state of your domain name's DNS records when Hosting last
539
+ # queried them, and the desired set of records that Hosting needs to see before
540
+ # your custom domain can be fully active.
541
+ # Corresponds to the JSON property `quickSetupUpdates`
542
+ # @return [Google::Apis::FirebasehostingV1beta1::DnsUpdates]
543
+ attr_accessor :quick_setup_updates
544
+
545
+ def initialize(**args)
546
+ update!(**args)
547
+ end
548
+
549
+ # Update properties of this object
550
+ def update!(**args)
551
+ @cert_state = args[:cert_state] if args.key?(:cert_state)
552
+ @host_state = args[:host_state] if args.key?(:host_state)
553
+ @issues = args[:issues] if args.key?(:issues)
554
+ @live_migration_steps = args[:live_migration_steps] if args.key?(:live_migration_steps)
555
+ @ownership_state = args[:ownership_state] if args.key?(:ownership_state)
556
+ @quick_setup_updates = args[:quick_setup_updates] if args.key?(:quick_setup_updates)
557
+ end
558
+ end
559
+
560
+ # DNS records are resource records that define how systems and services should
561
+ # behave when handling requests for a domain name. For example, when you add `A`
562
+ # records to your domain name's DNS records, you're informing other systems (
563
+ # such as your users' web browsers) to contact those IPv4 addresses to retrieve
564
+ # resources relevant to your domain name (such as your Hosting site files).
565
+ class DnsRecord
566
+ include Google::Apis::Core::Hashable
567
+
568
+ # Output only. The domain name the record pertains to, e.g. `foo.bar.com.`.
569
+ # Corresponds to the JSON property `domainName`
570
+ # @return [String]
571
+ attr_accessor :domain_name
572
+
573
+ # Output only. The data of the record. The meaning of the value depends on
574
+ # record type: - A and AAAA: IP addresses for the domain name. - CNAME: Another
575
+ # domain to check for records. - TXT: Arbitrary text strings associated with the
576
+ # domain name. Hosting uses TXT records to determine which Firebase projects
577
+ # have permission to act on the domain name's behalf. - CAA: The record's flags,
578
+ # tag, and value, e.g. `0 issue "pki.goog"`.
579
+ # Corresponds to the JSON property `rdata`
580
+ # @return [String]
581
+ attr_accessor :rdata
582
+
583
+ # Output only. An enum that indicates the a required action for this record.
584
+ # Corresponds to the JSON property `requiredAction`
585
+ # @return [String]
586
+ attr_accessor :required_action
587
+
588
+ # Output only. The record's type, which determines what data the record contains.
589
+ # Corresponds to the JSON property `type`
590
+ # @return [String]
591
+ attr_accessor :type
592
+
593
+ def initialize(**args)
594
+ update!(**args)
595
+ end
596
+
597
+ # Update properties of this object
598
+ def update!(**args)
599
+ @domain_name = args[:domain_name] if args.key?(:domain_name)
600
+ @rdata = args[:rdata] if args.key?(:rdata)
601
+ @required_action = args[:required_action] if args.key?(:required_action)
602
+ @type = args[:type] if args.key?(:type)
603
+ end
604
+ end
605
+
606
+ # A set of DNS records relevant to the setup and maintenance of a custom domain
607
+ # in Firebase Hosting.
608
+ class DnsRecordSet
609
+ include Google::Apis::Core::Hashable
610
+
611
+ # The `Status` type defines a logical error model that is suitable for different
612
+ # programming environments, including REST APIs and RPC APIs. It is used by [
613
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
614
+ # data: error code, error message, and error details. You can find out more
615
+ # about this error model and how to work with it in the [API Design Guide](https:
616
+ # //cloud.google.com/apis/design/errors).
617
+ # Corresponds to the JSON property `checkError`
618
+ # @return [Google::Apis::FirebasehostingV1beta1::Status]
619
+ attr_accessor :check_error
620
+
621
+ # Output only. The domain name the record set pertains to.
622
+ # Corresponds to the JSON property `domainName`
623
+ # @return [String]
624
+ attr_accessor :domain_name
625
+
626
+ # Output only. Records on the domain.
627
+ # Corresponds to the JSON property `records`
628
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::DnsRecord>]
629
+ attr_accessor :records
630
+
631
+ def initialize(**args)
632
+ update!(**args)
633
+ end
634
+
635
+ # Update properties of this object
636
+ def update!(**args)
637
+ @check_error = args[:check_error] if args.key?(:check_error)
638
+ @domain_name = args[:domain_name] if args.key?(:domain_name)
639
+ @records = args[:records] if args.key?(:records)
640
+ end
641
+ end
642
+
643
+ # A set of DNS record updates that you should make to allow Hosting to serve
644
+ # secure content in response to requests against your domain name. These updates
645
+ # present the current state of your domain name's DNS records when Hosting last
646
+ # queried them, and the desired set of records that Hosting needs to see before
647
+ # your custom domain can be fully active.
648
+ class DnsUpdates
649
+ include Google::Apis::Core::Hashable
650
+
651
+ # The last time Hosting checked your custom domain's DNS records.
652
+ # Corresponds to the JSON property `checkTime`
653
+ # @return [String]
654
+ attr_accessor :check_time
655
+
656
+ # The set of DNS records Hosting needs to serve secure content on the domain.
657
+ # Corresponds to the JSON property `desired`
658
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::DnsRecordSet>]
659
+ attr_accessor :desired
660
+
661
+ # The set of DNS records Hosting discovered when inspecting a domain.
662
+ # Corresponds to the JSON property `discovered`
663
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::DnsRecordSet>]
664
+ attr_accessor :discovered
665
+
666
+ def initialize(**args)
667
+ update!(**args)
668
+ end
669
+
670
+ # Update properties of this object
671
+ def update!(**args)
672
+ @check_time = args[:check_time] if args.key?(:check_time)
673
+ @desired = args[:desired] if args.key?(:desired)
674
+ @discovered = args[:discovered] if args.key?(:discovered)
675
+ end
676
+ end
677
+
264
678
  # The intended behavior and status information of a domain.
265
679
  class Domain
266
680
  include Google::Apis::Core::Hashable
@@ -452,6 +866,57 @@ module Google
452
866
  end
453
867
  end
454
868
 
869
+ # A file you can add to your existing, non-Hosting hosting service that confirms
870
+ # your intent to allow Hosting's Certificate Authorities to create an SSL
871
+ # certificate for your domain.
872
+ class HttpUpdate
873
+ include Google::Apis::Core::Hashable
874
+
875
+ # The `Status` type defines a logical error model that is suitable for different
876
+ # programming environments, including REST APIs and RPC APIs. It is used by [
877
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
878
+ # data: error code, error message, and error details. You can find out more
879
+ # about this error model and how to work with it in the [API Design Guide](https:
880
+ # //cloud.google.com/apis/design/errors).
881
+ # Corresponds to the JSON property `checkError`
882
+ # @return [Google::Apis::FirebasehostingV1beta1::Status]
883
+ attr_accessor :check_error
884
+
885
+ # Output only. A text string to serve at the path.
886
+ # Corresponds to the JSON property `desired`
887
+ # @return [String]
888
+ attr_accessor :desired
889
+
890
+ # Output only. Whether Hosting was able to find the required file contents on
891
+ # the specified path during its last check.
892
+ # Corresponds to the JSON property `discovered`
893
+ # @return [String]
894
+ attr_accessor :discovered
895
+
896
+ # Output only. The last time Hosting systems checked for the file contents.
897
+ # Corresponds to the JSON property `lastCheckTime`
898
+ # @return [String]
899
+ attr_accessor :last_check_time
900
+
901
+ # Output only. The path to the file.
902
+ # Corresponds to the JSON property `path`
903
+ # @return [String]
904
+ attr_accessor :path
905
+
906
+ def initialize(**args)
907
+ update!(**args)
908
+ end
909
+
910
+ # Update properties of this object
911
+ def update!(**args)
912
+ @check_error = args[:check_error] if args.key?(:check_error)
913
+ @desired = args[:desired] if args.key?(:desired)
914
+ @discovered = args[:discovered] if args.key?(:discovered)
915
+ @last_check_time = args[:last_check_time] if args.key?(:last_check_time)
916
+ @path = args[:path] if args.key?(:path)
917
+ end
918
+ end
919
+
455
920
  # If provided, i18n rewrites are enabled.
456
921
  class I18nConfig
457
922
  include Google::Apis::Core::Hashable
@@ -499,6 +964,34 @@ module Google
499
964
  end
500
965
  end
501
966
 
967
+ # The response from `ListCustomDomains`.
968
+ class ListCustomDomainsResponse
969
+ include Google::Apis::Core::Hashable
970
+
971
+ # A list of `CustomDomain` entities associated with the specified Firebase `Site`
972
+ # .
973
+ # Corresponds to the JSON property `customDomains`
974
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::CustomDomain>]
975
+ attr_accessor :custom_domains
976
+
977
+ # The pagination token, if more results exist beyond the ones in this response.
978
+ # Include this token in your next call to `ListCustomDomains`. Page tokens are
979
+ # short-lived and should not be stored.
980
+ # Corresponds to the JSON property `nextPageToken`
981
+ # @return [String]
982
+ attr_accessor :next_page_token
983
+
984
+ def initialize(**args)
985
+ update!(**args)
986
+ end
987
+
988
+ # Update properties of this object
989
+ def update!(**args)
990
+ @custom_domains = args[:custom_domains] if args.key?(:custom_domains)
991
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
992
+ end
993
+ end
994
+
502
995
  # The response to listing Domains.
503
996
  class ListDomainsResponse
504
997
  include Google::Apis::Core::Hashable
@@ -524,6 +1017,31 @@ module Google
524
1017
  end
525
1018
  end
526
1019
 
1020
+ # The response message for Operations.ListOperations.
1021
+ class ListOperationsResponse
1022
+ include Google::Apis::Core::Hashable
1023
+
1024
+ # The standard List next-page token.
1025
+ # Corresponds to the JSON property `nextPageToken`
1026
+ # @return [String]
1027
+ attr_accessor :next_page_token
1028
+
1029
+ # A list of operations that matches the specified filter in the request.
1030
+ # Corresponds to the JSON property `operations`
1031
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::Operation>]
1032
+ attr_accessor :operations
1033
+
1034
+ def initialize(**args)
1035
+ update!(**args)
1036
+ end
1037
+
1038
+ # Update properties of this object
1039
+ def update!(**args)
1040
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1041
+ @operations = args[:operations] if args.key?(:operations)
1042
+ end
1043
+ end
1044
+
527
1045
  #
528
1046
  class ListReleasesResponse
529
1047
  include Google::Apis::Core::Hashable
@@ -632,6 +1150,57 @@ module Google
632
1150
  end
633
1151
  end
634
1152
 
1153
+ # A set of updates including ACME challenges and DNS records that allow Hosting
1154
+ # to create an SSL certificate and establish project ownership for your domain
1155
+ # name before you direct traffic to Hosting servers. Use these updates to
1156
+ # facilitate zero downtime migrations to Hosting from other services. After you'
1157
+ # ve made the recommended updates, check your custom domain's `ownershipState`
1158
+ # and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `
1159
+ # CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records.
1160
+ class LiveMigrationStep
1161
+ include Google::Apis::Core::Hashable
1162
+
1163
+ # A set of ACME challenges you can use to allow Hosting to create an SSL
1164
+ # certificate for your domain name before directing traffic to Hosting servers.
1165
+ # Use either the DNS or HTTP challenge; it's not necessary to provide both.
1166
+ # Corresponds to the JSON property `certVerification`
1167
+ # @return [Google::Apis::FirebasehostingV1beta1::CertVerification]
1168
+ attr_accessor :cert_verification
1169
+
1170
+ # A set of DNS record updates that you should make to allow Hosting to serve
1171
+ # secure content in response to requests against your domain name. These updates
1172
+ # present the current state of your domain name's DNS records when Hosting last
1173
+ # queried them, and the desired set of records that Hosting needs to see before
1174
+ # your custom domain can be fully active.
1175
+ # Corresponds to the JSON property `dnsUpdates`
1176
+ # @return [Google::Apis::FirebasehostingV1beta1::DnsUpdates]
1177
+ attr_accessor :dns_updates
1178
+
1179
+ # Output only. Issues that prevent the current step from completing.
1180
+ # Corresponds to the JSON property `issues`
1181
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::Status>]
1182
+ attr_accessor :issues
1183
+
1184
+ # Output only. The state of the live migration step, indicates whether you
1185
+ # should work to complete the step now, in the future, or have already completed
1186
+ # it.
1187
+ # Corresponds to the JSON property `state`
1188
+ # @return [String]
1189
+ attr_accessor :state
1190
+
1191
+ def initialize(**args)
1192
+ update!(**args)
1193
+ end
1194
+
1195
+ # Update properties of this object
1196
+ def update!(**args)
1197
+ @cert_verification = args[:cert_verification] if args.key?(:cert_verification)
1198
+ @dns_updates = args[:dns_updates] if args.key?(:dns_updates)
1199
+ @issues = args[:issues] if args.key?(:issues)
1200
+ @state = args[:state] if args.key?(:state)
1201
+ end
1202
+ end
1203
+
635
1204
  # This resource represents a long-running operation that is the result of a
636
1205
  # network API call.
637
1206
  class Operation
@@ -1122,6 +1691,35 @@ module Google
1122
1691
  end
1123
1692
  end
1124
1693
 
1694
+ # The request sent to `UndeleteCustomDomain`.
1695
+ class UndeleteCustomDomainRequest
1696
+ include Google::Apis::Core::Hashable
1697
+
1698
+ # A tag that represents the state of the `CustomDomain` as you know it. If
1699
+ # present, the supplied tag must match the current value on your `CustomDomain`,
1700
+ # or the request fails.
1701
+ # Corresponds to the JSON property `etag`
1702
+ # @return [String]
1703
+ attr_accessor :etag
1704
+
1705
+ # If true, Hosting validates that it's possible to complete your request but
1706
+ # doesn't actually delete the `CustomDomain`.
1707
+ # Corresponds to the JSON property `validateOnly`
1708
+ # @return [Boolean]
1709
+ attr_accessor :validate_only
1710
+ alias_method :validate_only?, :validate_only
1711
+
1712
+ def initialize(**args)
1713
+ update!(**args)
1714
+ end
1715
+
1716
+ # Update properties of this object
1717
+ def update!(**args)
1718
+ @etag = args[:etag] if args.key?(:etag)
1719
+ @validate_only = args[:validate_only] if args.key?(:validate_only)
1720
+ end
1721
+ end
1722
+
1125
1723
  # A `Version` is a configuration and a collection of static files which
1126
1724
  # determine how a site is displayed.
1127
1725
  class Version
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirebasehostingV1beta1
18
18
  # Version of the google-apis-firebasehosting_v1beta1 gem
19
- GEM_VERSION = "0.25.0"
19
+ GEM_VERSION = "0.26.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230827"
25
+ REVISION = "20230913"
26
26
  end
27
27
  end
28
28
  end
@@ -40,6 +40,18 @@ module Google
40
40
  include Google::Apis::Core::JsonObjectSupport
41
41
  end
42
42
 
43
+ class CertVerification
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class Certificate
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
43
55
  class Channel
44
56
  class Representation < Google::Apis::Core::JsonRepresentation; end
45
57
 
@@ -58,6 +70,36 @@ module Google
58
70
  include Google::Apis::Core::JsonObjectSupport
59
71
  end
60
72
 
73
+ class CustomDomain
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class CustomDomainMetadata
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class DnsRecord
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class DnsRecordSet
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class DnsUpdates
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
61
103
  class Domain
62
104
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
105
 
@@ -88,6 +130,12 @@ module Google
88
130
  include Google::Apis::Core::JsonObjectSupport
89
131
  end
90
132
 
133
+ class HttpUpdate
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
91
139
  class I18nConfig
92
140
  class Representation < Google::Apis::Core::JsonRepresentation; end
93
141
 
@@ -100,12 +148,24 @@ module Google
100
148
  include Google::Apis::Core::JsonObjectSupport
101
149
  end
102
150
 
151
+ class ListCustomDomainsResponse
152
+ class Representation < Google::Apis::Core::JsonRepresentation; end
153
+
154
+ include Google::Apis::Core::JsonObjectSupport
155
+ end
156
+
103
157
  class ListDomainsResponse
104
158
  class Representation < Google::Apis::Core::JsonRepresentation; end
105
159
 
106
160
  include Google::Apis::Core::JsonObjectSupport
107
161
  end
108
162
 
163
+ class ListOperationsResponse
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
109
169
  class ListReleasesResponse
110
170
  class Representation < Google::Apis::Core::JsonRepresentation; end
111
171
 
@@ -130,6 +190,12 @@ module Google
130
190
  include Google::Apis::Core::JsonObjectSupport
131
191
  end
132
192
 
193
+ class LiveMigrationStep
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
133
199
  class Operation
134
200
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
201
 
@@ -196,6 +262,12 @@ module Google
196
262
  include Google::Apis::Core::JsonObjectSupport
197
263
  end
198
264
 
265
+ class UndeleteCustomDomainRequest
266
+ class Representation < Google::Apis::Core::JsonRepresentation; end
267
+
268
+ include Google::Apis::Core::JsonObjectSupport
269
+ end
270
+
199
271
  class Version
200
272
  class Representation < Google::Apis::Core::JsonRepresentation; end
201
273
 
@@ -232,6 +304,30 @@ module Google
232
304
  end
233
305
  end
234
306
 
307
+ class CertVerification
308
+ # @private
309
+ class Representation < Google::Apis::Core::JsonRepresentation
310
+ property :dns, as: 'dns', class: Google::Apis::FirebasehostingV1beta1::DnsUpdates, decorator: Google::Apis::FirebasehostingV1beta1::DnsUpdates::Representation
311
+
312
+ property :http, as: 'http', class: Google::Apis::FirebasehostingV1beta1::HttpUpdate, decorator: Google::Apis::FirebasehostingV1beta1::HttpUpdate::Representation
313
+
314
+ end
315
+ end
316
+
317
+ class Certificate
318
+ # @private
319
+ class Representation < Google::Apis::Core::JsonRepresentation
320
+ property :create_time, as: 'createTime'
321
+ property :expire_time, as: 'expireTime'
322
+ collection :issues, as: 'issues', class: Google::Apis::FirebasehostingV1beta1::Status, decorator: Google::Apis::FirebasehostingV1beta1::Status::Representation
323
+
324
+ property :state, as: 'state'
325
+ property :type, as: 'type'
326
+ property :verification, as: 'verification', class: Google::Apis::FirebasehostingV1beta1::CertVerification, decorator: Google::Apis::FirebasehostingV1beta1::CertVerification::Representation
327
+
328
+ end
329
+ end
330
+
235
331
  class Channel
236
332
  # @private
237
333
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -269,6 +365,78 @@ module Google
269
365
  end
270
366
  end
271
367
 
368
+ class CustomDomain
369
+ # @private
370
+ class Representation < Google::Apis::Core::JsonRepresentation
371
+ hash :annotations, as: 'annotations'
372
+ property :cert, as: 'cert', class: Google::Apis::FirebasehostingV1beta1::Certificate, decorator: Google::Apis::FirebasehostingV1beta1::Certificate::Representation
373
+
374
+ property :cert_preference, as: 'certPreference'
375
+ property :create_time, as: 'createTime'
376
+ property :delete_time, as: 'deleteTime'
377
+ property :etag, as: 'etag'
378
+ property :expire_time, as: 'expireTime'
379
+ property :host_state, as: 'hostState'
380
+ collection :issues, as: 'issues', class: Google::Apis::FirebasehostingV1beta1::Status, decorator: Google::Apis::FirebasehostingV1beta1::Status::Representation
381
+
382
+ hash :labels, as: 'labels'
383
+ property :name, as: 'name'
384
+ property :ownership_state, as: 'ownershipState'
385
+ property :reconciling, as: 'reconciling'
386
+ property :redirect_target, as: 'redirectTarget'
387
+ property :required_dns_updates, as: 'requiredDnsUpdates', class: Google::Apis::FirebasehostingV1beta1::DnsUpdates, decorator: Google::Apis::FirebasehostingV1beta1::DnsUpdates::Representation
388
+
389
+ property :update_time, as: 'updateTime'
390
+ end
391
+ end
392
+
393
+ class CustomDomainMetadata
394
+ # @private
395
+ class Representation < Google::Apis::Core::JsonRepresentation
396
+ property :cert_state, as: 'certState'
397
+ property :host_state, as: 'hostState'
398
+ collection :issues, as: 'issues', class: Google::Apis::FirebasehostingV1beta1::Status, decorator: Google::Apis::FirebasehostingV1beta1::Status::Representation
399
+
400
+ collection :live_migration_steps, as: 'liveMigrationSteps', class: Google::Apis::FirebasehostingV1beta1::LiveMigrationStep, decorator: Google::Apis::FirebasehostingV1beta1::LiveMigrationStep::Representation
401
+
402
+ property :ownership_state, as: 'ownershipState'
403
+ property :quick_setup_updates, as: 'quickSetupUpdates', class: Google::Apis::FirebasehostingV1beta1::DnsUpdates, decorator: Google::Apis::FirebasehostingV1beta1::DnsUpdates::Representation
404
+
405
+ end
406
+ end
407
+
408
+ class DnsRecord
409
+ # @private
410
+ class Representation < Google::Apis::Core::JsonRepresentation
411
+ property :domain_name, as: 'domainName'
412
+ property :rdata, as: 'rdata'
413
+ property :required_action, as: 'requiredAction'
414
+ property :type, as: 'type'
415
+ end
416
+ end
417
+
418
+ class DnsRecordSet
419
+ # @private
420
+ class Representation < Google::Apis::Core::JsonRepresentation
421
+ property :check_error, as: 'checkError', class: Google::Apis::FirebasehostingV1beta1::Status, decorator: Google::Apis::FirebasehostingV1beta1::Status::Representation
422
+
423
+ property :domain_name, as: 'domainName'
424
+ collection :records, as: 'records', class: Google::Apis::FirebasehostingV1beta1::DnsRecord, decorator: Google::Apis::FirebasehostingV1beta1::DnsRecord::Representation
425
+
426
+ end
427
+ end
428
+
429
+ class DnsUpdates
430
+ # @private
431
+ class Representation < Google::Apis::Core::JsonRepresentation
432
+ property :check_time, as: 'checkTime'
433
+ collection :desired, as: 'desired', class: Google::Apis::FirebasehostingV1beta1::DnsRecordSet, decorator: Google::Apis::FirebasehostingV1beta1::DnsRecordSet::Representation
434
+
435
+ collection :discovered, as: 'discovered', class: Google::Apis::FirebasehostingV1beta1::DnsRecordSet, decorator: Google::Apis::FirebasehostingV1beta1::DnsRecordSet::Representation
436
+
437
+ end
438
+ end
439
+
272
440
  class Domain
273
441
  # @private
274
442
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -322,6 +490,18 @@ module Google
322
490
  end
323
491
  end
324
492
 
493
+ class HttpUpdate
494
+ # @private
495
+ class Representation < Google::Apis::Core::JsonRepresentation
496
+ property :check_error, as: 'checkError', class: Google::Apis::FirebasehostingV1beta1::Status, decorator: Google::Apis::FirebasehostingV1beta1::Status::Representation
497
+
498
+ property :desired, as: 'desired'
499
+ property :discovered, as: 'discovered'
500
+ property :last_check_time, as: 'lastCheckTime'
501
+ property :path, as: 'path'
502
+ end
503
+ end
504
+
325
505
  class I18nConfig
326
506
  # @private
327
507
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -338,6 +518,15 @@ module Google
338
518
  end
339
519
  end
340
520
 
521
+ class ListCustomDomainsResponse
522
+ # @private
523
+ class Representation < Google::Apis::Core::JsonRepresentation
524
+ collection :custom_domains, as: 'customDomains', class: Google::Apis::FirebasehostingV1beta1::CustomDomain, decorator: Google::Apis::FirebasehostingV1beta1::CustomDomain::Representation
525
+
526
+ property :next_page_token, as: 'nextPageToken'
527
+ end
528
+ end
529
+
341
530
  class ListDomainsResponse
342
531
  # @private
343
532
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -347,6 +536,15 @@ module Google
347
536
  end
348
537
  end
349
538
 
539
+ class ListOperationsResponse
540
+ # @private
541
+ class Representation < Google::Apis::Core::JsonRepresentation
542
+ property :next_page_token, as: 'nextPageToken'
543
+ collection :operations, as: 'operations', class: Google::Apis::FirebasehostingV1beta1::Operation, decorator: Google::Apis::FirebasehostingV1beta1::Operation::Representation
544
+
545
+ end
546
+ end
547
+
350
548
  class ListReleasesResponse
351
549
  # @private
352
550
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -383,6 +581,19 @@ module Google
383
581
  end
384
582
  end
385
583
 
584
+ class LiveMigrationStep
585
+ # @private
586
+ class Representation < Google::Apis::Core::JsonRepresentation
587
+ property :cert_verification, as: 'certVerification', class: Google::Apis::FirebasehostingV1beta1::CertVerification, decorator: Google::Apis::FirebasehostingV1beta1::CertVerification::Representation
588
+
589
+ property :dns_updates, as: 'dnsUpdates', class: Google::Apis::FirebasehostingV1beta1::DnsUpdates, decorator: Google::Apis::FirebasehostingV1beta1::DnsUpdates::Representation
590
+
591
+ collection :issues, as: 'issues', class: Google::Apis::FirebasehostingV1beta1::Status, decorator: Google::Apis::FirebasehostingV1beta1::Status::Representation
592
+
593
+ property :state, as: 'state'
594
+ end
595
+ end
596
+
386
597
  class Operation
387
598
  # @private
388
599
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -500,6 +711,14 @@ module Google
500
711
  end
501
712
  end
502
713
 
714
+ class UndeleteCustomDomainRequest
715
+ # @private
716
+ class Representation < Google::Apis::Core::JsonRepresentation
717
+ property :etag, as: 'etag'
718
+ property :validate_only, as: 'validateOnly'
719
+ end
720
+ end
721
+
503
722
  class Version
504
723
  # @private
505
724
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -648,6 +648,315 @@ module Google
648
648
  execute_or_queue_command(command, &block)
649
649
  end
650
650
 
651
+ # Creates a `CustomDomain`.
652
+ # @param [String] parent
653
+ # Required. The custom domain's parent, specifically a Firebase Hosting `Site`.
654
+ # @param [Google::Apis::FirebasehostingV1beta1::CustomDomain] custom_domain_object
655
+ # @param [String] custom_domain_id
656
+ # Required. The ID of the `CustomDomain`, which is the domain name you'd like to
657
+ # use with Firebase Hosting.
658
+ # @param [Boolean] validate_only
659
+ # If true, Hosting validates that it's possible to complete your request but
660
+ # doesn't actually create a new `CustomDomain`.
661
+ # @param [String] fields
662
+ # Selector specifying which fields to include in a partial response.
663
+ # @param [String] quota_user
664
+ # Available to use for quota purposes for server-side applications. Can be any
665
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
666
+ # @param [Google::Apis::RequestOptions] options
667
+ # Request-specific options
668
+ #
669
+ # @yield [result, err] Result & error if block supplied
670
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object
671
+ # @yieldparam err [StandardError] error object if request failed
672
+ #
673
+ # @return [Google::Apis::FirebasehostingV1beta1::Operation]
674
+ #
675
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
676
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
677
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
678
+ def create_project_site_custom_domain(parent, custom_domain_object = nil, custom_domain_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
679
+ command = make_simple_command(:post, 'v1beta1/{+parent}/customDomains', options)
680
+ command.request_representation = Google::Apis::FirebasehostingV1beta1::CustomDomain::Representation
681
+ command.request_object = custom_domain_object
682
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation
683
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Operation
684
+ command.params['parent'] = parent unless parent.nil?
685
+ command.query['customDomainId'] = custom_domain_id unless custom_domain_id.nil?
686
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
687
+ command.query['fields'] = fields unless fields.nil?
688
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
689
+ execute_or_queue_command(command, &block)
690
+ end
691
+
692
+ # Deletes the specified `CustomDomain`.
693
+ # @param [String] name
694
+ # Required. The name of the `CustomDomain` to delete.
695
+ # @param [Boolean] allow_missing
696
+ # If true, the request succeeds even if the `CustomDomain` doesn't exist.
697
+ # @param [String] etag
698
+ # A tag that represents the state of the `CustomDomain` as you know it. If
699
+ # present, the supplied tag must match the current value on your `CustomDomain`,
700
+ # or the request fails.
701
+ # @param [Boolean] validate_only
702
+ # If true, Hosting validates that it's possible to complete your request but
703
+ # doesn't actually delete the `CustomDomain`.
704
+ # @param [String] fields
705
+ # Selector specifying which fields to include in a partial response.
706
+ # @param [String] quota_user
707
+ # Available to use for quota purposes for server-side applications. Can be any
708
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
709
+ # @param [Google::Apis::RequestOptions] options
710
+ # Request-specific options
711
+ #
712
+ # @yield [result, err] Result & error if block supplied
713
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object
714
+ # @yieldparam err [StandardError] error object if request failed
715
+ #
716
+ # @return [Google::Apis::FirebasehostingV1beta1::Operation]
717
+ #
718
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
719
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
720
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
721
+ def delete_project_site_custom_domain(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
722
+ command = make_simple_command(:delete, 'v1beta1/{+name}', options)
723
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation
724
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Operation
725
+ command.params['name'] = name unless name.nil?
726
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
727
+ command.query['etag'] = etag unless etag.nil?
728
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
729
+ command.query['fields'] = fields unless fields.nil?
730
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
731
+ execute_or_queue_command(command, &block)
732
+ end
733
+
734
+ # Gets the specified `CustomDomain`.
735
+ # @param [String] name
736
+ # Required. The name of the `CustomDomain` to get.
737
+ # @param [String] fields
738
+ # Selector specifying which fields to include in a partial response.
739
+ # @param [String] quota_user
740
+ # Available to use for quota purposes for server-side applications. Can be any
741
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
742
+ # @param [Google::Apis::RequestOptions] options
743
+ # Request-specific options
744
+ #
745
+ # @yield [result, err] Result & error if block supplied
746
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::CustomDomain] parsed result object
747
+ # @yieldparam err [StandardError] error object if request failed
748
+ #
749
+ # @return [Google::Apis::FirebasehostingV1beta1::CustomDomain]
750
+ #
751
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
752
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
753
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
754
+ def get_project_site_custom_domain(name, fields: nil, quota_user: nil, options: nil, &block)
755
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
756
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::CustomDomain::Representation
757
+ command.response_class = Google::Apis::FirebasehostingV1beta1::CustomDomain
758
+ command.params['name'] = name unless name.nil?
759
+ command.query['fields'] = fields unless fields.nil?
760
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
761
+ execute_or_queue_command(command, &block)
762
+ end
763
+
764
+ # Lists each `CustomDomain` associated with the specified parent Hosting site.
765
+ # Returns `CustomDomain`s in a consistent, but undefined, order to facilitate
766
+ # pagination.
767
+ # @param [String] parent
768
+ # Required. The Firebase Hosting `Site` with `CustomDomain` entities you'd like
769
+ # to list.
770
+ # @param [Fixnum] page_size
771
+ # The max number of `CustomDomain` entities to return in a request. Defaults to
772
+ # 10.
773
+ # @param [String] page_token
774
+ # A token from a previous call to `ListCustomDomains` that tells the server
775
+ # where to resume listing.
776
+ # @param [Boolean] show_deleted
777
+ # If true, the request returns soft-deleted `CustomDomain`s that haven't been
778
+ # fully-deleted yet. To restore deleted `CustomDomain`s, make an `
779
+ # UndeleteCustomDomain` request.
780
+ # @param [String] fields
781
+ # Selector specifying which fields to include in a partial response.
782
+ # @param [String] quota_user
783
+ # Available to use for quota purposes for server-side applications. Can be any
784
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
785
+ # @param [Google::Apis::RequestOptions] options
786
+ # Request-specific options
787
+ #
788
+ # @yield [result, err] Result & error if block supplied
789
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListCustomDomainsResponse] parsed result object
790
+ # @yieldparam err [StandardError] error object if request failed
791
+ #
792
+ # @return [Google::Apis::FirebasehostingV1beta1::ListCustomDomainsResponse]
793
+ #
794
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
795
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
796
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
797
+ def list_project_site_custom_domains(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
798
+ command = make_simple_command(:get, 'v1beta1/{+parent}/customDomains', options)
799
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::ListCustomDomainsResponse::Representation
800
+ command.response_class = Google::Apis::FirebasehostingV1beta1::ListCustomDomainsResponse
801
+ command.params['parent'] = parent unless parent.nil?
802
+ command.query['pageSize'] = page_size unless page_size.nil?
803
+ command.query['pageToken'] = page_token unless page_token.nil?
804
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
805
+ command.query['fields'] = fields unless fields.nil?
806
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
807
+ execute_or_queue_command(command, &block)
808
+ end
809
+
810
+ # Updates the specified `CustomDomain`.
811
+ # @param [String] name
812
+ # Output only. The fully-qualified name of the `CustomDomain`.
813
+ # @param [Google::Apis::FirebasehostingV1beta1::CustomDomain] custom_domain_object
814
+ # @param [Boolean] allow_missing
815
+ # If true, Hosting creates the `CustomDomain` if it doesn't already exist.
816
+ # @param [String] update_mask
817
+ # The set of field names from your `CustomDomain` that you want to update. A
818
+ # field will be overwritten if, and only if, it's in the mask. If you don't
819
+ # provide a mask, Hosting updates the entire `CustomDomain`.
820
+ # @param [Boolean] validate_only
821
+ # If true, Hosting validates that it's possible to complete your request but
822
+ # doesn't actually create or update the `CustomDomain`.
823
+ # @param [String] fields
824
+ # Selector specifying which fields to include in a partial response.
825
+ # @param [String] quota_user
826
+ # Available to use for quota purposes for server-side applications. Can be any
827
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
828
+ # @param [Google::Apis::RequestOptions] options
829
+ # Request-specific options
830
+ #
831
+ # @yield [result, err] Result & error if block supplied
832
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object
833
+ # @yieldparam err [StandardError] error object if request failed
834
+ #
835
+ # @return [Google::Apis::FirebasehostingV1beta1::Operation]
836
+ #
837
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
838
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
839
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
840
+ def patch_project_site_custom_domain(name, custom_domain_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
841
+ command = make_simple_command(:patch, 'v1beta1/{+name}', options)
842
+ command.request_representation = Google::Apis::FirebasehostingV1beta1::CustomDomain::Representation
843
+ command.request_object = custom_domain_object
844
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation
845
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Operation
846
+ command.params['name'] = name unless name.nil?
847
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
848
+ command.query['updateMask'] = update_mask unless update_mask.nil?
849
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
850
+ command.query['fields'] = fields unless fields.nil?
851
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
852
+ execute_or_queue_command(command, &block)
853
+ end
854
+
855
+ # Undeletes the specified `CustomDomain` if it has been soft-deleted. Hosting
856
+ # retains soft-deleted custom domains for around 30 days before permanently
857
+ # deleting them.
858
+ # @param [String] name
859
+ # Required. The name of the `CustomDomain` to delete.
860
+ # @param [Google::Apis::FirebasehostingV1beta1::UndeleteCustomDomainRequest] undelete_custom_domain_request_object
861
+ # @param [String] fields
862
+ # Selector specifying which fields to include in a partial response.
863
+ # @param [String] quota_user
864
+ # Available to use for quota purposes for server-side applications. Can be any
865
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
866
+ # @param [Google::Apis::RequestOptions] options
867
+ # Request-specific options
868
+ #
869
+ # @yield [result, err] Result & error if block supplied
870
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object
871
+ # @yieldparam err [StandardError] error object if request failed
872
+ #
873
+ # @return [Google::Apis::FirebasehostingV1beta1::Operation]
874
+ #
875
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
876
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
877
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
878
+ def undelete_custom_domain(name, undelete_custom_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
879
+ command = make_simple_command(:post, 'v1beta1/{+name}:undelete', options)
880
+ command.request_representation = Google::Apis::FirebasehostingV1beta1::UndeleteCustomDomainRequest::Representation
881
+ command.request_object = undelete_custom_domain_request_object
882
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation
883
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Operation
884
+ command.params['name'] = name unless name.nil?
885
+ command.query['fields'] = fields unless fields.nil?
886
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
887
+ execute_or_queue_command(command, &block)
888
+ end
889
+
890
+ # Gets the latest state of a long-running operation. Use this method to poll the
891
+ # operation result at intervals as recommended by the API service.
892
+ # @param [String] name
893
+ # The name of the operation resource.
894
+ # @param [String] fields
895
+ # Selector specifying which fields to include in a partial response.
896
+ # @param [String] quota_user
897
+ # Available to use for quota purposes for server-side applications. Can be any
898
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
899
+ # @param [Google::Apis::RequestOptions] options
900
+ # Request-specific options
901
+ #
902
+ # @yield [result, err] Result & error if block supplied
903
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object
904
+ # @yieldparam err [StandardError] error object if request failed
905
+ #
906
+ # @return [Google::Apis::FirebasehostingV1beta1::Operation]
907
+ #
908
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
909
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
910
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
911
+ def get_project_site_custom_domain_operation(name, fields: nil, quota_user: nil, options: nil, &block)
912
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
913
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation
914
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Operation
915
+ command.params['name'] = name unless name.nil?
916
+ command.query['fields'] = fields unless fields.nil?
917
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
918
+ execute_or_queue_command(command, &block)
919
+ end
920
+
921
+ # Lists operations that match the specified filter in the request.
922
+ # @param [String] name
923
+ # The name of the operation's parent resource.
924
+ # @param [String] filter
925
+ # The standard list filter.
926
+ # @param [Fixnum] page_size
927
+ # The standard list page size.
928
+ # @param [String] page_token
929
+ # The standard list page token.
930
+ # @param [String] fields
931
+ # Selector specifying which fields to include in a partial response.
932
+ # @param [String] quota_user
933
+ # Available to use for quota purposes for server-side applications. Can be any
934
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
935
+ # @param [Google::Apis::RequestOptions] options
936
+ # Request-specific options
937
+ #
938
+ # @yield [result, err] Result & error if block supplied
939
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListOperationsResponse] parsed result object
940
+ # @yieldparam err [StandardError] error object if request failed
941
+ #
942
+ # @return [Google::Apis::FirebasehostingV1beta1::ListOperationsResponse]
943
+ #
944
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
945
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
946
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
947
+ def list_project_site_custom_domain_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
948
+ command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
949
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::ListOperationsResponse::Representation
950
+ command.response_class = Google::Apis::FirebasehostingV1beta1::ListOperationsResponse
951
+ command.params['name'] = name unless name.nil?
952
+ command.query['filter'] = filter unless filter.nil?
953
+ command.query['pageSize'] = page_size unless page_size.nil?
954
+ command.query['pageToken'] = page_token unless page_token.nil?
955
+ command.query['fields'] = fields unless fields.nil?
956
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
957
+ execute_or_queue_command(command, &block)
958
+ end
959
+
651
960
  # Creates a domain mapping on the specified site.
652
961
  # @param [String] parent
653
962
  # Required. The parent to create the domain association for, in the format:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firebasehosting_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.25.0
4
+ version: 0.26.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-03 00:00:00.000000000 Z
11
+ date: 2023-09-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebasehosting_v1beta1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-firebasehosting_v1beta1/v0.25.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firebasehosting_v1beta1/v0.26.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebasehosting_v1beta1
63
63
  post_install_message:
64
64
  rdoc_options: []