View Source GoogleApi.KMSInventory.V1.Api.Projects (google_api_kms_inventory v0.4.0)

API calls for all endpoints tagged Projects.

Summary

Functions

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

Returns aggregate information about the resources protected by the given Cloud KMS CryptoKey. Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.

Functions

Link to this function

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

View Source
@spec kmsinventory_projects_crypto_keys_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.KMSInventory.V1.Model.GoogleCloudKmsInventoryV1ListCryptoKeysResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

Parameters

  • connection (type: GoogleApi.KMSInventory.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The Google Cloud project for which to retrieve key metadata, in the format projects/*
  • 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 keys to return. The service may return fewer than this value. If unspecified, at most 1000 keys will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    • :pageToken (type: String.t) - Optional. Pass this into a subsequent request in order to receive the next page of results.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.KMSInventory.V1.Model.GoogleCloudKmsInventoryV1ListCryptoKeysResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec kmsinventory_projects_locations_key_rings_crypto_keys_get_protected_resources_summary(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.KMSInventory.V1.Model.GoogleCloudKmsInventoryV1ProtectedResourcesSummary.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns aggregate information about the resources protected by the given Cloud KMS CryptoKey. Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.

Parameters

  • connection (type: GoogleApi.KMSInventory.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the CryptoKey.
  • 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.KMSInventory.V1.Model.GoogleCloudKmsInventoryV1ProtectedResourcesSummary{}} on success
  • {:error, info} on failure