View Source GoogleApi.FirebaseHosting.V1beta1.Api.Projects (google_api_firebase_hosting v0.17.1)
API calls for all endpoints tagged Projects
.
Summary
Functions
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Creates a new channel in the specified site.
Deletes the specified channel of the specified site. The live
channel cannot be deleted.
Retrieves information for the specified channel of the specified site.
Lists the channels for the specified site. All sites have a default live
channel.
Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn't already exist.
Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live
channel and any active preview channels for the specified site.
Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live
channel and any active preview channels for the specified site.
Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.
Creates a CustomDomain
.
Deletes the specified CustomDomain
.
Gets the specified CustomDomain
.
Lists each CustomDomain
associated with the specified parent Hosting site. Returns CustomDomain
s in a consistent, but undefined, order to facilitate pagination.
Gets the latest state of a long-running operation. Use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request.
Updates the specified CustomDomain
.
Undeletes the specified CustomDomain
if it has been soft-deleted. Hosting retains soft-deleted custom domains for around 30 days before permanently deleting them.
Deletes the specified Hosting Site from the specified parent Firebase project.
Creates a domain mapping on the specified site.
Deletes the existing domain mapping on the specified site.
Gets a domain mapping on the specified site.
Lists the domains for the specified site.
Updates the specified domain mapping, creating the mapping as if it does not exist.
Gets the specified Hosting Site.
Gets the Hosting metadata for a specific site.
Lists each Hosting Site associated with the specified parent Firebase project.
Updates attributes of the specified Hosting Site.
Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live
channel and any active preview channels for the specified site.
Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live
channel and any active preview channels for the specified site.
Sets the Hosting metadata for a specific site.
Creates a new version on the specified target site using the content of the specified version.
Creates a new version for the specified site.
Deletes the specified version.
Lists the remaining files to be uploaded for the specified version.
Get the specified version that has been created for the specified site. This can include versions that were created for the default live
channel or for any active preview channels for the specified site.
Lists the versions that have been created for the specified site. This list includes versions for both the default live
channel and any active preview channels for the specified site.
Updates the specified metadata for the specified version. This method will fail with FAILED_PRECONDITION
in the event of an invalid state transition. The supported state transitions for a version are from CREATED
to FINALIZED
. Use DeleteVersion
to set the status of a version to DELETED
.
Adds content files to the specified version. Each file must be under 2 GB.
Functions
@spec firebasehosting_projects_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_channels_create(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_channels_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Channel.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new channel in the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site in which to create this channel, in the format: sites/ SITE_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:channelId
(type:String.t
) - Required. Immutable. A unique ID within the site that identifies the channel. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Channel.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Channel{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_channels_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified channel of the specified site. The live
channel cannot be deleted.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_channels_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Channel.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves information for the specified channel of the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Channel{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_channels_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListChannelsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the channels for the specified site. All sites have a default live
channel.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site for which to list channels, in the format: sites/SITE_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of channels to return. The service may return a lower number if fewer channels exist than this maximum number. If unspecified, defaults to 10. The maximum value is 100; values above 100 will be coerced to 100. -
:pageToken
(type:String.t
) - A token from a previous call toListChannels
that tells the server where to resume listing.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListChannelsResponse{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_channels_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Channel.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn't already exist.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - A comma-separated list of fields to be updated in this request. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Channel.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Channel{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_channels_releases_create(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_channels_releases_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Release.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site or channel to which the release belongs, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:versionName
(type:String.t
) - The unique identifier for a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_ID in this version identifier must match the SITE_ID in theparent
parameter. This query parameter must be empty if thetype
field in the request body isSITE_DISABLE
. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Release.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Release{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_channels_releases_get(connection, name, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_channels_releases_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Release.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live
channel and any active preview channels for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the Hosting release, in either of the following formats: - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID - sites/SITE_ID/releases/RELEASE_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Release{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_channels_releases_list(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_channels_releases_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListReleasesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live
channel and any active preview channels for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site or channel for which to list releases, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of releases to return. The service may return a lower number if fewer releases exist than this maximum number. If unspecified, defaults to 100. -
:pageToken
(type:String.t
) - A token from a previous call toreleases.list
orchannels.releases.list
that tells the server where to resume listing.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListReleasesResponse{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Site.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Firebase project in which to create a Hosting site, in the format: projects/PROJECT_IDENTIFIER Refer to theSite
name
field for details about PROJECT_IDENTIFIER values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:siteId
(type:String.t
) - Required. Immutable. A globally unique identifier for the Hosting site. This identifier is used to construct the Firebase-provisioned subdomains for the site, so it must also be a valid domain name label. -
:validateOnly
(type:boolean()
) - Optional. If set, validates that the site_id is available and that the request would succeed, returning the expected resulting site or error. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Site.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Site{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_create(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a CustomDomain
.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The custom domain's parent, specifically a Firebase HostingSite
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:customDomainId
(type:String.t
) - Required. The ID of theCustomDomain
, which is the domain name you'd like to use with Firebase Hosting. -
:validateOnly
(type:boolean()
) - If true, Hosting validates that it's possible to complete your request but doesn't actually create a newCustomDomain
. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.CustomDomain.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_delete(connection, name, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified CustomDomain
.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of theCustomDomain
to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - If true, the request succeeds even if theCustomDomain
doesn't exist. -
:etag
(type:String.t
) - A tag that represents the state of theCustomDomain
as you know it. If present, the supplied tag must match the current value on yourCustomDomain
, or the request fails. -
:validateOnly
(type:boolean()
) - If true, Hosting validates that it's possible to complete your request but doesn't actually delete theCustomDomain
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_get(connection, name, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.CustomDomain.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified CustomDomain
.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of theCustomDomain
to get. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.CustomDomain{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_list(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListCustomDomainsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists each CustomDomain
associated with the specified parent Hosting site. Returns CustomDomain
s in a consistent, but undefined, order to facilitate pagination.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Firebase HostingSite
withCustomDomain
entities you'd like to list. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The max number ofCustomDomain
entities to return in a request. Defaults to 10. -
:pageToken
(type:String.t
) - A token from a previous call toListCustomDomains
that tells the server where to resume listing. -
:showDeleted
(type:boolean()
) - If true, the request returns soft-deletedCustomDomain
s that haven't been fully-deleted yet. To restore deletedCustomDomain
s, make anUndeleteCustomDomain
request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListCustomDomainsResponse{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_operations_get(connection, name, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_operations_list(connection, name, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_patch(connection, name, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified CustomDomain
.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The fully-qualified name of theCustomDomain
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - If true, Hosting creates theCustomDomain
if it doesn't already exist. -
:updateMask
(type:String.t
) - The set of field names from yourCustomDomain
that you want to update. A field will be overwritten if, and only if, it's in the mask. If you don't provide a mask, Hosting updates the entireCustomDomain
. -
:validateOnly
(type:boolean()
) - If true, Hosting validates that it's possible to complete your request but doesn't actually create or update theCustomDomain
. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.CustomDomain.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_custom_domains_undelete(connection, name, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_custom_domains_undelete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Undeletes the specified CustomDomain
if it has been soft-deleted. Hosting retains soft-deleted custom domains for around 30 days before permanently deleting them.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of theCustomDomain
to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.UndeleteCustomDomainRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified Hosting Site from the specified parent Firebase project.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to theSite
name
field for details about PROJECT_IDENTIFIER values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Empty{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_domains_create(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_domains_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a domain mapping on the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent to create the domain association for, in the format: sites/site-name -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Domain{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_domains_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the existing domain mapping on the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the domain association to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_domains_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a domain mapping on the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the domain configuration to get. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Domain{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_domains_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListDomainsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the domains for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent for which to list domains, in the format: sites/ site-name -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The page size to return. Defaults to 50. -
:pageToken
(type:String.t
) - The next_page_token from a previous request, if provided.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListDomainsResponse{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_domains_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified domain mapping, creating the mapping as if it does not exist.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the domain association to update or create, if an association doesn't already exist. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Domain{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Site.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified Hosting Site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to theSite
name
field for details about PROJECT_IDENTIFIER values. Since a SITE_ID is a globally unique identifier, you can also use the unique sub-collection resource access pattern, in the format: projects/-/sites/SITE_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Site{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_get_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.SiteConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the Hosting metadata for a specific site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.SiteConfig{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListSitesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists each Hosting Site associated with the specified parent Firebase project.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Firebase project for which to list sites, in the format: projects/PROJECT_IDENTIFIER Refer to theSite
name
field for details about PROJECT_IDENTIFIER values. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Optional. The maximum number of sites to return. The service may return a lower number if fewer sites exist than this maximum number. If unspecified, defaults to 40. -
:pageToken
(type:String.t
) - Optional. A token from a previous call toListSites
that tells the server where to resume listing.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListSitesResponse{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Site.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates attributes of the specified Hosting Site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project'sProjectNumber
(recommended) or itsProjectId
. Learn more about using project identifiers in Google's AIP 2510 standard. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - A set of field names from your Site that you want to update. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Site.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Site{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_releases_create(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_releases_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Release.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site or channel to which the release belongs, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:versionName
(type:String.t
) - The unique identifier for a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_ID in this version identifier must match the SITE_ID in theparent
parameter. This query parameter must be empty if thetype
field in the request body isSITE_DISABLE
. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Release.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Release{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_releases_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Release.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live
channel and any active preview channels for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the Hosting release, in either of the following formats: - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID - sites/SITE_ID/releases/RELEASE_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Release{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_releases_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListReleasesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live
channel and any active preview channels for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site or channel for which to list releases, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of releases to return. The service may return a lower number if fewer releases exist than this maximum number. If unspecified, defaults to 100. -
:pageToken
(type:String.t
) - A token from a previous call toreleases.list
orchannels.releases.list
that tells the server where to resume listing.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListReleasesResponse{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_update_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.SiteConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the Hosting metadata for a specific site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - A set of field names from your site configuration that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of onlymax_versions
will be used. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.SiteConfig.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.SiteConfig{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_versions_clone(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_versions_clone( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new version on the specified target site using the content of the specified version.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The target site for the cloned version, in the format: sites/ SITE_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.CloneVersionRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Operation{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_versions_create(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_versions_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Version.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new version for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site in which to create the version, in the format: sites/ SITE_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:sizeBytes
(type:String.t
) - The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads. -
:versionId
(type:String.t
) - A unique id for the new version. This is was only specified for legacy version creations, and should be blank. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Version.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Version{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_versions_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified version.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the version, in the format: sites/SITE_ID/versions/VERSION_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Empty{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_versions_files_list(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_versions_files_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListVersionFilesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the remaining files to be uploaded for the specified version.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The version for which to list files, in the format: sites/SITE_ID /versions/VERSION_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of version files to return. The service may return a lower number if fewer version files exist than this maximum number. If unspecified, defaults to 1000. -
:pageToken
(type:String.t
) - A token from a previous call toListVersionFiles
that tells the server where to resume listing. -
:status
(type:String.t
) - The type of files that should be listed for the specified version.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListVersionFilesResponse{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_versions_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Version.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get the specified version that has been created for the specified site. This can include versions that were created for the default live
channel or for any active preview channels for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully-qualified resource name for the version, in the format: sites/SITE_ID/versions/VERSION_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Version{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_versions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListVersionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the versions that have been created for the specified site. This list includes versions for both the default live
channel and any active preview channels for the specified site.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The site or channel for which to list versions, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A filter string used to return a subset of versions in the response. The currently supported fields for filtering are:name
,status
, andcreate_time
. Learn more about filtering in Google's AIP 160 standard. -
:pageSize
(type:integer()
) - The maximum number of versions to return. The service may return a lower number if fewer versions exist than this maximum number. If unspecified, defaults to 25. The maximum value is 100; values above 100 will be coerced to 100. -
:pageToken
(type:String.t
) - A token from a previous call toListVersions
that tells the server where to resume listing.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListVersionsResponse{}}
on success -
{:error, info}
on failure
@spec firebasehosting_projects_sites_versions_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Version.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified metadata for the specified version. This method will fail with FAILED_PRECONDITION
in the event of an invalid state transition. The supported state transitions for a version are from CREATED
to FINALIZED
. Use DeleteVersion
to set the status of a version to DELETED
.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
name
(type:String.t
) - The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you callCreateVersion
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - A set of field names from your version that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of onlystatus
will be used. -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.Version.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.Version{}}
on success -
{:error, info}
on failure
firebasehosting_projects_sites_versions_populate_files(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasehosting_projects_sites_versions_populate_files( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.PopulateVersionFilesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Adds content files to the specified version. Each file must be under 2 GB.
Parameters
-
connection
(type:GoogleApi.FirebaseHosting.V1beta1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The version to which to add files, in the format: sites/SITE_ID /versions/VERSION_ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseHosting.V1beta1.Model.PopulateVersionFilesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.PopulateVersionFilesResponse{}}
on success -
{:error, info}
on failure