Struct CertificateAuthorityService 

pub struct CertificateAuthorityService { /* private fields */ }

Implements a client for the Certificate Authority API.

Example

let client = CertificateAuthorityService::builder().build().await?;
// use `client` to make requests to the Certificate Authority API.

Service Description

Certificate Authority Service manages private certificate authorities and issued certificates.

Configuration

To configure CertificateAuthorityService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://privateca.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

CertificateAuthorityService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap CertificateAuthorityService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl CertificateAuthorityService

pub fn builder() -> ClientBuilder

Returns a builder for CertificateAuthorityService.

let client = CertificateAuthorityService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: CertificateAuthorityService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn create_certificate(&self) -> CreateCertificate

Create a new Certificate in a given Project, Location from a particular CaPool.

pub fn get_certificate(&self) -> GetCertificate

Returns a Certificate.

pub fn list_certificates(&self) -> ListCertificates

Lists Certificates.

pub fn revoke_certificate(&self) -> RevokeCertificate

Revoke a Certificate.

pub fn update_certificate(&self) -> UpdateCertificate

Update a Certificate. Currently, the only field you can update is the labels field.

pub fn activate_certificate_authority(&self) -> ActivateCertificateAuthority

Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_certificate_authority(&self) -> CreateCertificateAuthority

Create a new CertificateAuthority in a given Project and Location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn disable_certificate_authority(&self) -> DisableCertificateAuthority

Disable a CertificateAuthority.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn enable_certificate_authority(&self) -> EnableCertificateAuthority

Enable a CertificateAuthority.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn fetch_certificate_authority_csr(&self) -> FetchCertificateAuthorityCsr

Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.

pub fn get_certificate_authority(&self) -> GetCertificateAuthority

Returns a CertificateAuthority.

pub fn list_certificate_authorities(&self) -> ListCertificateAuthorities

Lists CertificateAuthorities.

pub fn undelete_certificate_authority(&self) -> UndeleteCertificateAuthority

Undelete a CertificateAuthority that has been deleted.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_certificate_authority(&self) -> DeleteCertificateAuthority

Delete a CertificateAuthority.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_certificate_authority(&self) -> UpdateCertificateAuthority

Update a CertificateAuthority.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_ca_pool(&self) -> CreateCaPool

Create a CaPool.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_ca_pool(&self) -> UpdateCaPool

Update a CaPool.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_ca_pool(&self) -> GetCaPool

Returns a CaPool.

pub fn list_ca_pools(&self) -> ListCaPools

Lists CaPools.

pub fn delete_ca_pool(&self) -> DeleteCaPool

Delete a CaPool.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn fetch_ca_certs(&self) -> FetchCaCerts

FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED, DISABLED, or STAGED states.

pub fn get_certificate_revocation_list(&self) -> GetCertificateRevocationList

Returns a CertificateRevocationList.

pub fn list_certificate_revocation_lists( &self, ) -> ListCertificateRevocationLists

Lists CertificateRevocationLists.

pub fn update_certificate_revocation_list( &self, ) -> UpdateCertificateRevocationList

Update a CertificateRevocationList.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_certificate_template(&self) -> CreateCertificateTemplate

Create a new CertificateTemplate in a given Project and Location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_certificate_template(&self) -> DeleteCertificateTemplate

DeleteCertificateTemplate deletes a CertificateTemplate.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_certificate_template(&self) -> GetCertificateTemplate

Returns a CertificateTemplate.

pub fn list_certificate_templates(&self) -> ListCertificateTemplates

Lists CertificateTemplates.

pub fn update_certificate_template(&self) -> UpdateCertificateTemplate

Update a CertificateTemplate.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

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

pub fn test_iam_permissions(&self) -> TestIamPermissions

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.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for CertificateAuthorityService

fn clone(&self) -> CertificateAuthorityService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CertificateAuthorityService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.