Class CustomDomain

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.

Inheritance

object

CustomDomain

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.FirebaseHosting.v1beta1.Data

Assembly: Google.Apis.FirebaseHosting.v1beta1.dll

Syntax

public class CustomDomain : IDirectResponseSchema

Properties

Annotations

Annotations you can add to leave both human- and machine-readable metadata about your CustomDomain.

Declaration

[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Cert

Output only. The SSL certificate Hosting has for this custom domain's domain name. For new custom domains, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check the state field for more.

Declaration

[JsonProperty("cert")]
public virtual Certificate Cert { get; set; }

Property Value

Type	Description
Certificate

CertPreference

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.

Declaration

[JsonProperty("certPreference")]
public virtual string CertPreference { get; set; }

Property Value

Type	Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. The custom domain's create time.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DeleteTime

object representation of DeleteTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }

Property Value

Type	Description
object

DeleteTimeDateTimeOffset

DateTimeOffset representation of DeleteTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

DeleteTimeRaw

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.

Declaration

[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }

Property Value

Type	Description
string

ETag

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.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExpireTime

object representation of ExpireTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }

Property Value

Type	Description
object

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

ExpireTimeRaw

Output only. The minimum time before a soft-deleted CustomDomain is completely removed from Hosting; null for custom domains that haven't been deleted.

Declaration

[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }

Property Value

Type	Description
string

HostState

Output only. The HostState of the domain name this CustomDomain refers to.

Declaration

[JsonProperty("hostState")]
public virtual string HostState { get; set; }

Property Value

Type	Description
string

Issues

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.

Declaration

[JsonProperty("issues")]
public virtual IList<Status> Issues { get; set; }

Property Value

Type	Description
IList<Status>

Labels

Labels used for extra metadata and/or filtering.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Name

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

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

OwnershipState

Output only. The OwnershipState of the domain name this CustomDomain refers to.

Declaration

[JsonProperty("ownershipState")]
public virtual string OwnershipState { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }

Property Value

Type	Description
bool?

RedirectTarget

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.

Declaration

[JsonProperty("redirectTarget")]
public virtual string RedirectTarget { get; set; }

Property Value

Type	Description
string

RequiredDnsUpdates

Output only. A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf.

Declaration

[JsonProperty("requiredDnsUpdates")]
public virtual DnsUpdates RequiredDnsUpdates { get; set; }

Property Value

Type	Description
DnsUpdates

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. The last time the CustomDomain was updated.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema