Class: Google::Apis::FirebasehostingV1beta1::CustomDomain
- Inherits:
-
Object
- Object
- Google::Apis::FirebasehostingV1beta1::CustomDomain
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/firebasehosting_v1beta1/classes.rb,
lib/google/apis/firebasehosting_v1beta1/representations.rb,
lib/google/apis/firebasehosting_v1beta1/representations.rb
Overview
A CustomDomain
is an entity that links a domain name to a Firebase Hosting
site. Add a CustomDomain
to your site to allow Hosting to serve the site's
content in response to requests against your domain name.
Instance Attribute Summary collapse
-
#annotations ⇒ Hash<String,String>
Annotations you can add to leave both human- and machine-readable metadata about your
CustomDomain
. -
#cert ⇒ Google::Apis::FirebasehostingV1beta1::Certificate
An SSL certificate used to provide end-to-end encryption for requests against your domain name.
-
#cert_preference ⇒ String
A field that lets you specify which SSL certificate type Hosting creates for your domain name.
-
#create_time ⇒ String
Output only.
-
#delete_time ⇒ String
Output only.
-
#etag ⇒ String
Output only.
-
#expire_time ⇒ String
Output only.
-
#host_state ⇒ String
Output only.
-
#issues ⇒ Array<Google::Apis::FirebasehostingV1beta1::Status>
Output only.
-
#labels ⇒ Hash<String,String>
Labels used for extra metadata and/or filtering.
-
#name ⇒ String
Output only.
-
#ownership_state ⇒ String
Output only.
-
#reconciling ⇒ Boolean
(also: #reconciling?)
Output only.
-
#redirect_target ⇒ String
A domain name that this
CustomDomain
should direct traffic towards. -
#required_dns_updates ⇒ Google::Apis::FirebasehostingV1beta1::DnsUpdates
A set of DNS record updates that you should make to allow Hosting to serve secure content in response to requests against your domain name.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ CustomDomain
constructor
A new instance of CustomDomain.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ CustomDomain
Returns a new instance of CustomDomain.
473 474 475 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 473 def initialize(**args) update!(**args) end |
Instance Attribute Details
#annotations ⇒ Hash<String,String>
Annotations you can add to leave both human- and machine-readable metadata
about your CustomDomain
.
Corresponds to the JSON property annotations
370 371 372 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 370 def annotations @annotations end |
#cert ⇒ Google::Apis::FirebasehostingV1beta1::Certificate
An SSL certificate used to provide end-to-end encryption for requests against
your domain name. A Certificate
can be an actual SSL certificate or, for
newly-created custom domains, Hosting's intent to create one.
Corresponds to the JSON property cert
377 378 379 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 377 def cert @cert end |
#cert_preference ⇒ String
A field that lets you specify which SSL certificate type Hosting creates for
your domain name. Spark plan custom domains only have access to the GROUPED
cert type, while Blaze plan domains can select any option.
Corresponds to the JSON property certPreference
384 385 386 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 384 def cert_preference @cert_preference end |
#create_time ⇒ String
Output only. The custom domain's create time.
Corresponds to the JSON property createTime
389 390 391 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 389 def create_time @create_time end |
#delete_time ⇒ String
Output only. The time the CustomDomain
was deleted; null for custom domains
that haven't been deleted. Deleted custom domains persist for approximately 30
days, after which time Hosting removes them completely. To restore a deleted
custom domain, make an UndeleteCustomDomain
request.
Corresponds to the JSON property deleteTime
397 398 399 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 397 def delete_time @delete_time end |
#etag ⇒ String
Output only. A string that represents the current state of the CustomDomain
and allows you to confirm its initial state in requests that would modify it.
Use the tag to ensure consistency when making UpdateCustomDomain
,
DeleteCustomDomain
, and UndeleteCustomDomain
requests.
Corresponds to the JSON property etag
405 406 407 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 405 def etag @etag end |
#expire_time ⇒ String
Output only. The minimum time before a soft-deleted CustomDomain
is
completely removed from Hosting; null for custom domains that haven't been
deleted.
Corresponds to the JSON property expireTime
412 413 414 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 412 def expire_time @expire_time end |
#host_state ⇒ String
Output only. The HostState
of the domain name this CustomDomain
refers to.
Corresponds to the JSON property hostState
417 418 419 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 417 def host_state @host_state end |
#issues ⇒ Array<Google::Apis::FirebasehostingV1beta1::Status>
Output only. A set of errors Hosting systems encountered when trying to
establish Hosting's ability to serve secure content for your domain name.
Resolve these issues to ensure your CustomDomain
behaves properly.
Corresponds to the JSON property issues
424 425 426 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 424 def issues @issues end |
#labels ⇒ Hash<String,String>
Labels used for extra metadata and/or filtering.
Corresponds to the JSON property labels
429 430 431 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 429 def labels @labels end |
#name ⇒ String
Output only. The fully-qualified name of the CustomDomain
.
Corresponds to the JSON property name
434 435 436 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 434 def name @name end |
#ownership_state ⇒ String
Output only. The OwnershipState
of the domain name this CustomDomain
refers to.
Corresponds to the JSON property ownershipState
440 441 442 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 440 def ownership_state @ownership_state end |
#reconciling ⇒ Boolean Also known as: reconciling?
Output only. A field that, if true, indicates that Hosting's systems are
attmepting to make the custom domain's state match your preferred state. This
is most frequently true
when initially provisioning a CustomDomain
after a
CreateCustomDomain
request or when creating a new SSL certificate to match
an updated cert_preference
after an UpdateCustomDomain
request.
Corresponds to the JSON property reconciling
449 450 451 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 449 def reconciling @reconciling end |
#redirect_target ⇒ String
A domain name that this CustomDomain
should direct traffic towards. If
specified, Hosting will respond to requests against this custom domain with an
HTTP 301 code, and route traffic to the specified redirect_target
instead.
Corresponds to the JSON property redirectTarget
457 458 459 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 457 def redirect_target @redirect_target end |
#required_dns_updates ⇒ Google::Apis::FirebasehostingV1beta1::DnsUpdates
A set of DNS record updates that you should make to allow Hosting to serve
secure content in response to requests against your domain name. These updates
present the current state of your domain name's DNS records when Hosting last
queried them, and the desired set of records that Hosting needs to see before
your custom domain can be fully active.
Corresponds to the JSON property requiredDnsUpdates
466 467 468 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 466 def required_dns_updates @required_dns_updates end |
#update_time ⇒ String
Output only. The last time the CustomDomain
was updated.
Corresponds to the JSON property updateTime
471 472 473 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 471 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 478 def update!(**args) @annotations = args[:annotations] if args.key?(:annotations) @cert = args[:cert] if args.key?(:cert) @cert_preference = args[:cert_preference] if args.key?(:cert_preference) @create_time = args[:create_time] if args.key?(:create_time) @delete_time = args[:delete_time] if args.key?(:delete_time) @etag = args[:etag] if args.key?(:etag) @expire_time = args[:expire_time] if args.key?(:expire_time) @host_state = args[:host_state] if args.key?(:host_state) @issues = args[:issues] if args.key?(:issues) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @ownership_state = args[:ownership_state] if args.key?(:ownership_state) @reconciling = args[:reconciling] if args.key?(:reconciling) @redirect_target = args[:redirect_target] if args.key?(:redirect_target) @required_dns_updates = args[:required_dns_updates] if args.key?(:required_dns_updates) @update_time = args[:update_time] if args.key?(:update_time) end |