Struct google_cloudkms1::api::ProjectMethods

pub struct ProjectMethods<'a, C> where
    C: 'a,  { /* fields omitted */ }

A builder providing access to all methods supported on project resources. It is not used directly, but through the CloudKMS hub.

Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_cloudkms1 as cloudkms1;
 
use std::default::Default;
use oauth2;
use cloudkms1::CloudKMS;
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = yup_oauth2::InstalledFlowAuthenticator::builder(
        secret,
        yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = CloudKMS::new(hyper::Client::builder().build(hyper_rustls::HttpsConnector::with_native_roots()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `locations_get(...)`, `locations_key_rings_create(...)`, `locations_key_rings_crypto_keys_create(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_decrypt(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_sign(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_create(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_destroy(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_get(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_get_public_key(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_import(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_list(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_patch(...)`, `locations_key_rings_crypto_keys_crypto_key_versions_restore(...)`, `locations_key_rings_crypto_keys_decrypt(...)`, `locations_key_rings_crypto_keys_encrypt(...)`, `locations_key_rings_crypto_keys_get(...)`, `locations_key_rings_crypto_keys_get_iam_policy(...)`, `locations_key_rings_crypto_keys_list(...)`, `locations_key_rings_crypto_keys_patch(...)`, `locations_key_rings_crypto_keys_set_iam_policy(...)`, `locations_key_rings_crypto_keys_test_iam_permissions(...)`, `locations_key_rings_crypto_keys_update_primary_version(...)`, `locations_key_rings_get(...)`, `locations_key_rings_get_iam_policy(...)`, `locations_key_rings_import_jobs_create(...)`, `locations_key_rings_import_jobs_get(...)`, `locations_key_rings_import_jobs_get_iam_policy(...)`, `locations_key_rings_import_jobs_list(...)`, `locations_key_rings_import_jobs_set_iam_policy(...)`, `locations_key_rings_import_jobs_test_iam_permissions(...)`, `locations_key_rings_list(...)`, `locations_key_rings_set_iam_policy(...)`, `locations_key_rings_test_iam_permissions(...)` and `locations_list(...)`
// to build up your call.
let rb = hub.projects();

Implementations

impl<'a, C> ProjectMethods<'a, C>

pub fn locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_decrypt(
    &self,
    request: AsymmetricDecryptRequest,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricDecryptCall<'a, C>

Create a builder to help you perform the following task:

Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.

Arguments

• request - No description provided.
• name - Required. The resource name of the CryptoKeyVersion to use for decryption.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_asymmetric_sign(
    &self,
    request: AsymmetricSignRequest,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricSignCall<'a, C>

Create a builder to help you perform the following task:

Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.

Arguments

• request - No description provided.
• name - Required. The resource name of the CryptoKeyVersion to use for signing.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_create(
    &self,
    request: CryptoKeyVersion,
    parent: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionCreateCall<'a, C>

Create a builder to help you perform the following task:

Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.

Arguments

• request - No description provided.
• parent - Required. The name of the CryptoKey associated with the CryptoKeyVersions.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_destroy(
    &self,
    request: DestroyCryptoKeyVersionRequest,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionDestroyCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• name - Required. The resource name of the CryptoKeyVersion to destroy.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_get(
    &self,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetCall<'a, C>

Create a builder to help you perform the following task:

Returns metadata for a given CryptoKeyVersion.

Arguments

• name - Required. The name of the CryptoKeyVersion to get.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_get_public_key(
    &self,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetPublicKeyCall<'a, C>

Create a builder to help you perform the following task:

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

Arguments

• name - Required. The name of the CryptoKeyVersion public key to get.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_import(
    &self,
    request: ImportCryptoKeyVersionRequest,
    parent: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionImportCall<'a, C>

Create a builder to help you perform the following task:

Imports a new CryptoKeyVersion into an existing CryptoKey using the wrapped key material provided in the request. The version ID will be assigned the next sequential id within the CryptoKey.

Arguments

• request - No description provided.
• parent - Required. The name of the CryptoKey to be imported into.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_list(
    &self,
    parent: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionListCall<'a, C>

Create a builder to help you perform the following task:

Lists CryptoKeyVersions.

Arguments

• parent - Required. The resource name of the CryptoKey to list, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_patch(
    &self,
    request: CryptoKeyVersion,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionPatchCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• name - Output only. The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

pub fn locations_key_rings_crypto_keys_crypto_key_versions_restore(
    &self,
    request: RestoreCryptoKeyVersionRequest,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyCryptoKeyVersionRestoreCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• name - Required. The resource name of the CryptoKeyVersion to restore.

pub fn locations_key_rings_crypto_keys_create(
    &self,
    request: CryptoKey,
    parent: &str
) -> ProjectLocationKeyRingCryptoKeyCreateCall<'a, C>

Create a builder to help you perform the following task:

Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.

Arguments

• request - No description provided.
• parent - Required. The name of the KeyRing associated with the CryptoKeys.

pub fn locations_key_rings_crypto_keys_decrypt(
    &self,
    request: DecryptRequest,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyDecryptCall<'a, C>

Create a builder to help you perform the following task:

Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

Arguments

• request - No description provided.
• name - Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.

pub fn locations_key_rings_crypto_keys_encrypt(
    &self,
    request: EncryptRequest,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyEncryptCall<'a, C>

Create a builder to help you perform the following task:

Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

Arguments

• request - No description provided.
• 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.

pub fn locations_key_rings_crypto_keys_get(
    &self,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyGetCall<'a, C>

Create a builder to help you perform the following task:

Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.

Arguments

• name - Required. The name of the CryptoKey to get.

pub fn locations_key_rings_crypto_keys_get_iam_policy(
    &self,
    resource: &str
) -> ProjectLocationKeyRingCryptoKeyGetIamPolicyCall<'a, C>

Create a builder to help you perform the following task:

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Arguments

• resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_crypto_keys_list(
    &self,
    parent: &str
) -> ProjectLocationKeyRingCryptoKeyListCall<'a, C>

Create a builder to help you perform the following task:

Lists CryptoKeys.

Arguments

• parent - Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*.

pub fn locations_key_rings_crypto_keys_patch(
    &self,
    request: CryptoKey,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyPatchCall<'a, C>

Create a builder to help you perform the following task:

Update a CryptoKey.

Arguments

• request - No description provided.
• name - Output only. The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

pub fn locations_key_rings_crypto_keys_set_iam_policy(
    &self,
    request: SetIamPolicyRequest,
    resource: &str
) -> ProjectLocationKeyRingCryptoKeySetIamPolicyCall<'a, C>

Create a builder to help you perform the following task:

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Arguments

• request - No description provided.
• resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_crypto_keys_test_iam_permissions(
    &self,
    request: TestIamPermissionsRequest,
    resource: &str
) -> ProjectLocationKeyRingCryptoKeyTestIamPermissionCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_crypto_keys_update_primary_version(
    &self,
    request: UpdateCryptoKeyPrimaryVersionRequest,
    name: &str
) -> ProjectLocationKeyRingCryptoKeyUpdatePrimaryVersionCall<'a, C>

Create a builder to help you perform the following task:

Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on an asymmetric key.

Arguments

• request - No description provided.
• name - Required. The resource name of the CryptoKey to update.

pub fn locations_key_rings_import_jobs_create(
    &self,
    request: ImportJob,
    parent: &str
) -> ProjectLocationKeyRingImportJobCreateCall<'a, C>

Create a builder to help you perform the following task:

Create a new ImportJob within a KeyRing. ImportJob.import_method is required.

Arguments

• request - No description provided.
• parent - Required. The name of the KeyRing associated with the ImportJobs.

pub fn locations_key_rings_import_jobs_get(
    &self,
    name: &str
) -> ProjectLocationKeyRingImportJobGetCall<'a, C>

Create a builder to help you perform the following task:

Returns metadata for a given ImportJob.

Arguments

• name - Required. The name of the ImportJob to get.

pub fn locations_key_rings_import_jobs_get_iam_policy(
    &self,
    resource: &str
) -> ProjectLocationKeyRingImportJobGetIamPolicyCall<'a, C>

Create a builder to help you perform the following task:

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Arguments

• resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_import_jobs_list(
    &self,
    parent: &str
) -> ProjectLocationKeyRingImportJobListCall<'a, C>

Create a builder to help you perform the following task:

Lists ImportJobs.

Arguments

• parent - Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*.

pub fn locations_key_rings_import_jobs_set_iam_policy(
    &self,
    request: SetIamPolicyRequest,
    resource: &str
) -> ProjectLocationKeyRingImportJobSetIamPolicyCall<'a, C>

Create a builder to help you perform the following task:

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Arguments

• request - No description provided.
• resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_import_jobs_test_iam_permissions(
    &self,
    request: TestIamPermissionsRequest,
    resource: &str
) -> ProjectLocationKeyRingImportJobTestIamPermissionCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_create(
    &self,
    request: KeyRing,
    parent: &str
) -> ProjectLocationKeyRingCreateCall<'a, C>

Create a builder to help you perform the following task:

Create a new KeyRing in a given Project and Location.

Arguments

• request - No description provided.
• parent - Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.

pub fn locations_key_rings_get(
    &self,
    name: &str
) -> ProjectLocationKeyRingGetCall<'a, C>

Create a builder to help you perform the following task:

Returns metadata for a given KeyRing.

Arguments

• name - Required. The name of the KeyRing to get.

pub fn locations_key_rings_get_iam_policy(
    &self,
    resource: &str
) -> ProjectLocationKeyRingGetIamPolicyCall<'a, C>

Create a builder to help you perform the following task:

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Arguments

• resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_list(
    &self,
    parent: &str
) -> ProjectLocationKeyRingListCall<'a, C>

Create a builder to help you perform the following task:

Lists KeyRings.

Arguments

• parent - Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.

pub fn locations_key_rings_set_iam_policy(
    &self,
    request: SetIamPolicyRequest,
    resource: &str
) -> ProjectLocationKeyRingSetIamPolicyCall<'a, C>

Create a builder to help you perform the following task:

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Arguments

• request - No description provided.
• resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

pub fn locations_key_rings_test_iam_permissions(
    &self,
    request: TestIamPermissionsRequest,
    resource: &str
) -> ProjectLocationKeyRingTestIamPermissionCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, C>

Create a builder to help you perform the following task:

Gets information about a location.

Arguments

• name - Resource name for the location.

pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, C>

Create a builder to help you perform the following task:

Lists information about the supported locations for this service.

Arguments

• name - The resource that owns the locations collection, if applicable.

Trait Implementations

impl<'a, C> MethodsBuilder for ProjectMethods<'a, C>