Class CertificateAuthorityService.CertificateAuthorityServiceBase (1.0.0)

[BindServiceMethod(typeof(CertificateAuthorityService), "BindService")]
public abstract class CertificateAuthorityServiceBase

Base class for server-side implementations of CertificateAuthorityService

Inheritance

Object > CertificateAuthorityService.CertificateAuthorityServiceBase

Namespace

Google.Cloud.Security.PrivateCA.V1

Assembly

Google.Cloud.Security.PrivateCA.V1.dll

Methods

ActivateCertificateAuthority(ActivateCertificateAuthorityRequest, ServerCallContext)

public virtual Task<Operation> ActivateCertificateAuthority(ActivateCertificateAuthorityRequest request, ServerCallContext context)

Activate a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] that is in state [AWAITING_USER_ACTIVATION][google.cloud.security.privateca.v1.CertificateAuthority.State.AWAITING_USER_ACTIVATION] and is of type [SUBORDINATE][google.cloud.security.privateca.v1.CertificateAuthority.Type.SUBORDINATE]. After the parent Certificate Authority signs a certificate signing request from [FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1.CertificateAuthorityService.FetchCertificateAuthorityCsr], this method can complete the activation process.

Parameters
NameDescription
requestActivateCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

CreateCaPool(CreateCaPoolRequest, ServerCallContext)

public virtual Task<Operation> CreateCaPool(CreateCaPoolRequest request, ServerCallContext context)

Create a [CaPool][google.cloud.security.privateca.v1.CaPool].

Parameters
NameDescription
requestCreateCaPoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

CreateCertificate(CreateCertificateRequest, ServerCallContext)

public virtual Task<Certificate> CreateCertificate(CreateCertificateRequest request, ServerCallContext context)

Create a new [Certificate][google.cloud.security.privateca.v1.Certificate] in a given Project, Location from a particular [CaPool][google.cloud.security.privateca.v1.CaPool].

Parameters
NameDescription
requestCreateCertificateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Certificate>

The response to send back to the client (wrapped by a task).

CreateCertificateAuthority(CreateCertificateAuthorityRequest, ServerCallContext)

public virtual Task<Operation> CreateCertificateAuthority(CreateCertificateAuthorityRequest request, ServerCallContext context)

Create a new [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in a given Project and Location.

Parameters
NameDescription
requestCreateCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

CreateCertificateTemplate(CreateCertificateTemplateRequest, ServerCallContext)

public virtual Task<Operation> CreateCertificateTemplate(CreateCertificateTemplateRequest request, ServerCallContext context)

Create a new [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] in a given Project and Location.

Parameters
NameDescription
requestCreateCertificateTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

DeleteCaPool(DeleteCaPoolRequest, ServerCallContext)

public virtual Task<Operation> DeleteCaPool(DeleteCaPoolRequest request, ServerCallContext context)

Delete a [CaPool][google.cloud.security.privateca.v1.CaPool].

Parameters
NameDescription
requestDeleteCaPoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

DeleteCertificateAuthority(DeleteCertificateAuthorityRequest, ServerCallContext)

public virtual Task<Operation> DeleteCertificateAuthority(DeleteCertificateAuthorityRequest request, ServerCallContext context)

Delete a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].

Parameters
NameDescription
requestDeleteCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

DeleteCertificateTemplate(DeleteCertificateTemplateRequest, ServerCallContext)

public virtual Task<Operation> DeleteCertificateTemplate(DeleteCertificateTemplateRequest request, ServerCallContext context)

DeleteCertificateTemplate deletes a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].

Parameters
NameDescription
requestDeleteCertificateTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

DisableCertificateAuthority(DisableCertificateAuthorityRequest, ServerCallContext)

public virtual Task<Operation> DisableCertificateAuthority(DisableCertificateAuthorityRequest request, ServerCallContext context)

Disable a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].

Parameters
NameDescription
requestDisableCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

EnableCertificateAuthority(EnableCertificateAuthorityRequest, ServerCallContext)

public virtual Task<Operation> EnableCertificateAuthority(EnableCertificateAuthorityRequest request, ServerCallContext context)

Enable a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].

Parameters
NameDescription
requestEnableCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

FetchCaCerts(FetchCaCertsRequest, ServerCallContext)

public virtual Task<FetchCaCertsResponse> FetchCaCerts(FetchCaCertsRequest request, ServerCallContext context)

FetchCaCerts returns the current trust anchor for the [CaPool][google.cloud.security.privateca.v1.CaPool]. This will include CA certificate chains for all ACTIVE [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] resources in the [CaPool][google.cloud.security.privateca.v1.CaPool].

Parameters
NameDescription
requestFetchCaCertsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<FetchCaCertsResponse>

The response to send back to the client (wrapped by a task).

FetchCertificateAuthorityCsr(FetchCertificateAuthorityCsrRequest, ServerCallContext)

public virtual Task<FetchCertificateAuthorityCsrResponse> FetchCertificateAuthorityCsr(FetchCertificateAuthorityCsrRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestFetchCertificateAuthorityCsrRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<FetchCertificateAuthorityCsrResponse>

The response to send back to the client (wrapped by a task).

GetCaPool(GetCaPoolRequest, ServerCallContext)

public virtual Task<CaPool> GetCaPool(GetCaPoolRequest request, ServerCallContext context)

Returns a [CaPool][google.cloud.security.privateca.v1.CaPool].

Parameters
NameDescription
requestGetCaPoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<CaPool>

The response to send back to the client (wrapped by a task).

GetCertificate(GetCertificateRequest, ServerCallContext)

public virtual Task<Certificate> GetCertificate(GetCertificateRequest request, ServerCallContext context)

Returns a [Certificate][google.cloud.security.privateca.v1.Certificate].

Parameters
NameDescription
requestGetCertificateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Certificate>

The response to send back to the client (wrapped by a task).

GetCertificateAuthority(GetCertificateAuthorityRequest, ServerCallContext)

public virtual Task<CertificateAuthority> GetCertificateAuthority(GetCertificateAuthorityRequest request, ServerCallContext context)

Returns a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].

Parameters
NameDescription
requestGetCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<CertificateAuthority>

The response to send back to the client (wrapped by a task).

GetCertificateRevocationList(GetCertificateRevocationListRequest, ServerCallContext)

public virtual Task<CertificateRevocationList> GetCertificateRevocationList(GetCertificateRevocationListRequest request, ServerCallContext context)

Returns a [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList].

Parameters
NameDescription
requestGetCertificateRevocationListRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<CertificateRevocationList>

The response to send back to the client (wrapped by a task).

GetCertificateTemplate(GetCertificateTemplateRequest, ServerCallContext)

public virtual Task<CertificateTemplate> GetCertificateTemplate(GetCertificateTemplateRequest request, ServerCallContext context)

Returns a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].

Parameters
NameDescription
requestGetCertificateTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<CertificateTemplate>

The response to send back to the client (wrapped by a task).

ListCaPools(ListCaPoolsRequest, ServerCallContext)

public virtual Task<ListCaPoolsResponse> ListCaPools(ListCaPoolsRequest request, ServerCallContext context)

Lists [CaPools][google.cloud.security.privateca.v1.CaPool].

Parameters
NameDescription
requestListCaPoolsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListCaPoolsResponse>

The response to send back to the client (wrapped by a task).

ListCertificateAuthorities(ListCertificateAuthoritiesRequest, ServerCallContext)

public virtual Task<ListCertificateAuthoritiesResponse> ListCertificateAuthorities(ListCertificateAuthoritiesRequest request, ServerCallContext context)

Lists [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority].

Parameters
NameDescription
requestListCertificateAuthoritiesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListCertificateAuthoritiesResponse>

The response to send back to the client (wrapped by a task).

ListCertificateRevocationLists(ListCertificateRevocationListsRequest, ServerCallContext)

public virtual Task<ListCertificateRevocationListsResponse> ListCertificateRevocationLists(ListCertificateRevocationListsRequest request, ServerCallContext context)

Lists [CertificateRevocationLists][google.cloud.security.privateca.v1.CertificateRevocationList].

Parameters
NameDescription
requestListCertificateRevocationListsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListCertificateRevocationListsResponse>

The response to send back to the client (wrapped by a task).

ListCertificates(ListCertificatesRequest, ServerCallContext)

public virtual Task<ListCertificatesResponse> ListCertificates(ListCertificatesRequest request, ServerCallContext context)

Lists [Certificates][google.cloud.security.privateca.v1.Certificate].

Parameters
NameDescription
requestListCertificatesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListCertificatesResponse>

The response to send back to the client (wrapped by a task).

ListCertificateTemplates(ListCertificateTemplatesRequest, ServerCallContext)

public virtual Task<ListCertificateTemplatesResponse> ListCertificateTemplates(ListCertificateTemplatesRequest request, ServerCallContext context)

Lists [CertificateTemplates][google.cloud.security.privateca.v1.CertificateTemplate].

Parameters
NameDescription
requestListCertificateTemplatesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListCertificateTemplatesResponse>

The response to send back to the client (wrapped by a task).

RevokeCertificate(RevokeCertificateRequest, ServerCallContext)

public virtual Task<Certificate> RevokeCertificate(RevokeCertificateRequest request, ServerCallContext context)

Revoke a [Certificate][google.cloud.security.privateca.v1.Certificate].

Parameters
NameDescription
requestRevokeCertificateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Certificate>

The response to send back to the client (wrapped by a task).

UndeleteCertificateAuthority(UndeleteCertificateAuthorityRequest, ServerCallContext)

public virtual Task<Operation> UndeleteCertificateAuthority(UndeleteCertificateAuthorityRequest request, ServerCallContext context)

Undelete a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] that has been deleted.

Parameters
NameDescription
requestUndeleteCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

UpdateCaPool(UpdateCaPoolRequest, ServerCallContext)

public virtual Task<Operation> UpdateCaPool(UpdateCaPoolRequest request, ServerCallContext context)

Update a [CaPool][google.cloud.security.privateca.v1.CaPool].

Parameters
NameDescription
requestUpdateCaPoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

UpdateCertificate(UpdateCertificateRequest, ServerCallContext)

public virtual Task<Certificate> UpdateCertificate(UpdateCertificateRequest request, ServerCallContext context)

Update a [Certificate][google.cloud.security.privateca.v1.Certificate]. Currently, the only field you can update is the [labels][google.cloud.security.privateca.v1.Certificate.labels] field.

Parameters
NameDescription
requestUpdateCertificateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Certificate>

The response to send back to the client (wrapped by a task).

UpdateCertificateAuthority(UpdateCertificateAuthorityRequest, ServerCallContext)

public virtual Task<Operation> UpdateCertificateAuthority(UpdateCertificateAuthorityRequest request, ServerCallContext context)

Update a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].

Parameters
NameDescription
requestUpdateCertificateAuthorityRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

UpdateCertificateRevocationList(UpdateCertificateRevocationListRequest, ServerCallContext)

public virtual Task<Operation> UpdateCertificateRevocationList(UpdateCertificateRevocationListRequest request, ServerCallContext context)

Update a [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList].

Parameters
NameDescription
requestUpdateCertificateRevocationListRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

UpdateCertificateTemplate(UpdateCertificateTemplateRequest, ServerCallContext)

public virtual Task<Operation> UpdateCertificateTemplate(UpdateCertificateTemplateRequest request, ServerCallContext context)

Update a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].

Parameters
NameDescription
requestUpdateCertificateTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).