[Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private certificate authorities and issued certificates. v1
Package
@google-cloud/security-private-caConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of CertificateAuthorityServiceClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
certificateAuthorityServiceStub
certificateAuthorityServiceStub?: Promise<{
[name: string]: Function;
}>;
descriptors
descriptors: Descriptors;
iamClient
iamClient: IamClient;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (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
]>;
Activate a that is in state and is of type . After the parent Certificate Authority signs a certificate signing request from , this method can complete the activation process.
Parameters | |
---|---|
Name | Description |
request |
IActivateCertificateAuthorityRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Required. The signed CA certificate issued from
* FetchCertificateAuthorityCsrResponse.pem_csr google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse.pem_csr.
*/
// const pemCaCertificate = 'abc123'
/**
* Required. Must include information about the issuer of
* 'pem_ca_certificate', and any further issuers until the self-signed CA.
*/
// const subordinateConfig = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callActivateCertificateAuthority() {
// Construct request
const request = {
name,
pemCaCertificate,
subordinateConfig,
};
// Run request
const [operation] = await privatecaClient.activateCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callActivateCertificateAuthority();
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 |
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 |
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 |
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Required. The signed CA certificate issued from
* FetchCertificateAuthorityCsrResponse.pem_csr google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse.pem_csr.
*/
// const pemCaCertificate = 'abc123'
/**
* Required. Must include information about the issuer of
* 'pem_ca_certificate', and any further issuers until the self-signed CA.
*/
// const subordinateConfig = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callActivateCertificateAuthority() {
// Construct request
const request = {
name,
pemCaCertificate,
subordinateConfig,
};
// Run request
const [operation] = await privatecaClient.activateCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callActivateCertificateAuthority();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location associated with the
* CaPool google.cloud.security.privateca.v1.CaPool, in the format
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. It must be unique within a location and match the regular
* expression `[a-zA-Z0-9_-]{1,63}`
*/
// const caPoolId = 'abc123'
/**
* Required. A CaPool google.cloud.security.privateca.v1.CaPool with
* initial field values.
*/
// const caPool = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callCreateCaPool() {
// Construct request
const request = {
parent,
caPoolId,
caPool,
};
// Run request
const [operation] = await privatecaClient.createCaPool(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCaPool();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the
* CaPool google.cloud.security.privateca.v1.CaPool associated with the
* CertificateAuthorities google.cloud.security.privateca.v1.CertificateAuthority,
* in the format `projects/* /locations/* /caPools/*`.
*/
// const parent = 'abc123'
/**
* Required. It must be unique within a location and match the regular
* expression `[a-zA-Z0-9_-]{1,63}`
*/
// const certificateAuthorityId = 'abc123'
/**
* Required. A
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* with initial field values.
*/
// const certificateAuthority = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callCreateCertificateAuthority() {
// Construct request
const request = {
parent,
certificateAuthorityId,
certificateAuthority,
};
// Run request
const [operation] = await privatecaClient.createCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCertificateAuthority();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location associated with the
* CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate,
* in the format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. It must be unique within a location and match the regular
* expression `[a-zA-Z0-9_-]{1,63}`
*/
// const certificateTemplateId = 'abc123'
/**
* Required. A
* CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate
* with initial field values.
*/
// const certificateTemplate = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callCreateCertificateTemplate() {
// Construct request
const request = {
parent,
certificateTemplateId,
certificateTemplate,
};
// Run request
const [operation] = await privatecaClient.createCertificateTemplate(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCertificateTemplate();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CaPool google.cloud.security.privateca.v1.CaPool in the format
* `projects/* /locations/* /caPools/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. This field allows this pool to be deleted even if it's being
* depended on by another resource. However, doing so may result in unintended
* and unrecoverable effects on any dependent resource(s) since the pool will
* no longer be able to issue certificates.
*/
// const ignoreDependentResources = true
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDeleteCaPool() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.deleteCaPool(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCaPool();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. This field allows the CA to be deleted even if the CA has
* active certs. Active certs include both unrevoked and unexpired certs.
*/
// const ignoreActiveCertificates = true
/**
* Optional. If this flag is set, the Certificate Authority will be deleted as
* soon as possible without a 30-day grace period where undeletion would have
* been allowed. If you proceed, there will be no way to recover this CA.
*/
// const skipGracePeriod = true
/**
* Optional. This field allows this ca to be deleted even if it's being
* depended on by another resource. However, doing so may result in unintended
* and unrecoverable effects on any dependent resource(s) since the CA will
* no longer be able to issue certificates.
*/
// const ignoreDependentResources = true
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDeleteCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.deleteCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCertificateAuthority();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate
* in the format `projects/* /locations/* /certificateTemplates/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDeleteCertificateTemplate() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.deleteCertificateTemplate(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCertificateTemplate();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. This field allows this CA to be disabled even if it's being
* depended on by another resource. However, doing so may result in unintended
* and unrecoverable effects on any dependent resource(s) since the CA will
* no longer be able to issue certificates.
*/
// const ignoreDependentResources = true
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDisableCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.disableCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callDisableCertificateAuthority();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callEnableCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.enableCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callEnableCertificateAuthority();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callUndeleteCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.undeleteCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callUndeleteCertificateAuthority();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. CaPool google.cloud.security.privateca.v1.CaPool with updated
* values.
*/
// const caPool = {}
/**
* Required. A list of fields to be updated in this request.
*/
// const updateMask = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callUpdateCaPool() {
// Construct request
const request = {
caPool,
updateMask,
};
// Run request
const [operation] = await privatecaClient.updateCaPool(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateCaPool();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required.
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* with updated values.
*/
// const certificateAuthority = {}
/**
* Required. A list of fields to be updated in this request.
*/
// const updateMask = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callUpdateCertificateAuthority() {
// Construct request
const request = {
certificateAuthority,
updateMask,
};
// Run request
const [operation] = await privatecaClient.updateCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateCertificateAuthority();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required.
* CertificateRevocationList google.cloud.security.privateca.v1.CertificateRevocationList
* with updated values.
*/
// const certificateRevocationList = {}
/**
* Required. A list of fields to be updated in this request.
*/
// const updateMask = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callUpdateCertificateRevocationList() {
// Construct request
const request = {
certificateRevocationList,
updateMask,
};
// Run request
const [operation] = await privatecaClient.updateCertificateRevocationList(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateCertificateRevocationList();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required.
* CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate
* with updated values.
*/
// const certificateTemplate = {}
/**
* Required. A list of fields to be updated in this request.
*/
// const updateMask = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callUpdateCertificateTemplate() {
// Construct request
const request = {
certificateTemplate,
updateMask,
};
// Run request
const [operation] = await privatecaClient.updateCertificateTemplate(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateCertificateTemplate();
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
]>;
Create a .
Parameters | |
---|---|
Name | Description |
request |
ICreateCaPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location associated with the
* CaPool google.cloud.security.privateca.v1.CaPool, in the format
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. It must be unique within a location and match the regular
* expression `[a-zA-Z0-9_-]{1,63}`
*/
// const caPoolId = 'abc123'
/**
* Required. A CaPool google.cloud.security.privateca.v1.CaPool with
* initial field values.
*/
// const caPool = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callCreateCaPool() {
// Construct request
const request = {
parent,
caPoolId,
caPool,
};
// Run request
const [operation] = await privatecaClient.createCaPool(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCaPool();
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 |
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 |
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
]>;
Create a new in a given Project, Location from a particular .
Parameters | |
---|---|
Name | Description |
request |
ICreateCertificateRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.security.privateca.v1.ICertificate,
(protos.google.cloud.security.privateca.v1.ICreateCertificateRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the
* CaPool google.cloud.security.privateca.v1.CaPool associated with the
* Certificate google.cloud.security.privateca.v1.Certificate, in the
* format `projects/* /locations/* /caPools/*`.
*/
// const parent = 'abc123'
/**
* Optional. It must be unique within a location and match the regular
* expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the Enterprise CertificateAuthority.Tier , but is optional and its
* value is ignored otherwise.
*/
// const certificateId = 'abc123'
/**
* Required. A Certificate google.cloud.security.privateca.v1.Certificate
* with initial field values.
*/
// const certificate = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. If this is true, no
* Certificate google.cloud.security.privateca.v1.Certificate resource will
* be persisted regardless of the
* CaPool google.cloud.security.privateca.v1.CaPool's
* tier google.cloud.security.privateca.v1.CaPool.tier, and the returned
* Certificate google.cloud.security.privateca.v1.Certificate will not
* contain the
* pem_certificate google.cloud.security.privateca.v1.Certificate.pem_certificate
* field.
*/
// const validateOnly = true
/**
* Optional. The resource ID of the
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* that should issue the certificate. This optional field will ignore the
* load-balancing scheme of the Pool and directly issue the certificate from
* the CA with the specified ID, contained in the same
* CaPool google.cloud.security.privateca.v1.CaPool referenced by `parent`.
* Per-CA quota rules apply. If left empty, a
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* will be chosen from the CaPool google.cloud.security.privateca.v1.CaPool
* by the service. For example, to issue a
* Certificate google.cloud.security.privateca.v1.Certificate from a
* Certificate Authority with resource name
* "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca",
* you can set the
* parent google.cloud.security.privateca.v1.CreateCertificateRequest.parent
* to "projects/my-project/locations/us-central1/caPools/my-pool" and the
* issuing_certificate_authority_id google.cloud.security.privateca.v1.CreateCertificateRequest.issuing_certificate_authority_id
* to "my-ca".
*/
// const issuingCertificateAuthorityId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callCreateCertificate() {
// Construct request
const request = {
parent,
certificate,
};
// Run request
const response = await privatecaClient.createCertificate(request);
console.log(response);
}
callCreateCertificate();
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 |
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 |
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
]>;
Create a new in a given Project and Location.
Parameters | |
---|---|
Name | Description |
request |
ICreateCertificateAuthorityRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the
* CaPool google.cloud.security.privateca.v1.CaPool associated with the
* CertificateAuthorities google.cloud.security.privateca.v1.CertificateAuthority,
* in the format `projects/* /locations/* /caPools/*`.
*/
// const parent = 'abc123'
/**
* Required. It must be unique within a location and match the regular
* expression `[a-zA-Z0-9_-]{1,63}`
*/
// const certificateAuthorityId = 'abc123'
/**
* Required. A
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* with initial field values.
*/
// const certificateAuthority = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callCreateCertificateAuthority() {
// Construct request
const request = {
parent,
certificateAuthorityId,
certificateAuthority,
};
// Run request
const [operation] = await privatecaClient.createCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCertificateAuthority();
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 |
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 |
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
]>;
Create a new CertificateTemplate in a given Project and Location.
Parameters | |
---|---|
Name | Description |
request |
ICreateCertificateTemplateRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location associated with the
* CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate,
* in the format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. It must be unique within a location and match the regular
* expression `[a-zA-Z0-9_-]{1,63}`
*/
// const certificateTemplateId = 'abc123'
/**
* Required. A
* CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate
* with initial field values.
*/
// const certificateTemplate = {}
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callCreateCertificateTemplate() {
// Construct request
const request = {
parent,
certificateTemplateId,
certificateTemplate,
};
// Run request
const [operation] = await privatecaClient.createCertificateTemplate(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCertificateTemplate();
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 |
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 |
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
]>;
Delete a .
Parameters | |
---|---|
Name | Description |
request |
IDeleteCaPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CaPool google.cloud.security.privateca.v1.CaPool in the format
* `projects/* /locations/* /caPools/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. This field allows this pool to be deleted even if it's being
* depended on by another resource. However, doing so may result in unintended
* and unrecoverable effects on any dependent resource(s) since the pool will
* no longer be able to issue certificates.
*/
// const ignoreDependentResources = true
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDeleteCaPool() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.deleteCaPool(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCaPool();
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 |
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 |
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
]>;
Delete a .
Parameters | |
---|---|
Name | Description |
request |
IDeleteCertificateAuthorityRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. This field allows the CA to be deleted even if the CA has
* active certs. Active certs include both unrevoked and unexpired certs.
*/
// const ignoreActiveCertificates = true
/**
* Optional. If this flag is set, the Certificate Authority will be deleted as
* soon as possible without a 30-day grace period where undeletion would have
* been allowed. If you proceed, there will be no way to recover this CA.
*/
// const skipGracePeriod = true
/**
* Optional. This field allows this ca to be deleted even if it's being
* depended on by another resource. However, doing so may result in unintended
* and unrecoverable effects on any dependent resource(s) since the CA will
* no longer be able to issue certificates.
*/
// const ignoreDependentResources = true
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDeleteCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.deleteCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCertificateAuthority();
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 |
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 |
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
]>;
DeleteCertificateTemplate deletes a CertificateTemplate.
Parameters | |
---|---|
Name | Description |
request |
IDeleteCertificateTemplateRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.security.privateca.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate
* in the format `projects/* /locations/* /certificateTemplates/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDeleteCertificateTemplate() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.deleteCertificateTemplate(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCertificateTemplate();
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 |
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 |
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 |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
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
]>;
Disable a .
Parameters | |
---|---|
Name | Description |
request |
IDisableCertificateAuthorityRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. This field allows this CA to be disabled even if it's being
* depended on by another resource. However, doing so may result in unintended
* and unrecoverable effects on any dependent resource(s) since the CA will
* no longer be able to issue certificates.
*/
// const ignoreDependentResources = true
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callDisableCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.disableCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callDisableCertificateAuthority();
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 |
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 |
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
]>;
Enable a .
Parameters | |
---|---|
Name | Description |
request |
IEnableCertificateAuthorityRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for this
* CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority
* in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callEnableCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.enableCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callEnableCertificateAuthority();
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 |
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 |
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
]>;
FetchCaCerts returns the current trust anchor for the . This will include CA certificate chains for all Certificate Authorities in the ENABLED, DISABLED, or STAGED states.
Parameters | |
---|---|
Name | Description |
request |
IFetchCaCertsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse,
(protos.google.cloud.security.privateca.v1.IFetchCaCertsRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name for the
* CaPool google.cloud.security.privateca.v1.CaPool in the format
* `projects/* /locations/* /caPools/*`.
*/
// const caPool = 'abc123'
/**
* Optional. An ID to identify requests. Specify a unique request ID so that
* if you must retry your request, the server will know to ignore the request
* if it has already been completed. The server will guarantee that for at
* least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callFetchCaCerts() {
// Construct request
const request = {
caPool,
};
// Run request
const response = await privatecaClient.fetchCaCerts(request);
console.log(response);
}
callFetchCaCerts();
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 |
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 |
IFetchCaCertsRequest
|
callback |
Callback<protos.google.cloud.security.privateca.v1.IFetchCaCertsResponse, protos.google.cloud.security.privateca.v1.IFetchC |