Class protos.google.cloud.security.privateca.v1beta1.CertificateAuthorityService (5.2.0)

Represents a CertificateAuthorityService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.security.privateca.v1beta1.CertificateAuthorityService

Package

@google-cloud/security-private-ca

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new CertificateAuthorityService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

activateCertificateAuthority(request, callback)

public activateCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ActivateCertificateAuthorityCallback): void;

Calls ActivateCertificateAuthority.

Parameters
Name Description
request IActivateCertificateAuthorityRequest

ActivateCertificateAuthorityRequest message or plain object
callback ActivateCertificateAuthorityCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

activateCertificateAuthority(request)

public activateCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest): Promise<google.longrunning.Operation>;

Calls ActivateCertificateAuthority.

Parameter
Name Description
request IActivateCertificateAuthorityRequest

ActivateCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CertificateAuthorityService;

Creates new CertificateAuthorityService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
CertificateAuthorityService

RPC service. Useful where requests and/or responses are streamed.

createCertificate(request, callback)

public createCertificate(request: google.cloud.security.privateca.v1beta1.ICreateCertificateRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificateCallback): void;

Calls CreateCertificate.

Parameters
Name Description
request ICreateCertificateRequest

CreateCertificateRequest message or plain object
callback CreateCertificateCallback

Node-style callback called with the error, if any, and Certificate
Returns
Type Description
void

createCertificate(request)

public createCertificate(request: google.cloud.security.privateca.v1beta1.ICreateCertificateRequest): Promise<google.cloud.security.privateca.v1beta1.Certificate>;

Calls CreateCertificate.

Parameter
Name Description
request ICreateCertificateRequest

CreateCertificateRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.Certificate>

Promise

createCertificateAuthority(request, callback)

public createCertificateAuthority(request: google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificateAuthorityCallback): void;

Calls CreateCertificateAuthority.

Parameters
Name Description
request ICreateCertificateAuthorityRequest

CreateCertificateAuthorityRequest message or plain object
callback CreateCertificateAuthorityCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createCertificateAuthority(request)

public createCertificateAuthority(request: google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest): Promise<google.longrunning.Operation>;

Calls CreateCertificateAuthority.

Parameter
Name Description
request ICreateCertificateAuthorityRequest

CreateCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

disableCertificateAuthority(request, callback)

public disableCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.DisableCertificateAuthorityCallback): void;

Calls DisableCertificateAuthority.

Parameters
Name Description
request IDisableCertificateAuthorityRequest

DisableCertificateAuthorityRequest message or plain object
callback DisableCertificateAuthorityCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

disableCertificateAuthority(request)

public disableCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest): Promise<google.longrunning.Operation>;

Calls DisableCertificateAuthority.

Parameter
Name Description
request IDisableCertificateAuthorityRequest

DisableCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

enableCertificateAuthority(request, callback)

public enableCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.EnableCertificateAuthorityCallback): void;

Calls EnableCertificateAuthority.

Parameters
Name Description
request IEnableCertificateAuthorityRequest

EnableCertificateAuthorityRequest message or plain object
callback EnableCertificateAuthorityCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

enableCertificateAuthority(request)

public enableCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest): Promise<google.longrunning.Operation>;

Calls EnableCertificateAuthority.

Parameter
Name Description
request IEnableCertificateAuthorityRequest

EnableCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

fetchCertificateAuthorityCsr(request, callback)

public fetchCertificateAuthorityCsr(request: google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.FetchCertificateAuthorityCsrCallback): void;

Calls FetchCertificateAuthorityCsr.

Parameters
Name Description
request IFetchCertificateAuthorityCsrRequest

FetchCertificateAuthorityCsrRequest message or plain object
callback FetchCertificateAuthorityCsrCallback

Node-style callback called with the error, if any, and FetchCertificateAuthorityCsrResponse
Returns
Type Description
void

fetchCertificateAuthorityCsr(request)

public fetchCertificateAuthorityCsr(request: google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest): Promise<google.cloud.security.privateca.v1beta1.FetchCertificateAuthorityCsrResponse>;

Calls FetchCertificateAuthorityCsr.

Parameter
Name Description
request IFetchCertificateAuthorityCsrRequest

FetchCertificateAuthorityCsrRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.FetchCertificateAuthorityCsrResponse>

Promise

getCertificate(request, callback)

public getCertificate(request: google.cloud.security.privateca.v1beta1.IGetCertificateRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateCallback): void;

Calls GetCertificate.

Parameters
Name Description
request IGetCertificateRequest

GetCertificateRequest message or plain object
callback GetCertificateCallback

Node-style callback called with the error, if any, and Certificate
Returns
Type Description
void

getCertificate(request)

public getCertificate(request: google.cloud.security.privateca.v1beta1.IGetCertificateRequest): Promise<google.cloud.security.privateca.v1beta1.Certificate>;

Calls GetCertificate.

Parameter
Name Description
request IGetCertificateRequest

GetCertificateRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.Certificate>

Promise

getCertificateAuthority(request, callback)

public getCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateAuthorityCallback): void;

Calls GetCertificateAuthority.

Parameters
Name Description
request IGetCertificateAuthorityRequest

GetCertificateAuthorityRequest message or plain object
callback GetCertificateAuthorityCallback

Node-style callback called with the error, if any, and CertificateAuthority
Returns
Type Description
void

getCertificateAuthority(request)

public getCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest): Promise<google.cloud.security.privateca.v1beta1.CertificateAuthority>;

Calls GetCertificateAuthority.

Parameter
Name Description
request IGetCertificateAuthorityRequest

GetCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.CertificateAuthority>

Promise

getCertificateRevocationList(request, callback)

public getCertificateRevocationList(request: google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateRevocationListCallback): void;

Calls GetCertificateRevocationList.

Parameters
Name Description
request IGetCertificateRevocationListRequest

GetCertificateRevocationListRequest message or plain object
callback GetCertificateRevocationListCallback

Node-style callback called with the error, if any, and CertificateRevocationList
Returns
Type Description
void

getCertificateRevocationList(request)

public getCertificateRevocationList(request: google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest): Promise<google.cloud.security.privateca.v1beta1.CertificateRevocationList>;

Calls GetCertificateRevocationList.

Parameter
Name Description
request IGetCertificateRevocationListRequest

GetCertificateRevocationListRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.CertificateRevocationList>

Promise

getReusableConfig(request, callback)

public getReusableConfig(request: google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetReusableConfigCallback): void;

Calls GetReusableConfig.

Parameters
Name Description
request IGetReusableConfigRequest

GetReusableConfigRequest message or plain object
callback GetReusableConfigCallback

Node-style callback called with the error, if any, and ReusableConfig
Returns
Type Description
void

getReusableConfig(request)

public getReusableConfig(request: google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest): Promise<google.cloud.security.privateca.v1beta1.ReusableConfig>;

Calls GetReusableConfig.

Parameter
Name Description
request IGetReusableConfigRequest

GetReusableConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.ReusableConfig>

Promise

listCertificateAuthorities(request, callback)

public listCertificateAuthorities(request: google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateAuthoritiesCallback): void;

Calls ListCertificateAuthorities.

Parameters
Name Description
request IListCertificateAuthoritiesRequest

ListCertificateAuthoritiesRequest message or plain object
callback ListCertificateAuthoritiesCallback

Node-style callback called with the error, if any, and ListCertificateAuthoritiesResponse
Returns
Type Description
void

listCertificateAuthorities(request)

public listCertificateAuthorities(request: google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest): Promise<google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse>;

Calls ListCertificateAuthorities.

Parameter
Name Description
request IListCertificateAuthoritiesRequest

ListCertificateAuthoritiesRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse>

Promise

listCertificateRevocationLists(request, callback)

public listCertificateRevocationLists(request: google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateRevocationListsCallback): void;

Calls ListCertificateRevocationLists.

Parameters
Name Description
request IListCertificateRevocationListsRequest

ListCertificateRevocationListsRequest message or plain object
callback ListCertificateRevocationListsCallback

Node-style callback called with the error, if any, and ListCertificateRevocationListsResponse
Returns
Type Description
void

listCertificateRevocationLists(request)

public listCertificateRevocationLists(request: google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest): Promise<google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse>;

Calls ListCertificateRevocationLists.

Parameter
Name Description
request IListCertificateRevocationListsRequest

ListCertificateRevocationListsRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse>

Promise

listCertificates(request, callback)

public listCertificates(request: google.cloud.security.privateca.v1beta1.IListCertificatesRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificatesCallback): void;

Calls ListCertificates.

Parameters
Name Description
request IListCertificatesRequest

ListCertificatesRequest message or plain object
callback ListCertificatesCallback

Node-style callback called with the error, if any, and ListCertificatesResponse
Returns
Type Description
void

listCertificates(request)

public listCertificates(request: google.cloud.security.privateca.v1beta1.IListCertificatesRequest): Promise<google.cloud.security.privateca.v1beta1.ListCertificatesResponse>;

Calls ListCertificates.

Parameter
Name Description
request IListCertificatesRequest

ListCertificatesRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.ListCertificatesResponse>

Promise

listReusableConfigs(request, callback)

public listReusableConfigs(request: google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListReusableConfigsCallback): void;

Calls ListReusableConfigs.

Parameters
Name Description
request IListReusableConfigsRequest

ListReusableConfigsRequest message or plain object
callback ListReusableConfigsCallback

Node-style callback called with the error, if any, and ListReusableConfigsResponse
Returns
Type Description
void

listReusableConfigs(request)

public listReusableConfigs(request: google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest): Promise<google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse>;

Calls ListReusableConfigs.

Parameter
Name Description
request IListReusableConfigsRequest

ListReusableConfigsRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse>

Promise

restoreCertificateAuthority(request, callback)

public restoreCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RestoreCertificateAuthorityCallback): void;

Calls RestoreCertificateAuthority.

Parameters
Name Description
request IRestoreCertificateAuthorityRequest

RestoreCertificateAuthorityRequest message or plain object
callback RestoreCertificateAuthorityCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

restoreCertificateAuthority(request)

public restoreCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest): Promise<google.longrunning.Operation>;

Calls RestoreCertificateAuthority.

Parameter
Name Description
request IRestoreCertificateAuthorityRequest

RestoreCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

revokeCertificate(request, callback)

public revokeCertificate(request: google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RevokeCertificateCallback): void;

Calls RevokeCertificate.

Parameters
Name Description
request IRevokeCertificateRequest

RevokeCertificateRequest message or plain object
callback RevokeCertificateCallback

Node-style callback called with the error, if any, and Certificate
Returns
Type Description
void

revokeCertificate(request)

public revokeCertificate(request: google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest): Promise<google.cloud.security.privateca.v1beta1.Certificate>;

Calls RevokeCertificate.

Parameter
Name Description
request IRevokeCertificateRequest

RevokeCertificateRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.Certificate>

Promise

scheduleDeleteCertificateAuthority(request, callback)

public scheduleDeleteCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ScheduleDeleteCertificateAuthorityCallback): void;

Calls ScheduleDeleteCertificateAuthority.

Parameters
Name Description
request IScheduleDeleteCertificateAuthorityRequest

ScheduleDeleteCertificateAuthorityRequest message or plain object
callback ScheduleDeleteCertificateAuthorityCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

scheduleDeleteCertificateAuthority(request)

public scheduleDeleteCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest): Promise<google.longrunning.Operation>;

Calls ScheduleDeleteCertificateAuthority.

Parameter
Name Description
request IScheduleDeleteCertificateAuthorityRequest

ScheduleDeleteCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateCertificate(request, callback)

public updateCertificate(request: google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateCallback): void;

Calls UpdateCertificate.

Parameters
Name Description
request IUpdateCertificateRequest

UpdateCertificateRequest message or plain object
callback UpdateCertificateCallback

Node-style callback called with the error, if any, and Certificate
Returns
Type Description
void

updateCertificate(request)

public updateCertificate(request: google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest): Promise<google.cloud.security.privateca.v1beta1.Certificate>;

Calls UpdateCertificate.

Parameter
Name Description
request IUpdateCertificateRequest

UpdateCertificateRequest message or plain object
Returns
Type Description
Promise<google.cloud.security.privateca.v1beta1.Certificate>

Promise

updateCertificateAuthority(request, callback)

public updateCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateAuthorityCallback): void;

Calls UpdateCertificateAuthority.

Parameters
Name Description
request IUpdateCertificateAuthorityRequest

UpdateCertificateAuthorityRequest message or plain object
callback UpdateCertificateAuthorityCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateCertificateAuthority(request)

public updateCertificateAuthority(request: google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest): Promise<google.longrunning.Operation>;

Calls UpdateCertificateAuthority.

Parameter
Name Description
request IUpdateCertificateAuthorityRequest

UpdateCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateCertificateRevocationList(request, callback)

public updateCertificateRevocationList(request: google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest, callback: google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateRevocationListCallback): void;

Calls UpdateCertificateRevocationList.

Parameters
Name Description
request IUpdateCertificateRevocationListRequest

UpdateCertificateRevocationListRequest message or plain object
callback UpdateCertificateRevocationListCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateCertificateRevocationList(request)

public updateCertificateRevocationList(request: google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest): Promise<google.longrunning.Operation>;

Calls UpdateCertificateRevocationList.

Parameter
Name Description
request IUpdateCertificateRevocationListRequest

UpdateCertificateRevocationListRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise