CertificateAuthorityService

google.cloud.security.privateca.v1beta1. CertificateAuthorityService

Represents a CertificateAuthorityService

Constructor

new CertificateAuthorityService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new CertificateAuthorityService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

activateCertificateAuthority(request, callback) → {undefined}

Calls ActivateCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest

ActivateCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ActivateCertificateAuthorityCallback

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

activateCertificateAuthority(request) → {Promise.<google.longrunning.Operation>}

Calls ActivateCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest

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

Promise

createCertificate(request, callback) → {undefined}

Calls CreateCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.ICreateCertificateRequest

CreateCertificateRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificateCallback

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

createCertificate(request) → {Promise.<google.cloud.security.privateca.v1beta1.Certificate>}

Calls CreateCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.ICreateCertificateRequest

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

Promise

createCertificateAuthority(request, callback) → {undefined}

Calls CreateCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest

CreateCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificateAuthorityCallback

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

createCertificateAuthority(request) → {Promise.<google.longrunning.Operation>}

Calls CreateCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest

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

Promise

disableCertificateAuthority(request, callback) → {undefined}

Calls DisableCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest

DisableCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.DisableCertificateAuthorityCallback

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

disableCertificateAuthority(request) → {Promise.<google.longrunning.Operation>}

Calls DisableCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest

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

Promise

enableCertificateAuthority(request, callback) → {undefined}

Calls EnableCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest

EnableCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.EnableCertificateAuthorityCallback

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

enableCertificateAuthority(request) → {Promise.<google.longrunning.Operation>}

Calls EnableCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest

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

Promise

fetchCertificateAuthorityCsr(request, callback) → {undefined}

Calls FetchCertificateAuthorityCsr.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest

FetchCertificateAuthorityCsrRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.FetchCertificateAuthorityCsrCallback

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

fetchCertificateAuthorityCsr(request) → {Promise.<google.cloud.security.privateca.v1beta1.FetchCertificateAuthorityCsrResponse>}

Calls FetchCertificateAuthorityCsr.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest

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

Promise

getCertificate(request, callback) → {undefined}

Calls GetCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetCertificateRequest

GetCertificateRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateCallback

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

getCertificate(request) → {Promise.<google.cloud.security.privateca.v1beta1.Certificate>}

Calls GetCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetCertificateRequest

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

Promise

getCertificateAuthority(request, callback) → {undefined}

Calls GetCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest

GetCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateAuthorityCallback

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

getCertificateAuthority(request) → {Promise.<google.cloud.security.privateca.v1beta1.CertificateAuthority>}

Calls GetCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest

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

Promise

getCertificateRevocationList(request, callback) → {undefined}

Calls GetCertificateRevocationList.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest

GetCertificateRevocationListRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateRevocationListCallback

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

getCertificateRevocationList(request) → {Promise.<google.cloud.security.privateca.v1beta1.CertificateRevocationList>}

Calls GetCertificateRevocationList.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest

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

Promise

getReusableConfig(request, callback) → {undefined}

Calls GetReusableConfig.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest

GetReusableConfigRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetReusableConfigCallback

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

getReusableConfig(request) → {Promise.<google.cloud.security.privateca.v1beta1.ReusableConfig>}

Calls GetReusableConfig.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest

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

Promise

listCertificateAuthorities(request, callback) → {undefined}

Calls ListCertificateAuthorities.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest

ListCertificateAuthoritiesRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateAuthoritiesCallback

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

listCertificateAuthorities(request) → {Promise.<google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse>}

Calls ListCertificateAuthorities.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest

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

Promise

listCertificateRevocationLists(request, callback) → {undefined}

Calls ListCertificateRevocationLists.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest

ListCertificateRevocationListsRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateRevocationListsCallback

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

listCertificateRevocationLists(request) → {Promise.<google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse>}

Calls ListCertificateRevocationLists.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest

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

Promise

listCertificates(request, callback) → {undefined}

Calls ListCertificates.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListCertificatesRequest

ListCertificatesRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificatesCallback

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

listCertificates(request) → {Promise.<google.cloud.security.privateca.v1beta1.ListCertificatesResponse>}

Calls ListCertificates.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListCertificatesRequest

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

Promise

listReusableConfigs(request, callback) → {undefined}

Calls ListReusableConfigs.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest

ListReusableConfigsRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListReusableConfigsCallback

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

listReusableConfigs(request) → {Promise.<google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse>}

Calls ListReusableConfigs.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest

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

Promise

restoreCertificateAuthority(request, callback) → {undefined}

Calls RestoreCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest

RestoreCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RestoreCertificateAuthorityCallback

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

restoreCertificateAuthority(request) → {Promise.<google.longrunning.Operation>}

Calls RestoreCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest

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

Promise

revokeCertificate(request, callback) → {undefined}

Calls RevokeCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest

RevokeCertificateRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RevokeCertificateCallback

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

revokeCertificate(request) → {Promise.<google.cloud.security.privateca.v1beta1.Certificate>}

Calls RevokeCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest

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

Promise

scheduleDeleteCertificateAuthority(request, callback) → {undefined}

Calls ScheduleDeleteCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest

ScheduleDeleteCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ScheduleDeleteCertificateAuthorityCallback

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

scheduleDeleteCertificateAuthority(request) → {Promise.<google.longrunning.Operation>}

Calls ScheduleDeleteCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest

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

Promise

updateCertificate(request, callback) → {undefined}

Calls UpdateCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest

UpdateCertificateRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateCallback

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

updateCertificate(request) → {Promise.<google.cloud.security.privateca.v1beta1.Certificate>}

Calls UpdateCertificate.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest

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

Promise

updateCertificateAuthority(request, callback) → {undefined}

Calls UpdateCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest

UpdateCertificateAuthorityRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateAuthorityCallback

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

updateCertificateAuthority(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateCertificateAuthority.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest

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

Promise

updateCertificateRevocationList(request, callback) → {undefined}

Calls UpdateCertificateRevocationList.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest

UpdateCertificateRevocationListRequest message or plain object
callback google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateRevocationListCallback

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

updateCertificateRevocationList(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateCertificateRevocationList.

Parameters:
Name Type Description
request google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest

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

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {CertificateAuthorityService}

Creates new CertificateAuthorityService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
CertificateAuthorityService

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

Type Definitions

ActivateCertificateAuthorityCallback(error, responseopt)

Callback as used by activateCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

CreateCertificateAuthorityCallback(error, responseopt)

Callback as used by createCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

CreateCertificateCallback(error, responseopt)

Callback as used by createCertificate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.Certificate <optional>

Certificate

DisableCertificateAuthorityCallback(error, responseopt)

Callback as used by disableCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

EnableCertificateAuthorityCallback(error, responseopt)

Callback as used by enableCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

FetchCertificateAuthorityCsrCallback(error, responseopt)

Callback as used by fetchCertificateAuthorityCsr.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.FetchCertificateAuthorityCsrResponse <optional>

FetchCertificateAuthorityCsrResponse

GetCertificateAuthorityCallback(error, responseopt)

Callback as used by getCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.CertificateAuthority <optional>

CertificateAuthority

GetCertificateCallback(error, responseopt)

Callback as used by getCertificate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.Certificate <optional>

Certificate

GetCertificateRevocationListCallback(error, responseopt)

Callback as used by getCertificateRevocationList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.CertificateRevocationList <optional>

CertificateRevocationList

GetReusableConfigCallback(error, responseopt)

Callback as used by getReusableConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.ReusableConfig <optional>

ReusableConfig

ListCertificateAuthoritiesCallback(error, responseopt)

Callback as used by listCertificateAuthorities.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse <optional>

ListCertificateAuthoritiesResponse

ListCertificateRevocationListsCallback(error, responseopt)

Callback as used by listCertificateRevocationLists.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse <optional>

ListCertificateRevocationListsResponse

ListCertificatesCallback(error, responseopt)

Callback as used by listCertificates.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.ListCertificatesResponse <optional>

ListCertificatesResponse

ListReusableConfigsCallback(error, responseopt)

Callback as used by listReusableConfigs.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse <optional>

ListReusableConfigsResponse

RestoreCertificateAuthorityCallback(error, responseopt)

Callback as used by restoreCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

RevokeCertificateCallback(error, responseopt)

Callback as used by revokeCertificate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.Certificate <optional>

Certificate

ScheduleDeleteCertificateAuthorityCallback(error, responseopt)

Callback as used by scheduleDeleteCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

UpdateCertificateAuthorityCallback(error, responseopt)

Callback as used by updateCertificateAuthority.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

UpdateCertificateCallback(error, responseopt)

Callback as used by updateCertificate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.security.privateca.v1beta1.Certificate <optional>

Certificate

UpdateCertificateRevocationListCallback(error, responseopt)

Callback as used by updateCertificateRevocationList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation