google_api_cloud_kms v0.8.0 GoogleApi.CloudKMS.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Gets information about a location.
Create a new KeyRing in a given Project and Location.
Create a new CryptoKey within a KeyRing.
Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.
Create a new CryptoKeyVersion in a CryptoKey.
Schedule a CryptoKeyVersion for destruction.
Returns metadata for a given CryptoKeyVersion.
Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
Lists CryptoKeyVersions.
Update a CryptoKeyVersion's metadata.
Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state.
Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists CryptoKeys.
Update a CryptoKey.
Sets the access control policy on the specified resource. Replaces any existing policy.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Update the version of a CryptoKey that will be used in Encrypt.
Returns metadata for a given KeyRing.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Lists KeyRings.
Sets the access control policy on the specified resource. Replaces any existing policy.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Lists information about the supported locations for this service.
Link to this section Functions
cloudkms_projects_locations_get(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source
Gets information about a location.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. Resource name for the location. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Location{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source
Create a new KeyRing in a given Project and Location.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. Required. The resource name of the location associated with the KeyRings, in the formatprojects/*/locations/*
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :keyRingId (String.t): Required. It must be unique within a location and match the regular
expression [a-zA-Z0-9_-]{1,63}
- :body (GoogleApi.CloudKMS.V1.Model.KeyRing.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.KeyRing{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_create(connection, projects_id, locations_id, key_rings_id, optional_params \\ [], opts \\ []) View Source
Create a new CryptoKey within a KeyRing.
CryptoKey.purpose and CryptoKey.version_template.algorithm are required.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. Required. The name of the KeyRing associated with the CryptoKeys. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :cryptoKeyId (String.t): Required. It must be unique within a KeyRing and match the regular
expression [a-zA-Z0-9_-]{1,63}
- :body (GoogleApi.CloudKMS.V1.Model.CryptoKey.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_decrypt(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, crypto_key_versions_id, optional_params \\ [], opts \\ []) View Source
Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. Required. The resource name of the CryptoKeyVersion to use for decryption. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_key_versions_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.AsymmetricDecryptRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.AsymmetricDecryptResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_sign(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, crypto_key_versions_id, optional_params \\ [], opts \\ []) View Source
Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. Required. The resource name of the CryptoKeyVersion to use for signing. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_key_versions_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.AsymmetricSignRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.AsymmetricSignResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_create(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Create a new CryptoKeyVersion in a CryptoKey.
The server will assign the next sequential id. If unset, state will be set to ENABLED.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. Required. The name of the CryptoKey associated with the CryptoKeyVersions. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
parent
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_destroy(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, crypto_key_versions_id, optional_params \\ [], opts \\ []) View Source
Schedule a CryptoKeyVersion for destruction.
Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED and destroy_time will be set to a time 24 hours in the future, at which point the state will be changed to DESTROYED, and the key material will be irrevocably destroyed.
Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The resource name of the CryptoKeyVersion to destroy. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_key_versions_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.DestroyCryptoKeyVersionRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_get(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, crypto_key_versions_id, optional_params \\ [], opts \\ []) View Source
Returns metadata for a given CryptoKeyVersion.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the CryptoKeyVersion to get. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_key_versions_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_get_public_key(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, crypto_key_versions_id, optional_params \\ [], opts \\ []) View Source
Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the CryptoKeyVersion public key to get. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_key_versions_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.PublicKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_list(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Lists CryptoKeyVersions.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. Required. The resource name of the CryptoKey to list, in the formatprojects/*/locations/*/keyRings/*/cryptoKeys/*
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
parent
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (integer()): Optional limit on the number of CryptoKeyVersions to
include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
- :pageToken (String.t): Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token.
- :view (String.t): The fields to include in the response.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListCryptoKeyVersionsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_patch(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, crypto_key_versions_id, optional_params \\ [], opts \\ []) View Source
Update a CryptoKeyVersion's metadata.
state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
cryptoKeyVersion.name
. Output only. The resource name for this CryptoKeyVersion in the formatprojects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*
. - locations_id (String.t): Part of
cryptoKeyVersion.name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
cryptoKeyVersion.name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
cryptoKeyVersion.name
. See documentation ofprojectsId
. - crypto_key_versions_id (String.t): Part of
cryptoKeyVersion.name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (String.t): Required list of fields to be updated in this request.
- :body (GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_restore(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, crypto_key_versions_id, optional_params \\ [], opts \\ []) View Source
Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state.
Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The resource name of the CryptoKeyVersion to restore. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_key_versions_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.RestoreCryptoKeyVersionRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_decrypt(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.DecryptRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.DecryptResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_encrypt(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption.
If a CryptoKey is specified, the server will use its primary version.
- locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.EncryptRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.EncryptResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_get(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the CryptoKey to get. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_get_iam_policy(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_list(connection, projects_id, locations_id, key_rings_id, optional_params \\ [], opts \\ []) View Source
Lists CryptoKeys.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. Required. The resource name of the KeyRing to list, in the formatprojects/*/locations/*/keyRings/*
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (integer()): Optional limit on the number of CryptoKeys to include in the
response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
- :pageToken (String.t): Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token.
- :versionView (String.t): The fields of the primary version to include in the response.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListCryptoKeysResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_patch(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Update a CryptoKey.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
cryptoKey.name
. Output only. The resource name for this CryptoKey in the formatprojects/*/locations/*/keyRings/*/cryptoKeys/*
. - locations_id (String.t): Part of
cryptoKey.name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
cryptoKey.name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
cryptoKey.name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (String.t): Required list of fields to be updated in this request.
- :body (GoogleApi.CloudKMS.V1.Model.CryptoKey.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_set_iam_policy(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.SetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_test_iam_permissions(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.TestIamPermissionsRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_update_primary_version(connection, projects_id, locations_id, key_rings_id, crypto_keys_id, optional_params \\ [], opts \\ []) View Source
Update the version of a CryptoKey that will be used in Encrypt.
Returns an error if called on an asymmetric key.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The resource name of the CryptoKey to update. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. - crypto_keys_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.UpdateCryptoKeyPrimaryVersionRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_get(connection, projects_id, locations_id, key_rings_id, optional_params \\ [], opts \\ []) View Source
Returns metadata for a given KeyRing.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the KeyRing to get. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.KeyRing{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_get_iam_policy(connection, projects_id, locations_id, key_rings_id, optional_params \\ [], opts \\ []) View Source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_import_jobs_get_iam_policy(connection, projects_id, locations_id, key_rings_id, import_jobs_id, optional_params \\ [], opts \\ []) View Source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. - import_jobs_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_import_jobs_set_iam_policy(connection, projects_id, locations_id, key_rings_id, import_jobs_id, optional_params \\ [], opts \\ []) View Source
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. - import_jobs_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.SetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_import_jobs_test_iam_permissions(connection, projects_id, locations_id, key_rings_id, import_jobs_id, optional_params \\ [], opts \\ []) View Source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. - import_jobs_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.TestIamPermissionsRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source
Lists KeyRings.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. Required. The resource name of the location associated with the KeyRings, in the formatprojects/*/locations/*
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (integer()): Optional limit on the number of KeyRings to include in the
response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
- :pageToken (String.t): Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListKeyRingsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_set_iam_policy(connection, projects_id, locations_id, key_rings_id, optional_params \\ [], opts \\ []) View Source
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.SetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_test_iam_permissions(connection, projects_id, locations_id, key_rings_id, optional_params \\ [], opts \\ []) View Source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - key_rings_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudKMS.V1.Model.TestIamPermissionsRequest.t):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_list(connection, projects_id, optional_params \\ [], opts \\ []) View Source
Lists information about the supported locations for this service.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The resource that owns the locations collection, if applicable. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :filter (String.t): The standard list filter.
- :pageSize (integer()): The standard list page size.
- :pageToken (String.t): The standard list page token.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListLocationsResponse{}} on success {:error, info} on failure