| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.FirebaseHosting.Types
Contents
- Service Configuration
- OAuth Scopes
- DomainStatus
- DomainProvisioningDNSStatus
- VersionLabels
- PopulateVersionFilesResponse
- DomainRedirectType
- CertDNSChallenge
- Empty
- PopulateVersionFilesRequest
- ServingConfigAppAssociation
- ServingConfig
- Domain
- ListReleasesResponse
- VersionStatus
- DomainProvisioning
- Release
- VersionFile
- Header
- ActingUser
- Version
- ListDomainsResponse
- Xgafv
- Redirect
- DomainRedirect
- Rewrite
- DomainProvisioningCertStatus
- PopulateVersionFilesRequestFiles
- VersionFileStatus
- HeaderHeaders
- CertHTTPChallenge
- ServingConfigTrailingSlashBehavior
- ListVersionFilesResponse
- ReleaseType
- SiteConfig
Description
Synopsis
- firebaseHostingService :: ServiceConfig
- firebaseScope :: Proxy '["https://www.googleapis.com/auth/firebase"]
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- firebaseReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/firebase.readonly"]
- data DomainStatus
- data DomainProvisioningDNSStatus
- data VersionLabels
- versionLabels :: HashMap Text Text -> VersionLabels
- vlAddtional :: Lens' VersionLabels (HashMap Text Text)
- data PopulateVersionFilesResponse
- populateVersionFilesResponse :: PopulateVersionFilesResponse
- pvfrUploadURL :: Lens' PopulateVersionFilesResponse (Maybe Text)
- pvfrUploadRequiredHashes :: Lens' PopulateVersionFilesResponse [Text]
- data DomainRedirectType
- data CertDNSChallenge
- certDNSChallenge :: CertDNSChallenge
- cdcToken :: Lens' CertDNSChallenge (Maybe Text)
- cdcDomainName :: Lens' CertDNSChallenge (Maybe Text)
- data Empty
- empty :: Empty
- data PopulateVersionFilesRequest
- populateVersionFilesRequest :: PopulateVersionFilesRequest
- pvfrFiles :: Lens' PopulateVersionFilesRequest (Maybe PopulateVersionFilesRequestFiles)
- data ServingConfigAppAssociation
- data ServingConfig
- servingConfig :: ServingConfig
- scCleanURLs :: Lens' ServingConfig (Maybe Bool)
- scAppAssociation :: Lens' ServingConfig (Maybe ServingConfigAppAssociation)
- scRewrites :: Lens' ServingConfig [Rewrite]
- scRedirects :: Lens' ServingConfig [Redirect]
- scHeaders :: Lens' ServingConfig [Header]
- scTrailingSlashBehavior :: Lens' ServingConfig (Maybe ServingConfigTrailingSlashBehavior)
- data Domain
- domain :: Domain
- dStatus :: Lens' Domain (Maybe DomainStatus)
- dProvisioning :: Lens' Domain (Maybe DomainProvisioning)
- dUpdateTime :: Lens' Domain (Maybe UTCTime)
- dDomainName :: Lens' Domain (Maybe Text)
- dDomainRedirect :: Lens' Domain (Maybe DomainRedirect)
- dSite :: Lens' Domain (Maybe Text)
- data ListReleasesResponse
- listReleasesResponse :: ListReleasesResponse
- lrrNextPageToken :: Lens' ListReleasesResponse (Maybe Text)
- lrrReleases :: Lens' ListReleasesResponse [Release]
- data VersionStatus
- data DomainProvisioning
- domainProvisioning :: DomainProvisioning
- dpExpectedIPs :: Lens' DomainProvisioning [Text]
- dpCertChallengeDNS :: Lens' DomainProvisioning (Maybe CertDNSChallenge)
- dpDNSFetchTime :: Lens' DomainProvisioning (Maybe UTCTime)
- dpCertStatus :: Lens' DomainProvisioning (Maybe DomainProvisioningCertStatus)
- dpDNSStatus :: Lens' DomainProvisioning (Maybe DomainProvisioningDNSStatus)
- dpDiscoveredIPs :: Lens' DomainProvisioning [Text]
- dpCertChallengeHTTP :: Lens' DomainProvisioning (Maybe CertHTTPChallenge)
- dpCertChallengeDiscoveredTxt :: Lens' DomainProvisioning [Text]
- data Release
- release :: Release
- rReleaseTime :: Lens' Release (Maybe UTCTime)
- rReleaseUser :: Lens' Release (Maybe ActingUser)
- rName :: Lens' Release (Maybe Text)
- rVersion :: Lens' Release (Maybe Version)
- rType :: Lens' Release (Maybe ReleaseType)
- rMessage :: Lens' Release (Maybe Text)
- data VersionFile
- versionFile :: VersionFile
- vfStatus :: Lens' VersionFile (Maybe VersionFileStatus)
- vfHash :: Lens' VersionFile (Maybe Text)
- vfPath :: Lens' VersionFile (Maybe Text)
- data Header
- header :: Header
- hHeaders :: Lens' Header (Maybe HeaderHeaders)
- hGlob :: Lens' Header (Maybe Text)
- data ActingUser
- actingUser :: ActingUser
- auEmail :: Lens' ActingUser (Maybe Text)
- auImageURL :: Lens' ActingUser (Maybe Text)
- data Version
- version :: Version
- vStatus :: Lens' Version (Maybe VersionStatus)
- vFinalizeTime :: Lens' Version (Maybe UTCTime)
- vConfig :: Lens' Version (Maybe ServingConfig)
- vFileCount :: Lens' Version (Maybe Int64)
- vFinalizeUser :: Lens' Version (Maybe ActingUser)
- vVersionBytes :: Lens' Version (Maybe Int64)
- vDeleteTime :: Lens' Version (Maybe UTCTime)
- vName :: Lens' Version (Maybe Text)
- vLabels :: Lens' Version (Maybe VersionLabels)
- vCreateUser :: Lens' Version (Maybe ActingUser)
- vDeleteUser :: Lens' Version (Maybe ActingUser)
- vCreateTime :: Lens' Version (Maybe UTCTime)
- data ListDomainsResponse
- listDomainsResponse :: ListDomainsResponse
- ldrNextPageToken :: Lens' ListDomainsResponse (Maybe Text)
- ldrDomains :: Lens' ListDomainsResponse [Domain]
- data Xgafv
- data Redirect
- redirect :: Redirect
- rLocation :: Lens' Redirect (Maybe Text)
- rGlob :: Lens' Redirect (Maybe Text)
- rStatusCode :: Lens' Redirect (Maybe Int32)
- data DomainRedirect
- domainRedirect :: DomainRedirect
- drDomainName :: Lens' DomainRedirect (Maybe Text)
- drType :: Lens' DomainRedirect (Maybe DomainRedirectType)
- data Rewrite
- rewrite :: Rewrite
- rewFunction :: Lens' Rewrite (Maybe Text)
- rewPath :: Lens' Rewrite (Maybe Text)
- rewGlob :: Lens' Rewrite (Maybe Text)
- rewDynamicLinks :: Lens' Rewrite (Maybe Bool)
- data DomainProvisioningCertStatus
- data PopulateVersionFilesRequestFiles
- populateVersionFilesRequestFiles :: HashMap Text Text -> PopulateVersionFilesRequestFiles
- pvfrfAddtional :: Lens' PopulateVersionFilesRequestFiles (HashMap Text Text)
- data VersionFileStatus
- data HeaderHeaders
- headerHeaders :: HashMap Text Text -> HeaderHeaders
- hhAddtional :: Lens' HeaderHeaders (HashMap Text Text)
- data CertHTTPChallenge
- certHTTPChallenge :: CertHTTPChallenge
- chttpcPath :: Lens' CertHTTPChallenge (Maybe Text)
- chttpcToken :: Lens' CertHTTPChallenge (Maybe Text)
- data ServingConfigTrailingSlashBehavior
- data ListVersionFilesResponse
- listVersionFilesResponse :: ListVersionFilesResponse
- lvfrNextPageToken :: Lens' ListVersionFilesResponse (Maybe Text)
- lvfrFiles :: Lens' ListVersionFilesResponse [VersionFile]
- data ReleaseType
- data SiteConfig
- siteConfig :: SiteConfig
- scMaxVersions :: Lens' SiteConfig (Maybe Int64)
Service Configuration
firebaseHostingService :: ServiceConfig Source #
Default request referring to version v1beta1 of the Firebase Hosting API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
firebaseScope :: Proxy '["https://www.googleapis.com/auth/firebase"] Source #
View and administer all your Firebase data and settings
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
firebaseReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/firebase.readonly"] Source #
View all your Firebase data and settings
DomainStatus
data DomainStatus Source #
Output only. Additional status of the domain association.
Constructors
| DomainStatusUnspecified |
|
| DomainChangePending |
|
| DomainActive |
|
| DomainVerificationRequired |
|
| DomainVerificationLost |
|
Instances
DomainProvisioningDNSStatus
data DomainProvisioningDNSStatus Source #
The DNS record match status as of the last DNS fetch.
Constructors
| DNSStatusUnspecified |
|
| DNSPending |
|
| DNSMissing |
|
| DNSPartialMatch |
|
| DNSMatch |
|
| DNSExtraneousMatch |
|
Instances
VersionLabels
data VersionLabels Source #
The labels used for extra metadata and/or filtering.
See: versionLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> VersionLabels |
Creates a value of VersionLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
PopulateVersionFilesResponse
data PopulateVersionFilesResponse Source #
Instances
populateVersionFilesResponse :: PopulateVersionFilesResponse Source #
Creates a value of PopulateVersionFilesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvfrUploadURL :: Lens' PopulateVersionFilesResponse (Maybe Text) Source #
The URL to which the files should be uploaded, in the format: "https://upload-firebasehosting.googleapis.com/upload/sites/site-name/versions/versionID/files". Perform a multipart `POST` of the Gzipped file contents to the URL using a forward slash and the hash of the file appended to the end.
pvfrUploadRequiredHashes :: Lens' PopulateVersionFilesResponse [Text] Source #
The content hashes of the specified files that need to be uploaded to the specified endpoint.
DomainRedirectType
data DomainRedirectType Source #
Required. The redirect status code.
Constructors
| RedirectTypeUnspecified |
|
| MovedPermanently |
|
Instances
CertDNSChallenge
data CertDNSChallenge Source #
Represents a DNS certificate challenge.
See: certDNSChallenge smart constructor.
Instances
certDNSChallenge :: CertDNSChallenge Source #
Creates a value of CertDNSChallenge with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdcToken :: Lens' CertDNSChallenge (Maybe Text) Source #
The value that must be present as a TXT record on the domain name to satisfy the challenge.
cdcDomainName :: Lens' CertDNSChallenge (Maybe Text) Source #
The domain name upon which the DNS challenge must be satisfied.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty smart constructor.
Instances
| Eq Empty Source # | |
| Data Empty Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
| Show Empty Source # | |
| Generic Empty Source # | |
| ToJSON Empty Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product | |
| FromJSON Empty Source # | |
| type Rep Empty Source # | |
PopulateVersionFilesRequest
data PopulateVersionFilesRequest Source #
Instances
populateVersionFilesRequest :: PopulateVersionFilesRequest Source #
Creates a value of PopulateVersionFilesRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvfrFiles :: Lens' PopulateVersionFilesRequest (Maybe PopulateVersionFilesRequestFiles) Source #
A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file.
ServingConfigAppAssociation
data ServingConfigAppAssociation Source #
How to handle well known App Association files.
Constructors
| Auto |
|
| None |
|
Instances
ServingConfig
data ServingConfig Source #
The configuration for how incoming requests to a site should be routed and processed before serving content. The patterns are matched and applied according to a specific priority order.
See: servingConfig smart constructor.
Instances
servingConfig :: ServingConfig Source #
Creates a value of ServingConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scCleanURLs :: Lens' ServingConfig (Maybe Bool) Source #
Defines whether to drop the file extension from uploaded files.
scAppAssociation :: Lens' ServingConfig (Maybe ServingConfigAppAssociation) Source #
How to handle well known App Association files.
scRewrites :: Lens' ServingConfig [Rewrite] Source #
A list of rewrites that will act as if the service were given the destination URL.
scRedirects :: Lens' ServingConfig [Redirect] Source #
A list of globs that will cause the response to redirect to another location.
scHeaders :: Lens' ServingConfig [Header] Source #
A list of custom response headers that are added to the content if the request URL path matches the glob.
scTrailingSlashBehavior :: Lens' ServingConfig (Maybe ServingConfigTrailingSlashBehavior) Source #
Defines how to handle a trailing slash in the URL path.
Domain
The intended behavior and status information of a domain.
See: domain smart constructor.
Instances
Creates a value of Domain with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dStatus :: Lens' Domain (Maybe DomainStatus) Source #
Output only. Additional status of the domain association.
dProvisioning :: Lens' Domain (Maybe DomainProvisioning) Source #
Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.
dUpdateTime :: Lens' Domain (Maybe UTCTime) Source #
Output only. The time at which the domain was last updated.
dDomainRedirect :: Lens' Domain (Maybe DomainRedirect) Source #
If set, the domain should redirect with the provided parameters.
ListReleasesResponse
data ListReleasesResponse Source #
Instances
listReleasesResponse :: ListReleasesResponse Source #
Creates a value of ListReleasesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrrNextPageToken :: Lens' ListReleasesResponse (Maybe Text) Source #
If there are additional releases remaining beyond the ones in this response, then supply this token in the next `list` call to continue with the next set of releases.
lrrReleases :: Lens' ListReleasesResponse [Release] Source #
The list of hashes of files that still need to be uploaded, if any exist.
VersionStatus
data VersionStatus Source #
The deploy status of a version. For a successful deploy, call the `CreateVersion` endpoint to make a new version (`CREATED` status), upload all desired files to the version, then update the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the `DeleteVersion` endpoint.
Constructors
| VersionStatusUnspecified |
|
| Created |
|
| Finalized |
|
| Deleted |
|
| Abandoned |
|
| Expired |
|
Instances
DomainProvisioning
data DomainProvisioning Source #
The current certificate provisioning status information for a domain.
See: domainProvisioning smart constructor.
Instances
domainProvisioning :: DomainProvisioning Source #
Creates a value of DomainProvisioning with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpExpectedIPs :: Lens' DomainProvisioning [Text] Source #
The list of IPs to which the domain is expected to resolve.
dpCertChallengeDNS :: Lens' DomainProvisioning (Maybe CertDNSChallenge) Source #
The DNS challenge for generating a certificate.
dpDNSFetchTime :: Lens' DomainProvisioning (Maybe UTCTime) Source #
The time at which the last DNS fetch occurred.
dpCertStatus :: Lens' DomainProvisioning (Maybe DomainProvisioningCertStatus) Source #
The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
dpDNSStatus :: Lens' DomainProvisioning (Maybe DomainProvisioningDNSStatus) Source #
The DNS record match status as of the last DNS fetch.
dpDiscoveredIPs :: Lens' DomainProvisioning [Text] Source #
The IPs found at the last DNS fetch.
dpCertChallengeHTTP :: Lens' DomainProvisioning (Maybe CertHTTPChallenge) Source #
The HTTP challenge for generating a certificate.
dpCertChallengeDiscoveredTxt :: Lens' DomainProvisioning [Text] Source #
The TXT records (for the certificate challenge) that were found at the last DNS fetch.
Release
A `Release` is a particular collection of configurations and files that is set to be public at a particular time.
See: release smart constructor.
Instances
Creates a value of Release with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rReleaseTime :: Lens' Release (Maybe UTCTime) Source #
Output only. The time at which the version is set to be public.
rReleaseUser :: Lens' Release (Maybe ActingUser) Source #
Output only. Identifies the user who created the release.
rName :: Lens' Release (Maybe Text) Source #
Output only. The unique identifier for the release, in the format: 'sites\/site-name\/releases\/releaseID' This name is provided in the response body when you call the `CreateRelease` endpoint.
rVersion :: Lens' Release (Maybe Version) Source #
Output only. The configuration and content that was released.
rType :: Lens' Release (Maybe ReleaseType) Source #
Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
rMessage :: Lens' Release (Maybe Text) Source #
The deploy description when the release was created. The value can be up to 512 characters.
VersionFile
data VersionFile Source #
A static content file that is part of a version.
See: versionFile smart constructor.
Instances
versionFile :: VersionFile Source #
Creates a value of VersionFile with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vfStatus :: Lens' VersionFile (Maybe VersionFileStatus) Source #
Output only. The current status of a particular file in the specified version. The value will be either `pending upload` or `uploaded`.
vfPath :: Lens' VersionFile (Maybe Text) Source #
The URI at which the file's content should display.
Header
A `header` defines custom headers to add to a response should the request URL path match the pattern.
See: header smart constructor.
Instances
| Eq Header Source # | |
| Data Header Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Header -> c Header # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Header # toConstr :: Header -> Constr # dataTypeOf :: Header -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Header) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Header) # gmapT :: (forall b. Data b => b -> b) -> Header -> Header # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Header -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Header -> r # gmapQ :: (forall d. Data d => d -> u) -> Header -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Header -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Header -> m Header # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Header -> m Header # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Header -> m Header # | |
| Show Header Source # | |
| Generic Header Source # | |
| ToJSON Header Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product | |
| FromJSON Header Source # | |
| type Rep Header Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product type Rep Header = D1 (MetaData "Header" "Network.Google.FirebaseHosting.Types.Product" "gogol-firebasehosting-0.4.0-1bHlj0b9uJOEzft2Jhzv1U" False) (C1 (MetaCons "Header'" PrefixI True) (S1 (MetaSel (Just "_hHeaders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe HeaderHeaders)) :*: S1 (MetaSel (Just "_hGlob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) | |
hHeaders :: Lens' Header (Maybe HeaderHeaders) Source #
Required. The additional headers to add to the response.
hGlob :: Lens' Header (Maybe Text) Source #
Required. The user-supplied glob pattern to match against the request URL path.
ActingUser
data ActingUser Source #
Contains metadata about the user who performed an action, such as creating a release or finalizing a version.
See: actingUser smart constructor.
Instances
actingUser :: ActingUser Source #
Creates a value of ActingUser with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
auEmail :: Lens' ActingUser (Maybe Text) Source #
The email address of the user when the user performed the action.
auImageURL :: Lens' ActingUser (Maybe Text) Source #
A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
Version
A `Version` is the collection of configuration and static files that determine how a site is displayed.
See: version smart constructor.
Instances
Creates a value of Version with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vStatus :: Lens' Version (Maybe VersionStatus) Source #
The deploy status of a version. For a successful deploy, call the `CreateVersion` endpoint to make a new version (`CREATED` status), upload all desired files to the version, then update the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the `DeleteVersion` endpoint.
vFinalizeTime :: Lens' Version (Maybe UTCTime) Source #
Output only. The time at which the version was `FINALIZED`.
vConfig :: Lens' Version (Maybe ServingConfig) Source #
The configuration for the behavior of the site. This configuration exists in the `firebase.json` file.
vFileCount :: Lens' Version (Maybe Int64) Source #
Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
vFinalizeUser :: Lens' Version (Maybe ActingUser) Source #
Output only. Identifies the user who `FINALIZED` the version.
vVersionBytes :: Lens' Version (Maybe Int64) Source #
Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
vDeleteTime :: Lens' Version (Maybe UTCTime) Source #
Output only. The time at which the version was `DELETED`.
vName :: Lens' Version (Maybe Text) Source #
The unique identifier for a version, in the format: 'sites\/site-name\/versions\/versionID' This name is provided in the response body when you call the `CreateVersion` endpoint.
vLabels :: Lens' Version (Maybe VersionLabels) Source #
The labels used for extra metadata and/or filtering.
vCreateUser :: Lens' Version (Maybe ActingUser) Source #
Output only. Identifies the user who created the version.
vDeleteUser :: Lens' Version (Maybe ActingUser) Source #
Output only. Identifies the user who `DELETED` the version.
vCreateTime :: Lens' Version (Maybe UTCTime) Source #
Output only. The time at which the version was created.
ListDomainsResponse
data ListDomainsResponse Source #
Instances
listDomainsResponse :: ListDomainsResponse Source #
Creates a value of ListDomainsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldrNextPageToken :: Lens' ListDomainsResponse (Maybe Text) Source #
The pagination token, if more results exist.
ldrDomains :: Lens' ListDomainsResponse [Domain] Source #
The list of domains, if any exist.
Xgafv
V1 error format.
Instances
Redirect
A `redirect` represents the configuration for returning an HTTP redirect response given a matching request URL path.
See: redirect smart constructor.
Instances
| Eq Redirect Source # | |
| Data Redirect Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Redirect -> c Redirect # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Redirect # toConstr :: Redirect -> Constr # dataTypeOf :: Redirect -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Redirect) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Redirect) # gmapT :: (forall b. Data b => b -> b) -> Redirect -> Redirect # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Redirect -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Redirect -> r # gmapQ :: (forall d. Data d => d -> u) -> Redirect -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Redirect -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Redirect -> m Redirect # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Redirect -> m Redirect # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Redirect -> m Redirect # | |
| Show Redirect Source # | |
| Generic Redirect Source # | |
| ToJSON Redirect Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product | |
| FromJSON Redirect Source # | |
| type Rep Redirect Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product type Rep Redirect = D1 (MetaData "Redirect" "Network.Google.FirebaseHosting.Types.Product" "gogol-firebasehosting-0.4.0-1bHlj0b9uJOEzft2Jhzv1U" False) (C1 (MetaCons "Redirect'" PrefixI True) (S1 (MetaSel (Just "_rLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_rGlob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))) | |
Creates a value of Redirect with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rLocation :: Lens' Redirect (Maybe Text) Source #
Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: '"glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"'
rGlob :: Lens' Redirect (Maybe Text) Source #
Required. The user-supplied glob pattern to match against the request URL path.
rStatusCode :: Lens' Redirect (Maybe Int32) Source #
Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
DomainRedirect
data DomainRedirect Source #
Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.
See: domainRedirect smart constructor.
Instances
domainRedirect :: DomainRedirect Source #
Creates a value of DomainRedirect with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drDomainName :: Lens' DomainRedirect (Maybe Text) Source #
Required. The domain name to redirect to.
drType :: Lens' DomainRedirect (Maybe DomainRedirectType) Source #
Required. The redirect status code.
Rewrite
A `rewrite` represents an internal content rewrite on the version. If the pattern matches, the request will be handled as if it were to the destination path specified in the configuration.
See: rewrite smart constructor.
Instances
| Eq Rewrite Source # | |
| Data Rewrite Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Rewrite -> c Rewrite # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Rewrite # toConstr :: Rewrite -> Constr # dataTypeOf :: Rewrite -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Rewrite) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Rewrite) # gmapT :: (forall b. Data b => b -> b) -> Rewrite -> Rewrite # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Rewrite -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Rewrite -> r # gmapQ :: (forall d. Data d => d -> u) -> Rewrite -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Rewrite -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Rewrite -> m Rewrite # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Rewrite -> m Rewrite # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Rewrite -> m Rewrite # | |
| Show Rewrite Source # | |
| Generic Rewrite Source # | |
| ToJSON Rewrite Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product | |
| FromJSON Rewrite Source # | |
| type Rep Rewrite Source # | |
Defined in Network.Google.FirebaseHosting.Types.Product type Rep Rewrite = D1 (MetaData "Rewrite" "Network.Google.FirebaseHosting.Types.Product" "gogol-firebasehosting-0.4.0-1bHlj0b9uJOEzft2Jhzv1U" False) (C1 (MetaCons "Rewrite'" PrefixI True) ((S1 (MetaSel (Just "_rewFunction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rewPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_rewGlob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rewDynamicLinks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) | |
Creates a value of Rewrite with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rewFunction :: Lens' Rewrite (Maybe Text) Source #
The function to proxy requests to. Must match the exported function name exactly.
rewGlob :: Lens' Rewrite (Maybe Text) Source #
Required. The user-supplied glob pattern to match against the request URL path.
rewDynamicLinks :: Lens' Rewrite (Maybe Bool) Source #
The request will be forwarded to Firebase Dynamic Links.
DomainProvisioningCertStatus
data DomainProvisioningCertStatus Source #
The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
Constructors
| CertStatusUnspecified |
|
| CertPending |
|
| CertMissing |
|
| CertProcessing |
|
| CertPropagating |
|
| CertActive |
|
| CertError |
|
Instances
PopulateVersionFilesRequestFiles
data PopulateVersionFilesRequestFiles Source #
A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file.
See: populateVersionFilesRequestFiles smart constructor.
Instances
populateVersionFilesRequestFiles Source #
Arguments
| :: HashMap Text Text | |
| -> PopulateVersionFilesRequestFiles |
Creates a value of PopulateVersionFilesRequestFiles with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
VersionFileStatus
data VersionFileStatus Source #
Output only. The current status of a particular file in the specified version. The value will be either `pending upload` or `uploaded`.
Constructors
| StatusUnspecified |
|
| Expected |
|
| Active |
|
Instances
HeaderHeaders
data HeaderHeaders Source #
Required. The additional headers to add to the response.
See: headerHeaders smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> HeaderHeaders |
Creates a value of HeaderHeaders with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CertHTTPChallenge
data CertHTTPChallenge Source #
Represents an HTTP certificate challenge.
See: certHTTPChallenge smart constructor.
Instances
certHTTPChallenge :: CertHTTPChallenge Source #
Creates a value of CertHTTPChallenge with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
chttpcPath :: Lens' CertHTTPChallenge (Maybe Text) Source #
The URL path on which to serve the specified token to satisfy the certificate challenge.
chttpcToken :: Lens' CertHTTPChallenge (Maybe Text) Source #
The token to serve at the specified URL path to satisfy the certificate challenge.
ServingConfigTrailingSlashBehavior
data ServingConfigTrailingSlashBehavior Source #
Defines how to handle a trailing slash in the URL path.
Constructors
| TrailingSlashBehaviorUnspecified |
|
| Add |
|
| Remove |
|
Instances
ListVersionFilesResponse
data ListVersionFilesResponse Source #
Instances
listVersionFilesResponse :: ListVersionFilesResponse Source #
Creates a value of ListVersionFilesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvfrNextPageToken :: Lens' ListVersionFilesResponse (Maybe Text) Source #
The pagination token, if more results exist.
lvfrFiles :: Lens' ListVersionFilesResponse [VersionFile] Source #
The list path/hashes in the specified version.
ReleaseType
data ReleaseType Source #
Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
Constructors
| TypeUnspecified |
|
| Deploy |
|
| Rollback |
|
| SiteDisable |
|
Instances
SiteConfig
data SiteConfig Source #
A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
See: siteConfig smart constructor.
Instances
siteConfig :: SiteConfig Source #
Creates a value of SiteConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scMaxVersions :: Lens' SiteConfig (Maybe Int64) Source #
The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default.