Certificate Authority Service manages private certificate authorities and issued certificates.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
CertificateAuthorityServiceClient(CertificateAuthorityServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CertificateAuthorityServiceClient const &
|
CertificateAuthorityServiceClient(CertificateAuthorityServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CertificateAuthorityServiceClient &&
|
CertificateAuthorityServiceClient(std::shared_ptr< CertificateAuthorityServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< CertificateAuthorityServiceConnection >
|
opts |
Options
|
Operators
operator=(CertificateAuthorityServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CertificateAuthorityServiceClient const &
|
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceClient & |
operator=(CertificateAuthorityServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CertificateAuthorityServiceClient &&
|
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceClient & |
Functions
CreateCertificate(std::string const &, google::cloud::security::privateca::v1::Certificate const &, std::string const &, Options)
Create a new Certificate in a given Project, Location from a particular CaPool.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the CaPool associated with the Certificate, in the format |
certificate |
google::cloud::security::privateca::v1::Certificate const &
Required. A Certificate with initial field values. |
certificate_id |
std::string const &
Optional. It must be unique within a location and match the regular expression |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCertificate(google::cloud::security::privateca::v1::CreateCertificateRequest const &, Options)
Create a new Certificate in a given Project, Location from a particular CaPool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::CreateCertificateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCertificate(std::string const &, Options)
Returns a Certificate.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The [name][google.cloud.security.privateca.v1.Certificate.name] of the Certificate to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCertificate(google::cloud::security::privateca::v1::GetCertificateRequest const &, Options)
Returns a Certificate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::GetCertificateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCertificates(std::string const &, Options)
Lists Certificates.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the location associated with the Certificates, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::Certificate > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCertificates(google::cloud::security::privateca::v1::ListCertificatesRequest, Options)
Lists Certificates.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::ListCertificatesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::Certificate > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
RevokeCertificate(std::string const &, Options)
Revoke a Certificate.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this Certificate in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RevokeCertificate(google::cloud::security::privateca::v1::RevokeCertificateRequest const &, Options)
Revoke a Certificate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::RevokeCertificateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateCertificate(google::cloud::security::privateca::v1::Certificate const &, google::protobuf::FieldMask const &, Options)
Update a Certificate.
Currently, the only field you can update is the labels field.
Parameters | |
---|---|
Name | Description |
certificate |
google::cloud::security::privateca::v1::Certificate const &
Required. Certificate with updated values. |
update_mask |
google::protobuf::FieldMask const &
Required. A list of fields to be updated in this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateCertificate(google::cloud::security::privateca::v1::UpdateCertificateRequest const &, Options)
Update a Certificate.
Currently, the only field you can update is the labels field.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::UpdateCertificateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::Certificate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ActivateCertificateAuthority(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CertificateAuthority in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
ActivateCertificateAuthority(google::cloud::security::privateca::v1::ActivateCertificateAuthorityRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::ActivateCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
CreateCertificateAuthority(std::string const &, google::cloud::security::privateca::v1::CertificateAuthority const &, std::string const &, Options)
Create a new CertificateAuthority in a given Project and Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the [CaPool][google.cloud.security.privateca.v1.CaPool] associated with the CertificateAuthorities, in the format |
certificate_authority |
google::cloud::security::privateca::v1::CertificateAuthority const &
Required. A CertificateAuthority with initial field values. |
certificate_authority_id |
std::string const &
Required. It must be unique within a location and match the regular expression |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
CreateCertificateAuthority(google::cloud::security::privateca::v1::CreateCertificateAuthorityRequest const &, Options)
Create a new CertificateAuthority in a given Project and Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::CreateCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
DisableCertificateAuthority(std::string const &, Options)
Disable a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CertificateAuthority in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
DisableCertificateAuthority(google::cloud::security::privateca::v1::DisableCertificateAuthorityRequest const &, Options)
Disable a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::DisableCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
EnableCertificateAuthority(std::string const &, Options)
Enable a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CertificateAuthority in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
EnableCertificateAuthority(google::cloud::security::privateca::v1::EnableCertificateAuthorityRequest const &, Options)
Enable a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::EnableCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
FetchCertificateAuthorityCsr(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CertificateAuthority in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::FetchCertificateAuthorityCsrResponse > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
FetchCertificateAuthorityCsr(google::cloud::security::privateca::v1::FetchCertificateAuthorityCsrRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::FetchCertificateAuthorityCsrRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::FetchCertificateAuthorityCsrResponse > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCertificateAuthority(std::string const &, Options)
Returns a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The [name][google.cloud.security.privateca.v1.CertificateAuthority.name] of the CertificateAuthority to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CertificateAuthority) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCertificateAuthority(google::cloud::security::privateca::v1::GetCertificateAuthorityRequest const &, Options)
Returns a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::GetCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CertificateAuthority) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCertificateAuthorities(std::string const &, Options)
Lists CertificateAuthorities.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the [CaPool][google.cloud.security.privateca.v1.CaPool] associated with the CertificateAuthorities, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CertificateAuthority > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCertificateAuthorities(google::cloud::security::privateca::v1::ListCertificateAuthoritiesRequest, Options)
Lists CertificateAuthorities.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::ListCertificateAuthoritiesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CertificateAuthority > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UndeleteCertificateAuthority(std::string const &, Options)
Undelete a CertificateAuthority that has been deleted.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CertificateAuthority in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
UndeleteCertificateAuthority(google::cloud::security::privateca::v1::UndeleteCertificateAuthorityRequest const &, Options)
Undelete a CertificateAuthority that has been deleted.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::UndeleteCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
DeleteCertificateAuthority(std::string const &, Options)
Delete a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CertificateAuthority in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
DeleteCertificateAuthority(google::cloud::security::privateca::v1::DeleteCertificateAuthorityRequest const &, Options)
Delete a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::DeleteCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
UpdateCertificateAuthority(google::cloud::security::privateca::v1::CertificateAuthority const &, google::protobuf::FieldMask const &, Options)
Update a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
certificate_authority |
google::cloud::security::privateca::v1::CertificateAuthority const &
Required. CertificateAuthority with updated values. |
update_mask |
google::protobuf::FieldMask const &
Required. A list of fields to be updated in this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
UpdateCertificateAuthority(google::cloud::security::privateca::v1::UpdateCertificateAuthorityRequest const &, Options)
Update a CertificateAuthority.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::UpdateCertificateAuthorityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateAuthority > > | A |
CreateCaPool(std::string const &, google::cloud::security::privateca::v1::CaPool const &, std::string const &, Options)
Create a CaPool.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the location associated with the CaPool, in the format |
ca_pool |
google::cloud::security::privateca::v1::CaPool const &
Required. A CaPool with initial field values. |
ca_pool_id |
std::string const &
Required. It must be unique within a location and match the regular expression |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CaPool > > | A |
CreateCaPool(google::cloud::security::privateca::v1::CreateCaPoolRequest const &, Options)
Create a CaPool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::CreateCaPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CaPool > > | A |
UpdateCaPool(google::cloud::security::privateca::v1::CaPool const &, google::protobuf::FieldMask const &, Options)
Update a CaPool.
Parameters | |
---|---|
Name | Description |
ca_pool |
google::cloud::security::privateca::v1::CaPool const &
Required. CaPool with updated values. |
update_mask |
google::protobuf::FieldMask const &
Required. A list of fields to be updated in this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CaPool > > | A |
UpdateCaPool(google::cloud::security::privateca::v1::UpdateCaPoolRequest const &, Options)
Update a CaPool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::UpdateCaPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CaPool > > | A |
GetCaPool(std::string const &, Options)
Returns a CaPool.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The [name][google.cloud.security.privateca.v1.CaPool.name] of the CaPool to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CaPool > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CaPool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCaPool(google::cloud::security::privateca::v1::GetCaPoolRequest const &, Options)
Returns a CaPool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::GetCaPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CaPool > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CaPool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCaPools(std::string const &, Options)
Lists CaPools.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the location associated with the CaPools, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CaPool > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCaPools(google::cloud::security::privateca::v1::ListCaPoolsRequest, Options)
Lists CaPools.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::ListCaPoolsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CaPool > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteCaPool(std::string const &, Options)
Delete a CaPool.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CaPool in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::OperationMetadata > > | A |
DeleteCaPool(google::cloud::security::privateca::v1::DeleteCaPoolRequest const &, Options)
Delete a CaPool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::DeleteCaPoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::OperationMetadata > > | A |
FetchCaCerts(std::string const &, Options)
FetchCaCerts returns the current trust anchor for the CaPool.
This will include CA certificate chains for all ACTIVE CertificateAuthority resources in the CaPool.
Parameters | |
---|---|
Name | Description |
ca_pool |
std::string const &
Required. The resource name for the CaPool in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::FetchCaCertsResponse > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.FetchCaCertsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
FetchCaCerts(google::cloud::security::privateca::v1::FetchCaCertsRequest const &, Options)
FetchCaCerts returns the current trust anchor for the CaPool.
This will include CA certificate chains for all ACTIVE CertificateAuthority resources in the CaPool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::FetchCaCertsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::FetchCaCertsResponse > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.FetchCaCertsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCertificateRevocationList(std::string const &, Options)
Returns a CertificateRevocationList.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The [name][google.cloud.security.privateca.v1.CertificateRevocationList.name] of the CertificateRevocationList to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CertificateRevocationList > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CertificateRevocationList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCertificateRevocationList(google::cloud::security::privateca::v1::GetCertificateRevocationListRequest const &, Options)
Returns a CertificateRevocationList.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::GetCertificateRevocationListRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CertificateRevocationList > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CertificateRevocationList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCertificateRevocationLists(std::string const &, Options)
Lists CertificateRevocationLists.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the location associated with the CertificateRevocationLists, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CertificateRevocationList > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCertificateRevocationLists(google::cloud::security::privateca::v1::ListCertificateRevocationListsRequest, Options)
Lists CertificateRevocationLists.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::ListCertificateRevocationListsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CertificateRevocationList > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateCertificateRevocationList(google::cloud::security::privateca::v1::CertificateRevocationList const &, google::protobuf::FieldMask const &, Options)
Update a CertificateRevocationList.
Parameters | |
---|---|
Name | Description |
certificate_revocation_list |
google::cloud::security::privateca::v1::CertificateRevocationList const &
Required. CertificateRevocationList with updated values. |
update_mask |
google::protobuf::FieldMask const &
Required. A list of fields to be updated in this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateRevocationList > > | A |
UpdateCertificateRevocationList(google::cloud::security::privateca::v1::UpdateCertificateRevocationListRequest const &, Options)
Update a CertificateRevocationList.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::UpdateCertificateRevocationListRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateRevocationList > > | A |
CreateCertificateTemplate(std::string const &, google::cloud::security::privateca::v1::CertificateTemplate const &, std::string const &, Options)
Create a new CertificateTemplate in a given Project and Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the location associated with the CertificateTemplate, in the format |
certificate_template |
google::cloud::security::privateca::v1::CertificateTemplate const &
Required. A CertificateTemplate with initial field values. |
certificate_template_id |
std::string const &
Required. It must be unique within a location and match the regular expression |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateTemplate > > | A |
CreateCertificateTemplate(google::cloud::security::privateca::v1::CreateCertificateTemplateRequest const &, Options)
Create a new CertificateTemplate in a given Project and Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::CreateCertificateTemplateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateTemplate > > | A |
DeleteCertificateTemplate(std::string const &, Options)
DeleteCertificateTemplate deletes a CertificateTemplate.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name for this CertificateTemplate in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::OperationMetadata > > | A |
DeleteCertificateTemplate(google::cloud::security::privateca::v1::DeleteCertificateTemplateRequest const &, Options)
DeleteCertificateTemplate deletes a CertificateTemplate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::DeleteCertificateTemplateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::OperationMetadata > > | A |
GetCertificateTemplate(std::string const &, Options)
Returns a CertificateTemplate.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The [name][google.cloud.security.privateca.v1.CertificateTemplate.name] of the CertificateTemplate to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CertificateTemplate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CertificateTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCertificateTemplate(google::cloud::security::privateca::v1::GetCertificateTemplateRequest const &, Options)
Returns a CertificateTemplate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::GetCertificateTemplateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::security::privateca::v1::CertificateTemplate > | the result of the RPC. The response message type (google.cloud.security.privateca.v1.CertificateTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCertificateTemplates(std::string const &, Options)
Lists CertificateTemplates.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the location associated with the CertificateTemplates, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CertificateTemplate > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCertificateTemplates(google::cloud::security::privateca::v1::ListCertificateTemplatesRequest, Options)
Lists CertificateTemplates.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::ListCertificateTemplatesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::security::privateca::v1::CertificateTemplate > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateCertificateTemplate(google::cloud::security::privateca::v1::CertificateTemplate const &, google::protobuf::FieldMask const &, Options)
Update a CertificateTemplate.
Parameters | |
---|---|
Name | Description |
certificate_template |
google::cloud::security::privateca::v1::CertificateTemplate const &
Required. CertificateTemplate with updated values. |
update_mask |
google::protobuf::FieldMask const &
Required. A list of fields to be updated in this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateTemplate > > | A |
UpdateCertificateTemplate(google::cloud::security::privateca::v1::UpdateCertificateTemplateRequest const &, Options)
Update a CertificateTemplate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::security::privateca::v1::UpdateCertificateTemplateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::security::privateca::v1::CertificateTemplate > > | A |