google_api_firebase_hosting v0.10.0 GoogleApi.FirebaseHosting.V1beta1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section 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 release which makes the content of the specified version actively display on the appropriate URL(s).

Updates the specified domain mapping, creating the mapping as if it does not exist.

Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).

Lists the releases that have been created on the specified site.

Lists the remaining files to be uploaded for the specified version.

Lists the versions that have been created on the specified site. Will include filtering in the future.

Updates the specified metadata for a version. Note that this method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The only valid transition for a version is currently from a CREATED status to a FINALIZED status. Use DeleteVersion to set the status of a version to DELETED.

Link to this section Functions

Link to this function

firebasehosting_projects_operations_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

firebasehosting_projects_sites_channels_releases_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_channels_releases_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Release.t()}
  | {:ok, Tesla.Env.t()}
  | {: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 that the release belongs to, 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").
    • :versionName (type: String.t) - The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the parent parameter. This query parameter must be empty if the type field in the request body is SITE_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
Link to this function

firebasehosting_projects_sites_channels_releases_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_channels_releases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListReleasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists the releases that have been created on 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 files, 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 100.
    • :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.ListReleasesResponse{}} on success
  • {:error, info} on failure
Link to this function

firebasehosting_projects_sites_domains_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_domains_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

firebasehosting_projects_sites_domains_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_domains_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

firebasehosting_projects_sites_domains_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_domains_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

firebasehosting_projects_sites_domains_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_domains_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListDomainsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

firebasehosting_projects_sites_domains_update(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_domains_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Domain.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

firebasehosting_projects_sites_get_config(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_get_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.SiteConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

firebasehosting_projects_sites_releases_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_releases_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Release.t()}
  | {:ok, Tesla.Env.t()}
  | {: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 that the release belongs to, 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").
    • :versionName (type: String.t) - The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the parent parameter. This query parameter must be empty if the type field in the request body is SITE_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
Link to this function

firebasehosting_projects_sites_releases_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_releases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListReleasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists the releases that have been created on 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 files, 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 100.
    • :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.ListReleasesResponse{}} on success
  • {:error, info} on failure
Link to this function

firebasehosting_projects_sites_update_config(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_update_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.SiteConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {: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 only max_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
Link to this function

firebasehosting_projects_sites_versions_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_versions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new version for a site.

Parameters

  • connection (type: GoogleApi.FirebaseHosting.V1beta1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent to create the version 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").
    • :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 only specified for legacy version creations.
    • :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
Link to this function

firebasehosting_projects_sites_versions_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_versions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes the specified version.

Parameters

  • connection (type: GoogleApi.FirebaseHosting.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the version to be deleted, in the format: sites/ site-name/versions/versionID
  • 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
Link to this function

firebasehosting_projects_sites_versions_files_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_versions_files_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListVersionFilesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {: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 parent to list files for, in the format: sites/site-name /versions/versionID
  • 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 1000.
    • :pageToken (type: String.t) - The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.
    • :status (type: String.t) - The type of files in the version that should be listed.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseHosting.V1beta1.Model.ListVersionFilesResponse{}} on success
  • {:error, info} on failure
Link to this function

firebasehosting_projects_sites_versions_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_versions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListVersionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists the versions that have been created on the specified site. Will include filtering in the future.

Parameters

  • connection (type: GoogleApi.FirebaseHosting.V1beta1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent for which to list files, 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").
    • :filter (type: String.t) - The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering.
    • :pageSize (type: integer()) - The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100
    • :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.ListVersionsResponse{}} on success
  • {:error, info} on failure
Link to this function

firebasehosting_projects_sites_versions_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_versions_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates the specified metadata for a version. Note that this method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The only valid transition for a version is currently from a CREATED status to a FINALIZED status. 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 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.
  • 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 only status 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
Link to this function

firebasehosting_projects_sites_versions_populate_files(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

firebasehosting_projects_sites_versions_populate_files(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.FirebaseHosting.V1beta1.Model.PopulateVersionFilesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Adds content files to a 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 add files to, in the format: sites/site-name /versions/versionID
  • 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