GoogleApi.Storage.V1.Api.Projects (google_api_storage v0.29.0) View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

storage_projects_hmac_keys_create(connection, project_id, service_account_email, optional_params \\ [], opts \\ [])

Creates a new HMAC key for the specified service account.

storage_projects_hmac_keys_delete(connection, project_id, access_id, optional_params \\ [], opts \\ [])

Deletes an HMAC key.

storage_projects_hmac_keys_get(connection, project_id, access_id, optional_params \\ [], opts \\ [])

Retrieves an HMAC key's metadata

storage_projects_hmac_keys_list(connection, project_id, optional_params \\ [], opts \\ [])

Retrieves a list of HMAC keys matching the criteria.

storage_projects_hmac_keys_update(connection, project_id, access_id, optional_params \\ [], opts \\ [])

Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.

storage_projects_service_account_get(connection, project_id, optional_params \\ [], opts \\ [])

Get the email address of this project's Google Cloud Storage service account.

Link to this section Functions

storage_projects_hmac_keys_create(connection, project_id, service_account_email, optional_params \\ [], opts \\ [])

Specs

storage_projects_hmac_keys_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.HmacKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new HMAC key for the specified service account.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
project_id (type: String.t) - Project ID owning the service account.
service_account_email (type: String.t) - Email address of the service account.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :userProject (type: String.t) - The project to be billed for this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.HmacKey{}} on success
{:error, info} on failure

storage_projects_hmac_keys_delete(connection, project_id, access_id, optional_params \\ [], opts \\ [])

Specs

storage_projects_hmac_keys_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes an HMAC key.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
project_id (type: String.t) - Project ID owning the requested key
access_id (type: String.t) - Name of the HMAC key to be deleted.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :userProject (type: String.t) - The project to be billed for this request.
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

storage_projects_hmac_keys_get(connection, project_id, access_id, optional_params \\ [], opts \\ [])

Specs

storage_projects_hmac_keys_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.HmacKeyMetadata.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves an HMAC key's metadata

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
project_id (type: String.t) - Project ID owning the service account of the requested key.
access_id (type: String.t) - Name of the HMAC key.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :userProject (type: String.t) - The project to be billed for this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.HmacKeyMetadata{}} on success
{:error, info} on failure

storage_projects_hmac_keys_list(connection, project_id, optional_params \\ [], opts \\ [])

Specs

storage_projects_hmac_keys_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.HmacKeysMetadata.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of HMAC keys matching the criteria.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
project_id (type: String.t) - Name of the project in which to look for HMAC keys.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :maxResults (type: integer()) - Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.
- :pageToken (type: String.t) - A previously-returned page token representing part of the larger set of results to view.
- :serviceAccountEmail (type: String.t) - If present, only keys for the given service account are returned.
- :showDeletedKeys (type: boolean()) - Whether or not to show keys in the DELETED state.
- :userProject (type: String.t) - The project to be billed for this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.HmacKeysMetadata{}} on success
{:error, info} on failure

storage_projects_hmac_keys_update(connection, project_id, access_id, optional_params \\ [], opts \\ [])

Specs

storage_projects_hmac_keys_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.HmacKeyMetadata.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
project_id (type: String.t) - Project ID owning the service account of the updated key.
access_id (type: String.t) - Name of the HMAC key being updated.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :userProject (type: String.t) - The project to be billed for this request.
- :body (type: GoogleApi.Storage.V1.Model.HmacKeyMetadata.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.HmacKeyMetadata{}} on success
{:error, info} on failure

storage_projects_service_account_get(connection, project_id, optional_params \\ [], opts \\ [])

Specs

storage_projects_service_account_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ServiceAccount.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get the email address of this project's Google Cloud Storage service account.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
project_id (type: String.t) - Project ID
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :provisionalUserProject (type: String.t) - The project to be billed for this request if the target bucket is requester-pays bucket.
- :userProject (type: String.t) - The project to be billed for this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.ServiceAccount{}} on success
{:error, info} on failure