google_api_cloud_kms v0.10.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
cloudkms_projects_locations_get(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.Location.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Location.t()} | {:error, Tesla.Env.t()}
Gets information about a location.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Resource name for the location.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_create(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.KeyRing.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.KeyRing.t()} | {:error, Tesla.Env.t()}
Create a new KeyRing in a given Project and Location.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The resource name of the location associated with the KeyRings, in the formatprojects/*/locations/*
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.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").:keyRingId
(type:String.t
) - Required. It must be unique within a location and match the regular expression[a-zA-Z0-9_-]{1,63}
:body
(type:GoogleApi.CloudKMS.V1.Model.KeyRing.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_create(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Create a new CryptoKey within a KeyRing.
CryptoKey.purpose and CryptoKey.version_template.algorithm are required.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The name of the KeyRing associated with the CryptoKeys.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.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").:cryptoKeyId
(type:String.t
) - Required. It must be unique within a KeyRing and match the regular expression[a-zA-Z0-9_-]{1,63}
:body
(type:GoogleApi.CloudKMS.V1.Model.CryptoKey.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_decrypt(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.AsymmetricDecryptResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_decrypt( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.AsymmetricDecryptResponse.t()} | {:error, Tesla.Env.t()}
Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. The resource name of the CryptoKeyVersion to use for decryption.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_key_versions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.AsymmetricDecryptRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_sign(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.AsymmetricSignResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_sign( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.AsymmetricSignResponse.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. The resource name of the CryptoKeyVersion to use for signing.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_key_versions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.AsymmetricSignRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_create(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The name of the CryptoKey associated with the CryptoKeyVersions.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.CryptoKeyVersion.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_destroy(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_destroy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The resource name of the CryptoKeyVersion to destroy.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_key_versions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.DestroyCryptoKeyVersionRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_get(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
Returns metadata for a given CryptoKeyVersion.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The name of the CryptoKeyVersion to get.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_key_versions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_get_public_key(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.PublicKey.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_get_public_key( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.PublicKey.t()} | {:error, Tesla.Env.t()}
Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The name of the CryptoKeyVersion public key to get.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_key_versions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_list(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.ListCryptoKeyVersionsResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListCryptoKeyVersionsResponse.t()} | {:error, Tesla.Env.t()}
Lists CryptoKeyVersions.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The resource name of the CryptoKey to list, in the formatprojects/*/locations/*/keyRings/*/cryptoKeys/*
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.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 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
(type:String.t
) - Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token.:view
(type:String.t
) - The fields to include in the response.
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_patch(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofcryptoKeyVersion.name
. Output only. The resource name for this CryptoKeyVersion in the formatprojects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*
.locations_id
(type:String.t
) - Part ofcryptoKeyVersion.name
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofcryptoKeyVersion.name
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofcryptoKeyVersion.name
. See documentation ofprojectsId
.crypto_key_versions_id
(type:String.t
) - Part ofcryptoKeyVersion.name
. See documentation ofprojectsId
.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
) - Required list of fields to be updated in this request.:body
(type:GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_restore(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_restore( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The resource name of the CryptoKeyVersion to restore.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_key_versions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.RestoreCryptoKeyVersionRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_decrypt(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.DecryptResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_decrypt( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.DecryptResponse.t()} | {:error, Tesla.Env.t()}
Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.DecryptRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_encrypt(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.EncryptResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_encrypt( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.EncryptResponse.t()} | {:error, Tesla.Env.t()}
Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. 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
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.EncryptRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_get(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The name of the CryptoKey to get.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_crypto_keys_get_iam_policy(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_crypto_keys_list(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.ListCryptoKeysResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListCryptoKeysResponse.t()} | {:error, Tesla.Env.t()}
Lists CryptoKeys.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The resource name of the KeyRing to list, in the formatprojects/*/locations/*/keyRings/*
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.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 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
(type:String.t
) - Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token.:versionView
(type:String.t
) - The fields of the primary version to include in the response.
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_patch(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Update a CryptoKey.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofcryptoKey.name
. Output only. The resource name for this CryptoKey in the formatprojects/*/locations/*/keyRings/*/cryptoKeys/*
.locations_id
(type:String.t
) - Part ofcryptoKey.name
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofcryptoKey.name
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofcryptoKey.name
. See documentation ofprojectsId
.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
) - Required list of fields to be updated in this request.:body
(type:GoogleApi.CloudKMS.V1.Model.CryptoKey.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_set_iam_policy(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.SetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_test_iam_permissions(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.TestIamPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_crypto_keys_update_primary_version(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_crypto_keys_update_primary_version( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Update the version of a CryptoKey that will be used in Encrypt.
Returns an error if called on an asymmetric key.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The resource name of the CryptoKey to update.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.crypto_keys_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.UpdateCryptoKeyPrimaryVersionRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_get(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.KeyRing.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.KeyRing.t()} | {:error, Tesla.Env.t()}
Returns metadata for a given KeyRing.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The name of the KeyRing to get.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_get_iam_policy(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_import_jobs_get_iam_policy(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_import_jobs_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.import_jobs_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.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
cloudkms_projects_locations_key_rings_import_jobs_set_iam_policy(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_import_jobs_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.import_jobs_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.SetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_import_jobs_test_iam_permissions(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_import_jobs_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.import_jobs_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.TestIamPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_list(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.ListKeyRingsResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListKeyRingsResponse.t()} | {:error, Tesla.Env.t()}
Lists KeyRings.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The resource name of the location associated with the KeyRings, in the formatprojects/*/locations/*
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.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 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
(type:String.t
) - Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_set_iam_policy(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.SetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_key_rings_test_iam_permissions(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_key_rings_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.key_rings_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.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.CloudKMS.V1.Model.TestIamPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
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
cloudkms_projects_locations_list(
Tesla.Env.client(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.CloudKMS.V1.Model.ListLocationsResponse.t()}
| {:error, Tesla.Env.t()}
cloudkms_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListLocationsResponse.t()} | {:error, Tesla.Env.t()}
Lists information about the supported locations for this service.
Parameters
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The resource that owns the locations collection, if applicable.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 standard list filter.:pageSize
(type:integer()
) - The standard list page size.:pageToken
(type:String.t
) - The standard list page token.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListLocationsResponse{}}
on success{:error, info}
on failure