Class v1.CertificateAuthorityServiceClient (2.5.0)

manages private certificate authorities and issued certificates. v1

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

iamClient

iamClient: IamClient;

Property Value

Type	Description
IamClient

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

locationsClient

locationsClient: LocationsClient;

Property Value

Type	Description
LocationsClient

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.v1.IActivateCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IActivateCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

activateCertificateAuthority(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IActivateCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

activateCertificateAuthority(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IActivateCertificateAuthorityRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

caPoolPath(project, location, caPool)

caPoolPath(project: string, location: string, caPool: string): string;

Return a fully-qualified caPool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
caPool	`string`

Returns

Type	Description
string	{string} Resource name string.

certificateAuthorityPath(project, location, caPool, certificateAuthority)

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

Return a fully-qualified certificateAuthority resource name string.

Parameters

Name	Description
project	`string`
location	`string`
caPool	`string`
certificateAuthority	`string`

Returns

Type	Description
string	{string} Resource name string.

certificatePath(project, location, caPool, certificate)

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

Return a fully-qualified certificate resource name string.

Parameters

Name	Description
project	`string`
location	`string`
caPool	`string`
certificate	`string`

Returns

Type	Description
string	{string} Resource name string.

certificateRevocationListPath(project, location, caPool, certificateAuthority, certificateRevocationList)

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

Return a fully-qualified certificateRevocationList resource name string.

Parameters

Name	Description
project	`string`
location	`string`
caPool	`string`
certificateAuthority	`string`
certificateRevocationList	`string`

Returns

Type	Description
string	{string} Resource name string.

certificateTemplatePath(project, location, certificateTemplate)

certificateTemplatePath(project: string, location: string, certificateTemplate: string): string;

Return a fully-qualified certificateTemplate resource name string.

Parameters

Name	Description
project	`string`
location	`string`
certificateTemplate	`string`

Returns

Type	Description
string	{string} Resource name string.

checkActivateCertificateAuthorityProgress(name)

checkActivateCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.

checkCreateCaPoolProgress(name)

checkCreateCaPoolProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1.CaPool, protos.google.cloud.security.privateca.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.security.privateca.v1.CaPool, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.

checkCreateCertificateTemplateProgress(name)

checkCreateCertificateTemplateProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1.CertificateTemplate, protos.google.cloud.security.privateca.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.security.privateca.v1.CertificateTemplate, protos.google.cloud.security.privateca.v1.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.

checkDeleteCaPoolProgress(name)

checkDeleteCaPoolProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.security.privateca.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.security.privateca.v1.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.

checkDeleteCertificateAuthorityProgress(name)

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

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.security.privateca.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.

checkDeleteCertificateTemplateProgress(name)

checkDeleteCertificateTemplateProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.security.privateca.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.

checkUndeleteCertificateAuthorityProgress(name)

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

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.security.privateca.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.

checkUpdateCaPoolProgress(name)

checkUpdateCaPoolProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1.CaPool, protos.google.cloud.security.privateca.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.security.privateca.v1.CaPool, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.v1.CertificateAuthority, protos.google.cloud.security.privateca.v1.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.v1.CertificateRevocationList, protos.google.cloud.security.privateca.v1.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.v1.CertificateRevocationList, protos.google.cloud.security.privateca.v1.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.

checkUpdateCertificateTemplateProgress(name)

checkUpdateCertificateTemplateProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1.CertificateTemplate, protos.google.cloud.security.privateca.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.security.privateca.v1.CertificateTemplate, protos.google.cloud.security.privateca.v1.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.

createCaPool(request, options)

createCaPool(request?: protos.google.cloud.security.privateca.v1.ICreateCaPoolRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCaPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

createCaPool(request, options, callback)

createCaPool(request: protos.google.cloud.security.privateca.v1.ICreateCaPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCaPoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCaPool(request, callback)

createCaPool(request: protos.google.cloud.security.privateca.v1.ICreateCaPoolRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCaPoolRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCertificate(request, options)

createCertificate(request?: protos.google.cloud.security.privateca.v1.ICreateCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.ICreateCertificateRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.ICreateCertificateRequest \| undefined), {} \| undefined]>

createCertificate(request, options, callback)

createCertificate(request: protos.google.cloud.security.privateca.v1.ICreateCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.ICreateCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.ICreateCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCertificate(request, callback)

createCertificate(request: protos.google.cloud.security.privateca.v1.ICreateCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.ICreateCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.ICreateCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCertificateAuthority(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

createCertificateAuthority(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCertificateAuthority(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateAuthorityRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCertificateTemplate(request, options)

createCertificateTemplate(request?: protos.google.cloud.security.privateca.v1.ICreateCertificateTemplateRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateTemplateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

createCertificateTemplate(request, options, callback)

createCertificateTemplate(request: protos.google.cloud.security.privateca.v1.ICreateCertificateTemplateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateTemplateRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCertificateTemplate(request, callback)

createCertificateTemplate(request: protos.google.cloud.security.privateca.v1.ICreateCertificateTemplateRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.ICreateCertificateTemplateRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCaPool(request, options)

deleteCaPool(request?: protos.google.cloud.security.privateca.v1.IDeleteCaPoolRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCaPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

deleteCaPool(request, options, callback)

deleteCaPool(request: protos.google.cloud.security.privateca.v1.IDeleteCaPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCaPoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCaPool(request, callback)

deleteCaPool(request: protos.google.cloud.security.privateca.v1.IDeleteCaPoolRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCaPoolRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCertificateAuthority(request, options)

deleteCertificateAuthority(request?: protos.google.cloud.security.privateca.v1.IDeleteCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

deleteCertificateAuthority(request, options, callback)

deleteCertificateAuthority(request: protos.google.cloud.security.privateca.v1.IDeleteCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCertificateAuthority(request, callback)

deleteCertificateAuthority(request: protos.google.cloud.security.privateca.v1.IDeleteCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCertificateAuthorityRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCertificateTemplate(request, options)

deleteCertificateTemplate(request?: protos.google.cloud.security.privateca.v1.IDeleteCertificateTemplateRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCertificateTemplateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

deleteCertificateTemplate(request, options, callback)

deleteCertificateTemplate(request: protos.google.cloud.security.privateca.v1.IDeleteCertificateTemplateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCertificateTemplateRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCertificateTemplate(request, callback)

deleteCertificateTemplate(request: protos.google.cloud.security.privateca.v1.IDeleteCertificateTemplateRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDeleteCertificateTemplateRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

disableCertificateAuthority(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDisableCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

disableCertificateAuthority(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDisableCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

disableCertificateAuthority(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IDisableCertificateAuthorityRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

enableCertificateAuthority(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IEnableCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

enableCertificateAuthority(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IEnableCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

enableCertificateAuthority(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IEnableCertificateAuthorityRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

fetchCaCerts(request, options)

fetchCaCerts(request?: protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse, (protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse, (protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest \| undefined), {} \| undefined]>

fetchCaCerts(request, options, callback)

fetchCaCerts(request: protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse, protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse, protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

fetchCaCerts(request, callback)

fetchCaCerts(request: protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest, callback: Callback<protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse, protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse, protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

fetchCertificateAuthorityCsr(request, options)

fetchCertificateAuthorityCsr(request?: protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrResponse, (protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrResponse, (protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest \| undefined), {} \| undefined]>

fetchCertificateAuthorityCsr(request, options, callback)

fetchCertificateAuthorityCsr(request: protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

fetchCertificateAuthorityCsr(request, callback)

fetchCertificateAuthorityCsr(request: protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest, callback: Callback<protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1.IFetchCertificateAuthorityCsrRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCaPool(request, options)

getCaPool(request?: protos.google.cloud.security.privateca.v1.IGetCaPoolRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IGetCaPoolRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCaPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IGetCaPoolRequest \| undefined, {} \| undefined]>

getCaPool(request, options, callback)

getCaPool(request: protos.google.cloud.security.privateca.v1.IGetCaPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IGetCaPoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCaPoolRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IGetCaPoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCaPool(request, callback)

getCaPool(request: protos.google.cloud.security.privateca.v1.IGetCaPoolRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IGetCaPoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCaPoolRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IGetCaPoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificate(request, options)

getCertificate(request?: protos.google.cloud.security.privateca.v1.IGetCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.IGetCertificateRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.IGetCertificateRequest \| undefined), {} \| undefined]>

getCertificate(request, options, callback)

getCertificate(request: protos.google.cloud.security.privateca.v1.IGetCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IGetCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificate(request, callback)

getCertificate(request: protos.google.cloud.security.privateca.v1.IGetCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IGetCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificateAuthority(request, options)

getCertificateAuthority(request?: protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificateAuthority, (protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificateAuthority, (protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest \| undefined), {} \| undefined]>

getCertificateAuthority(request, options, callback)

getCertificateAuthority(request: protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificateAuthority(request, callback)

getCertificateAuthority(request: protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IGetCertificateAuthorityRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificateRevocationList(request, options)

getCertificateRevocationList(request?: protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificateRevocationList, (protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificateRevocationList, (protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest \| undefined), {} \| undefined]>

getCertificateRevocationList(request, options, callback)

getCertificateRevocationList(request: protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificateRevocationList(request, callback)

getCertificateRevocationList(request: protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1.IGetCertificateRevocationListRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificateTemplate(request, options)

getCertificateTemplate(request?: protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificateTemplate, (protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificateTemplate, (protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest \| undefined), {} \| undefined]>

getCertificateTemplate(request, options, callback)

getCertificateTemplate(request: protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCertificateTemplate(request, callback)

getCertificateTemplate(request: protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IGetCertificateTemplateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.Policy>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

Name	Description
request	`IamProtos.google.iam.v1.GetIamPolicyRequest` The request object that will be sent.
options	`gax.CallOptions \| Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.
callback	`Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing [Policy].

Returns

Type	Description
Promise<IamProtos.google.iam.v1.Policy>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters

Name	Description
request	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
options	`gax.CallOptions \| Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
callback	`Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
Promise<LocationProtos.google.cloud.location.ILocation>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Location]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

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

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.

listCaPools(request, options)

listCaPools(request?: protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICaPool[], protos.google.cloud.security.privateca.v1.IListCaPoolsRequest | null, protos.google.cloud.security.privateca.v1.IListCaPoolsResponse]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCaPoolsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICaPool[], protos.google.cloud.security.privateca.v1.IListCaPoolsRequest \| null, protos.google.cloud.security.privateca.v1.IListCaPoolsResponse]>

listCaPools(request, options, callback)

listCaPools(request: protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, protos.google.cloud.security.privateca.v1.IListCaPoolsResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICaPool>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCaPoolsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, protos.google.cloud.security.privateca.v1.IListCaPoolsResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICaPool>`

Returns

Type	Description
void

listCaPools(request, callback)

listCaPools(request: protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, protos.google.cloud.security.privateca.v1.IListCaPoolsResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICaPool>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCaPoolsRequest`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, protos.google.cloud.security.privateca.v1.IListCaPoolsResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICaPool>`

Returns

Type	Description
void

listCaPoolsAsync(request, options)

listCaPoolsAsync(request?: protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1.ICaPool>;

Equivalent to listCaPools, 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.v1.IListCaPoolsRequest` 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.v1.ICaPool>

{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 [CaPool]. 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.

listCaPoolsStream(request, options)

listCaPoolsStream(request?: protos.google.cloud.security.privateca.v1.IListCaPoolsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCaPoolsRequest` 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 [CaPool] 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 listCaPoolsAsync() 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.

listCertificateAuthorities(request, options)

listCertificateAuthorities(request?: protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificateAuthority[], protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest | null, protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesResponse]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificateAuthority[], protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest \| null, protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesResponse]>

listCertificateAuthorities(request, options, callback)

listCertificateAuthorities(request: protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificateAuthority>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificateAuthority>`

Returns

Type	Description
void

listCertificateAuthorities(request, callback)

listCertificateAuthorities(request: protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificateAuthority>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificateAuthority>`

Returns

Type	Description
void

listCertificateAuthoritiesAsync(request, options)

listCertificateAuthoritiesAsync(request?: protos.google.cloud.security.privateca.v1.IListCertificateAuthoritiesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1.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.v1.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.v1.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.v1.IListCertificateAuthoritiesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.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.v1.IListCertificateRevocationListsRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificateRevocationList[], protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest | null, protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsResponse]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificateRevocationList[], protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest \| null, protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsResponse]>

listCertificateRevocationLists(request, options, callback)

listCertificateRevocationLists(request: protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificateRevocationList>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificateRevocationList>`

Returns

Type	Description
void

listCertificateRevocationLists(request, callback)

listCertificateRevocationLists(request: protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificateRevocationList>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificateRevocationList>`

Returns

Type	Description
void

listCertificateRevocationListsAsync(request, options)

listCertificateRevocationListsAsync(request?: protos.google.cloud.security.privateca.v1.IListCertificateRevocationListsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1.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.v1.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.v1.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.v1.IListCertificateRevocationListsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.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.v1.IListCertificatesRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificate[], protos.google.cloud.security.privateca.v1.IListCertificatesRequest | null, protos.google.cloud.security.privateca.v1.IListCertificatesResponse]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificatesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificate[], protos.google.cloud.security.privateca.v1.IListCertificatesRequest \| null, protos.google.cloud.security.privateca.v1.IListCertificatesResponse]>

listCertificates(request, options, callback)

listCertificates(request: protos.google.cloud.security.privateca.v1.IListCertificatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificate>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificatesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1.IListCertificatesResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificate>`

Returns

Type	Description
void

listCertificates(request, callback)

listCertificates(request: protos.google.cloud.security.privateca.v1.IListCertificatesRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificate>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificatesRequest`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1.IListCertificatesResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificate>`

Returns

Type	Description
void

listCertificatesAsync(request, options)

listCertificatesAsync(request?: protos.google.cloud.security.privateca.v1.IListCertificatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1.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.v1.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.v1.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.v1.IListCertificatesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.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.

listCertificateTemplates(request, options)

listCertificateTemplates(request?: protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificateTemplate[], protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest | null, protos.google.cloud.security.privateca.v1.IListCertificateTemplatesResponse]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificateTemplate[], protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest \| null, protos.google.cloud.security.privateca.v1.IListCertificateTemplatesResponse]>

listCertificateTemplates(request, options, callback)

listCertificateTemplates(request: protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, protos.google.cloud.security.privateca.v1.IListCertificateTemplatesResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificateTemplate>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, protos.google.cloud.security.privateca.v1.IListCertificateTemplatesResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificateTemplate>`

Returns

Type	Description
void

listCertificateTemplates(request, callback)

listCertificateTemplates(request: protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, protos.google.cloud.security.privateca.v1.IListCertificateTemplatesResponse | null | undefined, protos.google.cloud.security.privateca.v1.ICertificateTemplate>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest`
callback	`PaginationCallback<protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, protos.google.cloud.security.privateca.v1.IListCertificateTemplatesResponse \| null \| undefined, protos.google.cloud.security.privateca.v1.ICertificateTemplate>`

Returns

Type	Description
void

listCertificateTemplatesAsync(request, options)

listCertificateTemplatesAsync(request?: protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1.ICertificateTemplate>;

Equivalent to listCertificateTemplates, 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.v1.IListCertificateTemplatesRequest` 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.v1.ICertificateTemplate>

{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 [CertificateTemplate]. 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.

listCertificateTemplatesStream(request, options)

listCertificateTemplatesStream(request?: protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IListCertificateTemplatesRequest` 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 [CertificateTemplate] 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 listCertificateTemplatesAsync() 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.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters

Name	Description
request	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<LocationProtos.google.cloud.location.ILocation>

{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 [Location]. 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.

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.

matchCaPoolFromCaPoolName(caPoolName)

matchCaPoolFromCaPoolName(caPoolName: string): string | number;

Parse the ca_pool from CaPool resource.

Parameter

Name	Description
caPoolName	`string` A fully-qualified path representing CaPool resource.

Returns

Type	Description
string \| number	{string} A string representing the ca_pool.

matchCaPoolFromCertificateAuthorityName(certificateAuthorityName)

matchCaPoolFromCertificateAuthorityName(certificateAuthorityName: string): string | number;

Parse the ca_pool 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 ca_pool.

matchCaPoolFromCertificateName(certificateName)

matchCaPoolFromCertificateName(certificateName: string): string | number;

Parse the ca_pool 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 ca_pool.

matchCaPoolFromCertificateRevocationListName(certificateRevocationListName)

matchCaPoolFromCertificateRevocationListName(certificateRevocationListName: string): string | number;

Parse the ca_pool 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 ca_pool.

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.

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.

matchCertificateTemplateFromCertificateTemplateName(certificateTemplateName)

matchCertificateTemplateFromCertificateTemplateName(certificateTemplateName: string): string | number;

Parse the certificate_template from CertificateTemplate resource.

Parameter

Name	Description
certificateTemplateName	`string` A fully-qualified path representing CertificateTemplate resource.

Returns

Type	Description
string \| number	{string} A string representing the certificate_template.

matchLocationFromCaPoolName(caPoolName)

matchLocationFromCaPoolName(caPoolName: string): string | number;

Parse the location from CaPool resource.

Parameter

Name	Description
caPoolName	`string` A fully-qualified path representing CaPool resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

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.

matchLocationFromCertificateTemplateName(certificateTemplateName)

matchLocationFromCertificateTemplateName(certificateTemplateName: string): string | number;

Parse the location from CertificateTemplate resource.

Parameter

Name	Description
certificateTemplateName	`string` A fully-qualified path representing CertificateTemplate 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.

matchProjectFromCaPoolName(caPoolName)

matchProjectFromCaPoolName(caPoolName: string): string | number;

Parse the project from CaPool resource.

Parameter

Name	Description
caPoolName	`string` A fully-qualified path representing CaPool resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

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.

matchProjectFromCertificateTemplateName(certificateTemplateName)

matchProjectFromCertificateTemplateName(certificateTemplateName: string): string | number;

Parse the project from CertificateTemplate resource.

Parameter

Name	Description
certificateTemplateName	`string` A fully-qualified path representing CertificateTemplate 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.

revokeCertificate(request, options)

revokeCertificate(request?: protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest \| undefined), {} \| undefined]>

revokeCertificate(request, options, callback)

revokeCertificate(request: protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

revokeCertificate(request, callback)

revokeCertificate(request: protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IRevokeCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.Policy>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

Name	Description
request	`IamProtos.google.iam.v1.SetIamPolicyRequest` The request object that will be sent.
options	`gax.CallOptions \| Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.
callback	`Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing [TestIamPermissionsResponse].

Returns

Type	Description
Promise<IamProtos.google.iam.v1.Policy>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

Name	Description
request	`IamProtos.google.iam.v1.TestIamPermissionsRequest` The request object that will be sent.
options	`gax.CallOptions \| Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.
callback	`Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing [TestIamPermissionsResponse].

Returns

Type	Description
Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. The promise has a method named "cancel" which cancels the ongoing API call.

undeleteCertificateAuthority(request, options)

undeleteCertificateAuthority(request?: protos.google.cloud.security.privateca.v1.IUndeleteCertificateAuthorityRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUndeleteCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

undeleteCertificateAuthority(request, options, callback)

undeleteCertificateAuthority(request: protos.google.cloud.security.privateca.v1.IUndeleteCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUndeleteCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

undeleteCertificateAuthority(request, callback)

undeleteCertificateAuthority(request: protos.google.cloud.security.privateca.v1.IUndeleteCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUndeleteCertificateAuthorityRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCaPool(request, options)

updateCaPool(request?: protos.google.cloud.security.privateca.v1.IUpdateCaPoolRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCaPoolRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

updateCaPool(request, options, callback)

updateCaPool(request: protos.google.cloud.security.privateca.v1.IUpdateCaPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCaPoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCaPool(request, callback)

updateCaPool(request: protos.google.cloud.security.privateca.v1.IUpdateCaPoolRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCaPoolRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICaPool, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificate(request, options)

updateCertificate(request?: protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest, options?: CallOptions): Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.security.privateca.v1.ICertificate, (protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest \| undefined), {} \| undefined]>

updateCertificate(request, options, callback)

updateCertificate(request: protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificate(request, callback)

updateCertificate(request: protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest`
callback	`Callback<protos.google.cloud.security.privateca.v1.ICertificate, protos.google.cloud.security.privateca.v1.IUpdateCertificateRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificateAuthority(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateAuthorityRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

updateCertificateAuthority(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateAuthorityRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificateAuthority(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateAuthorityRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateAuthority, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificateRevocationList(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateRevocationListRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

updateCertificateRevocationList(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateRevocationListRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificateRevocationList(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateRevocationListRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificateTemplate(request, options)

updateCertificateTemplate(request?: protos.google.cloud.security.privateca.v1.IUpdateCertificateTemplateRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateTemplateRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

updateCertificateTemplate(request, options, callback)

updateCertificateTemplate(request: protos.google.cloud.security.privateca.v1.IUpdateCertificateTemplateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateTemplateRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateCertificateTemplate(request, callback)

updateCertificateTemplate(request: protos.google.cloud.security.privateca.v1.IUpdateCertificateTemplateRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.security.privateca.v1.IUpdateCertificateTemplateRequest`
callback	`Callback<LROperation<protos.google.cloud.security.privateca.v1.ICertificateTemplate, protos.google.cloud.security.privateca.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

Class v1.CertificateAuthorityServiceClient (2.5.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts)

Properties

apiEndpoint

auth

certificateAuthorityServiceStub

descriptors

iamClient

innerApiCalls

locationsClient

operationsClient

pathTemplates

port

scopes

servicePath

warn

Methods

activateCertificateAuthority(request, options)

activateCertificateAuthority(request, options, callback)

activateCertificateAuthority(request, callback)

caPoolPath(project, location, caPool)

certificateAuthorityPath(project, location, caPool, certificateAuthority)

certificatePath(project, location, caPool, certificate)

certificateRevocationListPath(project, location, caPool, certificateAuthority, certificateRevocationList)

certificateTemplatePath(project, location, certificateTemplate)

checkActivateCertificateAuthorityProgress(name)

checkCreateCaPoolProgress(name)

checkCreateCertificateAuthorityProgress(name)

checkCreateCertificateTemplateProgress(name)

checkDeleteCaPoolProgress(name)

checkDeleteCertificateAuthorityProgress(name)

checkDeleteCertificateTemplateProgress(name)

checkDisableCertificateAuthorityProgress(name)

checkEnableCertificateAuthorityProgress(name)

checkUndeleteCertificateAuthorityProgress(name)

checkUpdateCaPoolProgress(name)

checkUpdateCertificateAuthorityProgress(name)

checkUpdateCertificateRevocationListProgress(name)

checkUpdateCertificateTemplateProgress(name)

close()

createCaPool(request, options)

createCaPool(request, options, callback)

createCaPool(request, callback)

createCertificate(request, options)

createCertificate(request, options, callback)

createCertificate(request, callback)

createCertificateAuthority(request, options)

createCertificateAuthority(request, options, callback)

createCertificateAuthority(request, callback)

createCertificateTemplate(request, options)

createCertificateTemplate(request, options, callback)

createCertificateTemplate(request, callback)

deleteCaPool(request, options)

deleteCaPool(request, options, callback)

deleteCaPool(request, callback)

deleteCertificateAuthority(request, options)

deleteCertificateAuthority(request, options, callback)

deleteCertificateAuthority(request, callback)

deleteCertificateTemplate(request, options)

deleteCertificateTemplate(request, options, callback)

deleteCertificateTemplate(request, callback)

disableCertificateAuthority(request, options)

disableCertificateAuthority(request, options, callback)

disableCertificateAuthority(request, callback)

enableCertificateAuthority(request, options)

enableCertificateAuthority(request, options, callback)

enableCertificateAuthority(request, callback)

fetchCaCerts(request, options)

fetchCaCerts(request, options, callback)

fetchCaCerts(request, callback)

fetchCertificateAuthorityCsr(request, options)

fetchCertificateAuthorityCsr(request, options, callback)

fetchCertificateAuthorityCsr(request, callback)

getCaPool(request, options)

getCaPool(request, options, callback)

getCaPool(request, callback)

getCertificate(request, options)

getCertificate(request, options, callback)

Class v1.CertificateAuthorityServiceClient (2.5.0)