Class v1beta1.CertificateAuthorityServiceClient (2.3.7)

manages private certificate authorities and issued certificates. v1beta1

Package

@google-cloud/security-private-ca!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CertificateAuthorityServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

certificateAuthorityServiceStub

certificateAuthorityServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

activateCertificateAuthority(request, options)

activateCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

activateCertificateAuthority(request, options, callback)

activateCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

activateCertificateAuthority(request, callback)

activateCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

certificateAuthorityPath(project, location, certificateAuthority)

certificateAuthorityPath(project: string, location: string, certificateAuthority: string): string;

Return a fully-qualified certificateAuthority resource name string.

Parameters
Name Description
project string
location string
certificateAuthority string
Returns
Type Description
string

{string} Resource name string.

certificatePath(project, location, certificateAuthority, certificate)

certificatePath(project: string, location: string, certificateAuthority: string, certificate: string): string;

Return a fully-qualified certificate resource name string.

Parameters
Name Description
project string
location string
certificateAuthority string
certificate string
Returns
Type Description
string

{string} Resource name string.

certificateRevocationListPath(project, location, certificateAuthority, certificateRevocationList)

certificateRevocationListPath(project: string, location: string, certificateAuthority: string, certificateRevocationList: string): string;

Return a fully-qualified certificateRevocationList resource name string.

Parameters
Name Description
project string
location string
certificateAuthority string
certificateRevocationList string
Returns
Type Description
string

{string} Resource name string.

checkActivateCertificateAuthorityProgress(name)

checkActivateCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by activateCertificateAuthority().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateCertificateAuthorityProgress(name)

checkCreateCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by createCertificateAuthority().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDisableCertificateAuthorityProgress(name)

checkDisableCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by disableCertificateAuthority().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkEnableCertificateAuthorityProgress(name)

checkEnableCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by enableCertificateAuthority().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkRestoreCertificateAuthorityProgress(name)

checkRestoreCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by restoreCertificateAuthority().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkScheduleDeleteCertificateAuthorityProgress(name)

checkScheduleDeleteCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by scheduleDeleteCertificateAuthority().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateCertificateAuthorityProgress(name)

checkUpdateCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by updateCertificateAuthority().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateCertificateRevocationListProgress(name)

checkUpdateCertificateRevocationListProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;

Check the status of the long running operation returned by updateCertificateRevocationList().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createCertificate(request, options)

createCertificate(request?: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | undefined), {} | undefined]>

createCertificate(request, options, callback)

createCertificate(request: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createCertificate(request, callback)

createCertificate(request: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createCertificateAuthority(request, options)

createCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

createCertificateAuthority(request, options, callback)

createCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createCertificateAuthority(request, callback)

createCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

disableCertificateAuthority(request, options)

disableCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

disableCertificateAuthority(request, options, callback)

disableCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

disableCertificateAuthority(request, callback)

disableCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

enableCertificateAuthority(request, options)

enableCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

enableCertificateAuthority(request, options, callback)

enableCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

enableCertificateAuthority(request, callback)

enableCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

fetchCertificateAuthorityCsr(request, options)

fetchCertificateAuthorityCsr(request?: protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, (protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, (protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | undefined), {} | undefined]>

fetchCertificateAuthorityCsr(request, options, callback)

fetchCertificateAuthorityCsr(request: protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

fetchCertificateAuthorityCsr(request, callback)

fetchCertificateAuthorityCsr(request: protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCertificate(request, options)

getCertificate(request?: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | undefined), {} | undefined]>

getCertificate(request, options, callback)

getCertificate(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCertificate(request, callback)

getCertificate(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCertificateAuthority(request, options)

getCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, (protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, (protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | undefined), {} | undefined]>

getCertificateAuthority(request, options, callback)

getCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCertificateAuthority(request, callback)

getCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCertificateRevocationList(request, options)

getCertificateRevocationList(request?: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, (protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, (protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | undefined), {} | undefined]>

getCertificateRevocationList(request, options, callback)

getCertificateRevocationList(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCertificateRevocationList(request, callback)

getCertificateRevocationList(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getReusableConfig(request, options)

getReusableConfig(request?: protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.IReusableConfig, (protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.IReusableConfig, (protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | undefined), {} | undefined]>

getReusableConfig(request, options, callback)

getReusableConfig(request: protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getReusableConfig(request, callback)

getReusableConfig(request: protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listCertificateAuthorities(request, options)

listCertificateAuthorities(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority[], protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest | null, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority[], protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest | null, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse]>

listCertificateAuthorities(request, options, callback)

listCertificateAuthorities(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>
Returns
Type Description
void

listCertificateAuthorities(request, callback)

listCertificateAuthorities(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>
Returns
Type Description
void

listCertificateAuthoritiesAsync(request, options)

listCertificateAuthoritiesAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>;

Equivalent to listCertificateAuthorities, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [CertificateAuthority]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateAuthoritiesStream(request, options)

listCertificateAuthoritiesStream(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [CertificateAuthority] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateAuthoritiesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateRevocationLists(request, options)

listCertificateRevocationLists(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList[], protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest | null, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList[], protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest | null, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse]>

listCertificateRevocationLists(request, options, callback)

listCertificateRevocationLists(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>
Returns
Type Description
void

listCertificateRevocationLists(request, callback)

listCertificateRevocationLists(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>
Returns
Type Description
void

listCertificateRevocationListsAsync(request, options)

listCertificateRevocationListsAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>;

Equivalent to listCertificateRevocationLists, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [CertificateRevocationList]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateRevocationListsStream(request, options)

listCertificateRevocationListsStream(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [CertificateRevocationList] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateRevocationListsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificates(request, options)

listCertificates(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate[], protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest | null, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate[], protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest | null, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse]>

listCertificates(request, options, callback)

listCertificates(request: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>
Returns
Type Description
void

listCertificates(request, callback)

listCertificates(request: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>
Returns
Type Description
void

listCertificatesAsync(request, options)

listCertificatesAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificate>;

Equivalent to listCertificates, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificate>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Certificate]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificatesStream(request, options)

listCertificatesStream(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Certificate] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificatesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listReusableConfigs(request, options)

listReusableConfigs(request?: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.IReusableConfig[], protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest | null, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.IReusableConfig[], protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest | null, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse]>

listReusableConfigs(request, options, callback)

listReusableConfigs(request: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>
Returns
Type Description
void

listReusableConfigs(request, callback)

listReusableConfigs(request: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest
callback PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>
Returns
Type Description
void

listReusableConfigsAsync(request, options)

listReusableConfigsAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.IReusableConfig>;

Equivalent to listReusableConfigs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.IReusableConfig>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ReusableConfig]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listReusableConfigsStream(request, options)

listReusableConfigsStream(request?: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [ReusableConfig] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listReusableConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchCertificateAuthorityFromCertificateAuthorityName(certificateAuthorityName)

matchCertificateAuthorityFromCertificateAuthorityName(certificateAuthorityName: string): string | number;

Parse the certificate_authority from CertificateAuthority resource.

Parameter
Name Description
certificateAuthorityName string

A fully-qualified path representing CertificateAuthority resource.
Returns
Type Description
string | number

{string} A string representing the certificate_authority.

matchCertificateAuthorityFromCertificateName(certificateName)

matchCertificateAuthorityFromCertificateName(certificateName: string): string | number;

Parse the certificate_authority from Certificate resource.

Parameter
Name Description
certificateName string

A fully-qualified path representing Certificate resource.
Returns
Type Description
string | number

{string} A string representing the certificate_authority.

matchCertificateAuthorityFromCertificateRevocationListName(certificateRevocationListName)

matchCertificateAuthorityFromCertificateRevocationListName(certificateRevocationListName: string): string | number;

Parse the certificate_authority from CertificateRevocationList resource.

Parameter
Name Description
certificateRevocationListName string

A fully-qualified path representing CertificateRevocationList resource.
Returns
Type Description
string | number

{string} A string representing the certificate_authority.

matchCertificateFromCertificateName(certificateName)

matchCertificateFromCertificateName(certificateName: string): string | number;

Parse the certificate from Certificate resource.

Parameter
Name Description
certificateName string

A fully-qualified path representing Certificate resource.
Returns
Type Description
string | number

{string} A string representing the certificate.

matchCertificateRevocationListFromCertificateRevocationListName(certificateRevocationListName)

matchCertificateRevocationListFromCertificateRevocationListName(certificateRevocationListName: string): string | number;

Parse the certificate_revocation_list from CertificateRevocationList resource.

Parameter
Name Description
certificateRevocationListName string

A fully-qualified path representing CertificateRevocationList resource.
Returns
Type Description
string | number

{string} A string representing the certificate_revocation_list.

matchLocationFromCertificateAuthorityName(certificateAuthorityName)

matchLocationFromCertificateAuthorityName(certificateAuthorityName: string): string | number;

Parse the location from CertificateAuthority resource.

Parameter
Name Description
certificateAuthorityName string

A fully-qualified path representing CertificateAuthority resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCertificateName(certificateName)

matchLocationFromCertificateName(certificateName: string): string | number;

Parse the location from Certificate resource.

Parameter
Name Description
certificateName string

A fully-qualified path representing Certificate resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCertificateRevocationListName(certificateRevocationListName)

matchLocationFromCertificateRevocationListName(certificateRevocationListName: string): string | number;

Parse the location from CertificateRevocationList resource.

Parameter
Name Description
certificateRevocationListName string

A fully-qualified path representing CertificateRevocationList resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromReusableConfigName(reusableConfigName)

matchLocationFromReusableConfigName(reusableConfigName: string): string | number;

Parse the location from ReusableConfig resource.

Parameter
Name Description
reusableConfigName string

A fully-qualified path representing ReusableConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromCertificateAuthorityName(certificateAuthorityName)

matchProjectFromCertificateAuthorityName(certificateAuthorityName: string): string | number;

Parse the project from CertificateAuthority resource.

Parameter
Name Description
certificateAuthorityName string

A fully-qualified path representing CertificateAuthority resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCertificateName(certificateName)

matchProjectFromCertificateName(certificateName: string): string | number;

Parse the project from Certificate resource.

Parameter
Name Description
certificateName string

A fully-qualified path representing Certificate resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCertificateRevocationListName(certificateRevocationListName)

matchProjectFromCertificateRevocationListName(certificateRevocationListName: string): string | number;

Parse the project from CertificateRevocationList resource.

Parameter
Name Description
certificateRevocationListName string

A fully-qualified path representing CertificateRevocationList resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromReusableConfigName(reusableConfigName)

matchProjectFromReusableConfigName(reusableConfigName: string): string | number;

Parse the project from ReusableConfig resource.

Parameter
Name Description
reusableConfigName string

A fully-qualified path representing ReusableConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchReusableConfigFromReusableConfigName(reusableConfigName)

matchReusableConfigFromReusableConfigName(reusableConfigName: string): string | number;

Parse the reusable_config from ReusableConfig resource.

Parameter
Name Description
reusableConfigName string

A fully-qualified path representing ReusableConfig resource.
Returns
Type Description
string | number

{string} A string representing the reusable_config.

restoreCertificateAuthority(request, options)

restoreCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

restoreCertificateAuthority(request, options, callback)

restoreCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

restoreCertificateAuthority(request, callback)

restoreCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IRestoreCertificateAuthorityRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

reusableConfigPath(project, location, reusableConfig)

reusableConfigPath(project: string, location: string, reusableConfig: string): string;

Return a fully-qualified reusableConfig resource name string.

Parameters
Name Description
project string
location string
reusableConfig string
Returns
Type Description
string

{string} Resource name string.

revokeCertificate(request, options)

revokeCertificate(request?: protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest | undefined), {} | undefined]>

revokeCertificate(request, options, callback)

revokeCertificate(request: protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

revokeCertificate(request, callback)

revokeCertificate(request: protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IRevokeCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

scheduleDeleteCertificateAuthority(request, options)

scheduleDeleteCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

scheduleDeleteCertificateAuthority(request, options, callback)

scheduleDeleteCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

scheduleDeleteCertificateAuthority(request, callback)

scheduleDeleteCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IScheduleDeleteCertificateAuthorityRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCertificate(request, options)

updateCertificate(request?: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.security.privateca.v1beta1.ICertificate, (protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest | undefined), {} | undefined]>

updateCertificate(request, options, callback)

updateCertificate(request: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest
options CallOptions
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCertificate(request, callback)

updateCertificate(request: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest
callback Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCertificateAuthority(request, options)

updateCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

updateCertificateAuthority(request, options, callback)

updateCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCertificateAuthority(request, callback)

updateCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateAuthorityRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCertificateRevocationList(request, options)

updateCertificateRevocationList(request?: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

updateCertificateRevocationList(request, options, callback)

updateCertificateRevocationList(request: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCertificateRevocationList(request, callback)

updateCertificateRevocationList(request: protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.security.privateca.v1beta1.IUpdateCertificateRevocationListRequest
callback Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void