google_api_firebase_hosting v0.5.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).

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.

Link to this section Functions

Link to this function

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

View Source
firebasehosting_projects_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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
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, Tesla.Env.t()}

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) - 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
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, Tesla.Env.t()}

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_releases_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
firebasehosting_projects_sites_releases_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.Release.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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) - 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
firebasehosting_projects_sites_releases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseHosting.V1beta1.Model.ListReleasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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