Certificate Authority v1 API - Class CertificateAuthorityService.CertificateAuthorityServiceBase (3.7.0)

Version latest

• 3.7.0 (latest)
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

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

Reference documentation and code samples for the Certificate Authority v1 API class CertificateAuthorityService.CertificateAuthorityServiceBase.

Base class for server-side implementations of CertificateAuthorityService

Inheritance

object > CertificateAuthorityService.CertificateAuthorityServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
request	ActivateCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	CreateCaPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	CreateCertificateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificate	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
Name	Description
request	CreateCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	CreateCertificateTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	DeleteCaPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	DeleteCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	DeleteCertificateTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	DisableCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	EnableCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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 certificate authorities in the ENABLED, DISABLED, or STAGED states.

Parameters
Name	Description
request	FetchCaCertsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFetchCaCertsResponse	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
Name	Description
request	FetchCertificateAuthorityCsrRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFetchCertificateAuthorityCsrResponse	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
Name	Description
request	GetCaPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCaPool	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
Name	Description
request	GetCertificateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificate	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
Name	Description
request	GetCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificateAuthority	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
Name	Description
request	GetCertificateRevocationListRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificateRevocationList	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
Name	Description
request	GetCertificateTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificateTemplate	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
Name	Description
request	ListCaPoolsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCaPoolsResponse	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
Name	Description
request	ListCertificateAuthoritiesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCertificateAuthoritiesResponse	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
Name	Description
request	ListCertificateRevocationListsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCertificateRevocationListsResponse	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
Name	Description
request	ListCertificateTemplatesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCertificateTemplatesResponse	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
Name	Description
request	ListCertificatesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCertificatesResponse	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
Name	Description
request	RevokeCertificateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificate	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
Name	Description
request	UndeleteCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	UpdateCaPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	UpdateCertificateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificate	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
Name	Description
request	UpdateCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	UpdateCertificateRevocationListRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	UpdateCertificateTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).