manages private certificate authorities and issued certificates. v1beta1
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;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
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.v1beta1.IActivateCertificateAuthorityRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
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.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Required. The signed CA certificate issued from
* FetchCertificateAuthorityCsrResponse.pem_csr google.cloud.security.privateca.v1beta1.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 t
* he 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').v1beta1;
// 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.v1beta1.IActivateCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IActivateCertificateAuthorityRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
activateCertificateAuthority(request, callback)
activateCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IActivateCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IActivateCertificateAuthorityRequest
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
certificateAuthorityPath(project, location, certificateAuthority)
certificateAuthorityPath(project: string, location: string, certificateAuthority: string): string;
Return a fully-qualified certificateAuthority resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
certificateAuthority |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
certificatePath(project, location, certificateAuthority, certificate)
certificatePath(project: string, location: string, certificateAuthority: string, certificate: string): string;
Return a fully-qualified certificate resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
certificateAuthority |
string
|
certificate |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
certificateRevocationListPath(project, location, certificateAuthority, certificateRevocationList)
certificateRevocationListPath(project: string, location: string, certificateAuthority: string, certificateRevocationList: string): string;
Return a fully-qualified certificateRevocationList resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
certificateAuthority |
string
|
certificateRevocationList |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
checkActivateCertificateAuthorityProgress(name)
checkActivateCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by activateCertificateAuthority()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
/**
* Required. The signed CA certificate issued from
* FetchCertificateAuthorityCsrResponse.pem_csr google.cloud.security.privateca.v1beta1.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 t
* he 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').v1beta1;
// 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();
checkCreateCertificateAuthorityProgress(name)
checkCreateCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by createCertificateAuthority()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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
* CertificateAuthorities google.cloud.security.privateca.v1beta1.CertificateAuthority, 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 certificateAuthorityId = 'abc123'
/**
* Required. A CertificateAuthority google.cloud.security.privateca.v1beta1.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 t
* he 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').v1beta1;
// 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();
checkDisableCertificateAuthorityProgress(name)
checkDisableCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by disableCertificateAuthority()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /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 t
* he 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').v1beta1;
// 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.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by enableCertificateAuthority()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /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 t
* he 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').v1beta1;
// 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();
checkRestoreCertificateAuthorityProgress(name)
checkRestoreCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by restoreCertificateAuthority()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /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 t
* he 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').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callRestoreCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.restoreCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callRestoreCertificateAuthority();
checkScheduleDeleteCertificateAuthorityProgress(name)
checkScheduleDeleteCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by scheduleDeleteCertificateAuthority()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /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 t
* he 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').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callScheduleDeleteCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await privatecaClient.scheduleDeleteCertificateAuthority(request);
const [response] = await operation.promise();
console.log(response);
}
callScheduleDeleteCertificateAuthority();
checkUpdateCertificateAuthorityProgress(name)
checkUpdateCertificateAuthorityProgress(name: string): Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by updateCertificateAuthority()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateAuthority, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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.v1beta1.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 t
* he 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').v1beta1;
// 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.v1beta1.CertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by updateCertificateRevocationList()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.security.privateca.v1beta1.CertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation 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.v1beta1.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 t
* he 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').v1beta1;
// 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();
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createCertificate(request, options)
createCertificate(request?: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.ICertificate,
(protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | undefined),
{} | undefined
]>;
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.v1beta1.ICertificate,
(protos.google.cloud.security.privateca.v1beta1.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 location and CertificateAuthority google.cloud.security.privateca.v1beta1.CertificateAuthority
* associated with the Certificate google.cloud.security.privateca.v1beta1.Certificate, in the format
* `projects/* /locations/* /certificateAuthorities/*`.
*/
// 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.v1beta1.CertificateAuthority in the Enterprise CertificateAuthority.Tier google.cloud.security.privateca.v1beta1.CertificateAuthority.Tier,
* but is optional and its value is ignored otherwise.
*/
// const certificateId = 'abc123'
/**
* Required. A Certificate google.cloud.security.privateca.v1beta1.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 t
* he 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').v1beta1;
// 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.v1beta1.ICreateCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateCertificateRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createCertificate(request, callback)
createCertificate(request: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateCertificateRequest
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.ICreateCertificateRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createCertificateAuthority(request, options)
createCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
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.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.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
* CertificateAuthorities google.cloud.security.privateca.v1beta1.CertificateAuthority, 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 certificateAuthorityId = 'abc123'
/**
* Required. A CertificateAuthority google.cloud.security.privateca.v1beta1.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 t
* he 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').v1beta1;
// 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.v1beta1.ICreateCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateCertificateAuthorityRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createCertificateAuthority(request, callback)
createCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.ICreateCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateCertificateAuthorityRequest
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
disableCertificateAuthority(request, options)
disableCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
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.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /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 t
* he 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').v1beta1;
// 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.v1beta1.IDisableCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDisableCertificateAuthorityRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
disableCertificateAuthority(request, callback)
disableCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IDisableCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDisableCertificateAuthorityRequest
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
enableCertificateAuthority(request, options)
enableCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
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.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /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 t
* he 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').v1beta1;
// 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.v1beta1.IEnableCertificateAuthorityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IEnableCertificateAuthorityRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
enableCertificateAuthority(request, callback)
enableCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IEnableCertificateAuthorityRequest, callback: Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IEnableCertificateAuthorityRequest
|
callback |
Callback<LROperation<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
fetchCertificateAuthorityCsr(request, options)
fetchCertificateAuthorityCsr(request?: protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse,
(protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | undefined),
{} | undefined
]>;
Fetch a certificate signing request (CSR) from a that is in state and is of type . The CSR must then be signed by the desired parent Certificate Authority, which could be another resource, or could be an on-prem certificate authority. See also .
Parameters | |
---|---|
Name | Description |
request |
IFetchCertificateAuthorityCsrRequest
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.v1beta1.IFetchCertificateAuthorityCsrResponse,
(protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing FetchCertificateAuthorityCsrResponse. 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.v1beta1.CertificateAuthority in the
* format `projects/* /locations/* /certificateAuthorities/*`.
*/
// const name = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callFetchCertificateAuthorityCsr() {
// Construct request
const request = {
name,
};
// Run request
const response = await privatecaClient.fetchCertificateAuthorityCsr(request);
console.log(response);
}
callFetchCertificateAuthorityCsr();
fetchCertificateAuthorityCsr(request, options, callback)
fetchCertificateAuthorityCsr(request: protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IFetchCertificateAuthorityCsrRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
fetchCertificateAuthorityCsr(request, callback)
fetchCertificateAuthorityCsr(request: protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IFetchCertificateAuthorityCsrRequest
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrResponse, protos.google.cloud.security.privateca.v1beta1.IFetchCertificateAuthorityCsrRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getCertificate(request, options)
getCertificate(request?: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.ICertificate,
(protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | undefined),
{} | undefined
]>;
Returns a .
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateRequest
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.v1beta1.ICertificate,
(protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | 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 name google.cloud.security.privateca.v1beta1.Certificate.name of the Certificate google.cloud.security.privateca.v1beta1.Certificate to get.
*/
// const name = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callGetCertificate() {
// Construct request
const request = {
name,
};
// Run request
const response = await privatecaClient.getCertificate(request);
console.log(response);
}
callGetCertificate();
getCertificate(request, options, callback)
getCertificate(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getCertificate(request, callback)
getCertificate(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateRequest
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificate, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getCertificateAuthority(request, options)
getCertificateAuthority(request?: protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority,
(protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | undefined),
{} | undefined
]>;
Returns a .
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateAuthorityRequest
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.v1beta1.ICertificateAuthority,
(protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | 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 name google.cloud.security.privateca.v1beta1.CertificateAuthority.name of the CertificateAuthority google.cloud.security.privateca.v1beta1.CertificateAuthority to
* get.
*/
// const name = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callGetCertificateAuthority() {
// Construct request
const request = {
name,
};
// Run request
const response = await privatecaClient.getCertificateAuthority(request);
console.log(response);
}
callGetCertificateAuthority();
getCertificateAuthority(request, options, callback)
getCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateAuthorityRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getCertificateAuthority(request, callback)
getCertificateAuthority(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateAuthorityRequest
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority, protos.google.cloud.security.privateca.v1beta1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getCertificateRevocationList(request, options)
getCertificateRevocationList(request?: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList,
(protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | undefined),
{} | undefined
]>;
Returns a .
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateRevocationListRequest
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.v1beta1.ICertificateRevocationList,
(protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | 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 name google.cloud.security.privateca.v1beta1.CertificateRevocationList.name of the
* CertificateRevocationList google.cloud.security.privateca.v1beta1.CertificateRevocationList to get.
*/
// const name = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callGetCertificateRevocationList() {
// Construct request
const request = {
name,
};
// Run request
const response = await privatecaClient.getCertificateRevocationList(request);
console.log(response);
}
callGetCertificateRevocationList();
getCertificateRevocationList(request, options, callback)
getCertificateRevocationList(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateRevocationListRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getCertificateRevocationList(request, callback)
getCertificateRevocationList(request: protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetCertificateRevocationListRequest
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList, protos.google.cloud.security.privateca.v1beta1.IGetCertificateRevocationListRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
getReusableConfig(request, options)
getReusableConfig(request?: protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.IReusableConfig,
(protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | undefined),
{} | undefined
]>;
Returns a ReusableConfig.
Parameters | |
---|---|
Name | Description |
request |
IGetReusableConfigRequest
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.v1beta1.IReusableConfig,
(protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing ReusableConfig. 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 name ReusableConfigs.name of the ReusableConfigs to get.
*/
// const name = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callGetReusableConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await privatecaClient.getReusableConfig(request);
console.log(response);
}
callGetReusableConfig();
getReusableConfig(request, options, callback)
getReusableConfig(request: protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetReusableConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getReusableConfig(request, callback)
getReusableConfig(request: protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest, callback: Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetReusableConfigRequest
|
callback |
Callback<protos.google.cloud.security.privateca.v1beta1.IReusableConfig, protos.google.cloud.security.privateca.v1beta1.IGetReusableConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub. |
listCertificateAuthorities(request, options)
listCertificateAuthorities(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority[],
protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse
]>;
Lists .
Parameters | |
---|---|
Name | Description |
request |
IListCertificateAuthoritiesRequest
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.v1beta1.ICertificateAuthority[],
protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listCertificateAuthorities(request, options, callback)
listCertificateAuthorities(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>): void;
Parameters | |
---|---|
Name | Description |
request |
IListCertificateAuthoritiesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>
|
Returns | |
---|---|
Type | Description |
void |
listCertificateAuthorities(request, callback)
listCertificateAuthorities(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>): void;
Parameters | |
---|---|
Name | Description |
request |
IListCertificateAuthoritiesRequest
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>
|
Returns | |
---|---|
Type | Description |
void |
listCertificateAuthoritiesAsync(request, options)
listCertificateAuthoritiesAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority>;
Equivalent to listCertificateAuthorities
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListCertificateAuthoritiesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateAuthority> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation 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
* CertificateAuthorities google.cloud.security.privateca.v1beta1.CertificateAuthority, in the format
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Optional. Limit on the number of CertificateAuthorities google.cloud.security.privateca.v1beta1.CertificateAuthority to
* include in the response.
* Further CertificateAuthorities google.cloud.security.privateca.v1beta1.CertificateAuthority can subsequently be
* obtained by including the
* ListCertificateAuthoritiesResponse.next_page_token google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse.next_page_token in a subsequent
* request. If unspecified, the server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Pagination token, returned earlier via
* ListCertificateAuthoritiesResponse.next_page_token google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse.next_page_token.
*/
// const pageToken = 'abc123'
/**
* Optional. Only include resources that match the filter in the response.
*/
// const filter = 'abc123'
/**
* Optional. Specify how the results should be sorted.
*/
// const orderBy = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callListCertificateAuthorities() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = privatecaClient.listCertificateAuthoritiesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCertificateAuthorities();
listCertificateAuthoritiesStream(request, options)
listCertificateAuthoritiesStream(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateAuthoritiesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListCertificateAuthoritiesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listCertificateRevocationLists(request, options)
listCertificateRevocationLists(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList[],
protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse
]>;
Lists .
Parameters | |
---|---|
Name | Description |
request |
IListCertificateRevocationListsRequest
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.v1beta1.ICertificateRevocationList[],
protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listCertificateRevocationLists(request, options, callback)
listCertificateRevocationLists(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>): void;
Parameters | |
---|---|
Name | Description |
request |
IListCertificateRevocationListsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>
|
Returns | |
---|---|
Type | Description |
void |
listCertificateRevocationLists(request, callback)
listCertificateRevocationLists(request: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>): void;
Parameters | |
---|---|
Name | Description |
request |
IListCertificateRevocationListsRequest
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>
|
Returns | |
---|---|
Type | Description |
void |
listCertificateRevocationListsAsync(request, options)
listCertificateRevocationListsAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList>;
Equivalent to listCertificateRevocationLists
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListCertificateRevocationListsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificateRevocationList> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation 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
* CertificateRevocationLists google.cloud.security.privateca.v1beta1.CertificateRevocationList, in the format
* `projects/* /locations/* /certificateauthorities/*`.
*/
// const parent = 'abc123'
/**
* Optional. Limit on the number of
* CertificateRevocationLists google.cloud.security.privateca.v1beta1.CertificateRevocationList to include in the
* response. Further CertificateRevocationLists google.cloud.security.privateca.v1beta1.CertificateRevocationList
* can subsequently be obtained by including the
* ListCertificateRevocationListsResponse.next_page_token google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse.next_page_token in a subsequent
* request. If unspecified, the server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Pagination token, returned earlier via
* ListCertificateRevocationListsResponse.next_page_token google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse.next_page_token.
*/
// const pageToken = 'abc123'
/**
* Optional. Only include resources that match the filter in the response.
*/
// const filter = 'abc123'
/**
* Optional. Specify how the results should be sorted.
*/
// const orderBy = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callListCertificateRevocationLists() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = privatecaClient.listCertificateRevocationListsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCertificateRevocationLists();
listCertificateRevocationListsStream(request, options)
listCertificateRevocationListsStream(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificateRevocationListsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListCertificateRevocationListsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listCertificates(request, options)
listCertificates(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.ICertificate[],
protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse
]>;
Lists .
Parameters | |
---|---|
Name | Description |
request |
IListCertificatesRequest
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.v1beta1.ICertificate[],
protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listCertificates(request, options, callback)
listCertificates(request: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>): void;
Parameters | |
---|---|
Name | Description |
request |
IListCertificatesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>
|
Returns | |
---|---|
Type | Description |
void |
listCertificates(request, callback)
listCertificates(request: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>): void;
Parameters | |
---|---|
Name | Description |
request |
IListCertificatesRequest
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, protos.google.cloud.security.privateca.v1beta1.IListCertificatesResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.ICertificate>
|
Returns | |
---|---|
Type | Description |
void |
listCertificatesAsync(request, options)
listCertificatesAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificate>;
Equivalent to listCertificates
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListCertificatesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.ICertificate> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation 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
* Certificates google.cloud.security.privateca.v1beta1.Certificate, in the format
* `projects/* /locations/* /certificateauthorities/*`.
*/
// const parent = 'abc123'
/**
* Optional. Limit on the number of
* Certificates google.cloud.security.privateca.v1beta1.Certificate to include in the
* response. Further Certificates google.cloud.security.privateca.v1beta1.Certificate can subsequently be obtained
* by including the
* ListCertificatesResponse.next_page_token google.cloud.security.privateca.v1beta1.ListCertificatesResponse.next_page_token in a subsequent
* request. If unspecified, the server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Pagination token, returned earlier via
* ListCertificatesResponse.next_page_token google.cloud.security.privateca.v1beta1.ListCertificatesResponse.next_page_token.
*/
// const pageToken = 'abc123'
/**
* Optional. Only include resources that match the filter in the response. For details
* on supported filters and syntax, see Certificates Filtering
* documentation (https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support).
*/
// const filter = 'abc123'
/**
* Optional. Specify how the results should be sorted. For details on supported fields
* and syntax, see Certificates Sorting
* documentation (https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support).
*/
// const orderBy = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callListCertificates() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = privatecaClient.listCertificatesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCertificates();
listCertificatesStream(request, options)
listCertificatesStream(request?: protos.google.cloud.security.privateca.v1beta1.IListCertificatesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListCertificatesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listReusableConfigs(request, options)
listReusableConfigs(request?: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, options?: CallOptions): Promise<[
protos.google.cloud.security.privateca.v1beta1.IReusableConfig[],
protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse
]>;
Lists ReusableConfigs.
Parameters | |
---|---|
Name | Description |
request |
IListReusableConfigsRequest
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.v1beta1.IReusableConfig[],
protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest | null,
protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of ReusableConfig. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listReusableConfigs(request, options, callback)
listReusableConfigs(request: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListReusableConfigsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>
|
Returns | |
---|---|
Type | Description |
void |
listReusableConfigs(request, callback)
listReusableConfigs(request: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, callback: PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListReusableConfigsRequest
|
callback |
PaginationCallback<protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsResponse | null | undefined, protos.google.cloud.security.privateca.v1beta1.IReusableConfig>
|
Returns | |
---|---|
Type | Description |
void |
listReusableConfigsAsync(request, options)
listReusableConfigsAsync(request?: protos.google.cloud.security.privateca.v1beta1.IListReusableConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.security.privateca.v1beta1.IReusableConfig>;
Equivalent to listReusableConfigs
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListReusableConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.security.privateca.v1beta1.IReusableConfig> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ReusableConfig. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation 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
* ReusableConfigs google.cloud.security.privateca.v1beta1.ReusableConfig, in the format
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Optional. Limit on the number of
* ReusableConfigs google.cloud.security.privateca.v1beta1.ReusableConfig to include in the response.
* Further ReusableConfigs google.cloud.security.privateca.v1beta1.ReusableConfig can subsequently be
* obtained by including the
* ListReusableConfigsResponse.next_page_token google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse.next_page_token in a subsequent request. If
* unspecified, the server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Pagination token, returned earlier via
* ListReusableConfigsResponse.next_page_token google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse.next_page_token.
*/
// const pageToken = 'abc123'
/**
* Optional. Only include resources that match the filter in the response.
*/
// const filter = 'abc123'
/**
* Optional. Specify how the results should be sorted.
*/
// const orderBy = 'abc123'
// Imports the Privateca library
const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1beta1;
// Instantiates a client
const privatecaClient = new CertificateAuthorityServiceClient();
async function callListReusableConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = privatecaClient.listReusableConfigsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListReusableConfigs();
listReusableConfigsStream(request, options)