CertificateAuthorityServiceClient

CertificateAuthorityServiceClient

[Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private certificate authorities and issued certificates.

Constructor

new CertificateAuthorityServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of CertificateAuthorityServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CertificateAuthorityServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

caPoolPath(project, location, ca_pool) → {string}

Return a fully-qualified caPool resource name string.

Parameters:
Name Type Description
project string
location string
ca_pool string
Returns:
Type Description
string

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

certificateAuthorityPath(project, location, ca_pool, certificate_authority) → {string}

Return a fully-qualified certificateAuthority resource name string.

Parameters:
Name Type Description
project string
location string
ca_pool string
certificate_authority string
Returns:
Type Description
string

Resource name string.

certificatePath(project, location, ca_pool, certificate) → {string}

Return a fully-qualified certificate resource name string.

Parameters:
Name Type Description
project string
location string
ca_pool string
certificate string
Returns:
Type Description
string

Resource name string.

certificateRevocationListPath(project, location, ca_pool, certificate_authority, certificate_revocation_list) → {string}

Return a fully-qualified certificateRevocationList resource name string.

Parameters:
Name Type Description
project string
location string
ca_pool string
certificate_authority string
certificate_revocation_list string
Returns:
Type Description
string

Resource name string.

certificateTemplatePath(project, location, certificate_template) → {string}

Return a fully-qualified certificateTemplate resource name string.

Parameters:
Name Type Description
project string
location string
certificate_template string
Returns:
Type Description
string

Resource name string.

(async) checkActivateCertificateAuthorityProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for this
   *  CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority 
   *  in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
   */
  // const name = 'abc123'
  /**
   *  Required. The signed CA certificate issued from
   *  FetchCertificateAuthorityCsrResponse.pem_csr google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse.pem_csr.
   */
  // const pemCaCertificate = 'abc123'
  /**
   *  Required. Must include information about the issuer of
   *  'pem_ca_certificate', and any further issuers until the self-signed CA.
   */
  // const subordinateConfig = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callActivateCertificateAuthority() {
    // Construct request
    const request = {
      name,
      pemCaCertificate,
      subordinateConfig,
    };

    // Run request
    const [operation] = await privatecaClient.activateCertificateAuthority(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callActivateCertificateAuthority();

(async) checkCreateCaPoolProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location associated with the
   *  CaPool google.cloud.security.privateca.v1.CaPool, in the format
   *  `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. It must be unique within a location and match the regular
   *  expression `[a-zA-Z0-9_-]{1,63}`
   */
  // const caPoolId = 'abc123'
  /**
   *  Required. A CaPool google.cloud.security.privateca.v1.CaPool  with
   *  initial field values.
   */
  // const caPool = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callCreateCaPool() {
    // Construct request
    const request = {
      parent,
      caPoolId,
      caPool,
    };

    // Run request
    const [operation] = await privatecaClient.createCaPool(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCaPool();

(async) checkCreateCertificateAuthorityProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the
   *  CaPool google.cloud.security.privateca.v1.CaPool  associated with the
   *  CertificateAuthorities google.cloud.security.privateca.v1.CertificateAuthority,
   *  in the format `projects/* /locations/* /caPools/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. It must be unique within a location and match the regular
   *  expression `[a-zA-Z0-9_-]{1,63}`
   */
  // const certificateAuthorityId = 'abc123'
  /**
   *  Required. A
   *  CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority 
   *  with initial field values.
   */
  // const certificateAuthority = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callCreateCertificateAuthority() {
    // Construct request
    const request = {
      parent,
      certificateAuthorityId,
      certificateAuthority,
    };

    // Run request
    const [operation] = await privatecaClient.createCertificateAuthority(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCertificateAuthority();

(async) checkCreateCertificateTemplateProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location associated with the
   *  CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate,
   *  in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. It must be unique within a location and match the regular
   *  expression `[a-zA-Z0-9_-]{1,63}`
   */
  // const certificateTemplateId = 'abc123'
  /**
   *  Required. A
   *  CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate 
   *  with initial field values.
   */
  // const certificateTemplate = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callCreateCertificateTemplate() {
    // Construct request
    const request = {
      parent,
      certificateTemplateId,
      certificateTemplate,
    };

    // Run request
    const [operation] = await privatecaClient.createCertificateTemplate(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCertificateTemplate();

(async) checkDeleteCaPoolProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for this
   *  CaPool google.cloud.security.privateca.v1.CaPool  in the format
   *  `projects/* /locations/* /caPools/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. This field allows this pool to be deleted even if it's being
   *  depended on by another resource. However, doing so may result in unintended
   *  and unrecoverable effects on any dependent resource(s) since the pool will
   *  no longer be able to issue certificates.
   */
  // const ignoreDependentResources = true

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callDeleteCaPool() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await privatecaClient.deleteCaPool(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCaPool();

(async) checkDeleteCertificateAuthorityProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for this
   *  CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority 
   *  in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. This field allows the CA to be deleted even if the CA has
   *  active certs. Active certs include both unrevoked and unexpired certs.
   */
  // const ignoreActiveCertificates = true
  /**
   *  Optional. If this flag is set, the Certificate Authority will be deleted as
   *  soon as possible without a 30-day grace period where undeletion would have
   *  been allowed. If you proceed, there will be no way to recover this CA.
   */
  // const skipGracePeriod = true
  /**
   *  Optional. This field allows this ca to be deleted even if it's being
   *  depended on by another resource. However, doing so may result in unintended
   *  and unrecoverable effects on any dependent resource(s) since the CA will
   *  no longer be able to issue certificates.
   */
  // const ignoreDependentResources = true

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callDeleteCertificateAuthority() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await privatecaClient.deleteCertificateAuthority(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCertificateAuthority();

(async) checkDeleteCertificateTemplateProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for this
   *  CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate 
   *  in the format `projects/* /locations/* /certificateTemplates/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callDeleteCertificateTemplate() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await privatecaClient.deleteCertificateTemplate(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCertificateTemplate();

(async) checkDisableCertificateAuthorityProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for this
   *  CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority 
   *  in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. This field allows this CA to be disabled even if it's being
   *  depended on by another resource. However, doing so may result in unintended
   *  and unrecoverable effects on any dependent resource(s) since the CA will
   *  no longer be able to issue certificates.
   */
  // const ignoreDependentResources = true

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callDisableCertificateAuthority() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await privatecaClient.disableCertificateAuthority(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDisableCertificateAuthority();

(async) checkEnableCertificateAuthorityProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for this
   *  CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority 
   *  in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callEnableCertificateAuthority() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await privatecaClient.enableCertificateAuthority(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callEnableCertificateAuthority();

(async) checkUndeleteCertificateAuthorityProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for this
   *  CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority 
   *  in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callUndeleteCertificateAuthority() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await privatecaClient.undeleteCertificateAuthority(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUndeleteCertificateAuthority();

(async) checkUpdateCaPoolProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. CaPool google.cloud.security.privateca.v1.CaPool  with updated
   *  values.
   */
  // const caPool = {}
  /**
   *  Required. A list of fields to be updated in this request.
   */
  // const updateMask = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callUpdateCaPool() {
    // Construct request
    const request = {
      caPool,
      updateMask,
    };

    // Run request
    const [operation] = await privatecaClient.updateCaPool(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateCaPool();

(async) checkUpdateCertificateAuthorityProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required.
   *  CertificateAuthority google.cloud.security.privateca.v1.CertificateAuthority 
   *  with updated values.
   */
  // const certificateAuthority = {}
  /**
   *  Required. A list of fields to be updated in this request.
   */
  // const updateMask = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callUpdateCertificateAuthority() {
    // Construct request
    const request = {
      certificateAuthority,
      updateMask,
    };

    // Run request
    const [operation] = await privatecaClient.updateCertificateAuthority(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateCertificateAuthority();

(async) checkUpdateCertificateRevocationListProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required.
   *  CertificateRevocationList google.cloud.security.privateca.v1.CertificateRevocationList 
   *  with updated values.
   */
  // const certificateRevocationList = {}
  /**
   *  Required. A list of fields to be updated in this request.
   */
  // const updateMask = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callUpdateCertificateRevocationList() {
    // Construct request
    const request = {
      certificateRevocationList,
      updateMask,
    };

    // Run request
    const [operation] = await privatecaClient.updateCertificateRevocationList(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateCertificateRevocationList();

(async) checkUpdateCertificateTemplateProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required.
   *  CertificateTemplate google.cloud.security.privateca.v1.CertificateTemplate 
   *  with updated values.
   */
  // const certificateTemplate = {}
  /**
   *  Required. A list of fields to be updated in this request.
   */
  // const updateMask = {}
  /**
   *  Optional. An ID to identify requests. Specify a unique request ID so that
   *  if you must retry your request, the server will know to ignore the request
   *  if it has already been completed. The server will guarantee that for at
   *  least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Privateca library
  const {CertificateAuthorityServiceClient} = require('@google-cloud/security-private-ca').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callUpdateCertificateTemplate() {
    // Construct request
    const request = {
      certificateTemplate,
      updateMask,
    };

    // Run request
    const [operation] = await privatecaClient.updateCertificateTemplate(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateCertificateTemplate();

close() → {Promise}

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

A promise that resolves when the client is closed.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options Object <optional>

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listCaPoolsAsync(request, optionsopt) → {Object}

Equivalent to listCaPools, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the CaPools, in the format projects/* /locations/*.
pageSize number <optional>

Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CaPool. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * 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
   *  CaPools google.cloud.security.privateca.v1.CaPool, in the format
   *  `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Limit on the number of
   *  CaPools google.cloud.security.privateca.v1.CaPool  to include in the
   *  response. Further CaPools google.cloud.security.privateca.v1.CaPool  can
   *  subsequently be obtained by including the
   *  ListCaPoolsResponse.next_page_token google.cloud.security.privateca.v1.ListCaPoolsResponse.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
   *  ListCaPoolsResponse.next_page_token google.cloud.security.privateca.v1.ListCaPoolsResponse.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').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callListCaPools() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = privatecaClient.listCaPoolsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCaPools();

listCaPoolsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the CaPools, in the format projects/* /locations/*.
pageSize number <optional>

Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing CaPool on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCaPoolsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCertificateAuthoritiesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/* /locations/* /caPools/*.
pageSize number <optional>

Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CertificateAuthority. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the
   *  CaPool google.cloud.security.privateca.v1.CaPool  associated with the
   *  CertificateAuthorities google.cloud.security.privateca.v1.CertificateAuthority,
   *  in the format `projects/* /locations/* /caPools/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Limit on the number of
   *  CertificateAuthorities google.cloud.security.privateca.v1.CertificateAuthority 
   *  to include in the response. Further
   *  CertificateAuthorities google.cloud.security.privateca.v1.CertificateAuthority 
   *  can subsequently be obtained by including the
   *  ListCertificateAuthoritiesResponse.next_page_token google.cloud.security.privateca.v1.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.v1.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').v1;

  // 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, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/* /locations/* /caPools/*.
pageSize number <optional>

Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing CertificateAuthority on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateAuthoritiesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCertificateRevocationListsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the CertificateRevocationLists, in the format projects/* /locations/* /caPools/* /certificateAuthorities/*.
pageSize number <optional>

Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CertificateRevocationList. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * 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.v1.CertificateRevocationList,
   *  in the format `projects/* /locations/* /caPools/* /certificateAuthorities/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Limit on the number of
   *  CertificateRevocationLists google.cloud.security.privateca.v1.CertificateRevocationList 
   *  to include in the response. Further
   *  CertificateRevocationLists google.cloud.security.privateca.v1.CertificateRevocationList 
   *  can subsequently be obtained by including the
   *  ListCertificateRevocationListsResponse.next_page_token google.cloud.security.privateca.v1.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.v1.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').v1;

  // 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, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the CertificateRevocationLists, in the format projects/* /locations/* /caPools/* /certificateAuthorities/*.
pageSize number <optional>

Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing CertificateRevocationList on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateRevocationListsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCertificateTemplatesAsync(request, optionsopt) → {Object}

Equivalent to listCertificateTemplates, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the CertificateTemplates, in the format projects/* /locations/*.
pageSize number <optional>

Optional. Limit on the number of CertificateTemplates to include in the response. Further CertificateTemplates can subsequently be obtained by including the ListCertificateTemplatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificateTemplatesResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CertificateTemplate. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * 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
   *  CertificateTemplates google.cloud.security.privateca.v1.CertificateTemplate,
   *  in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Limit on the number of
   *  CertificateTemplates google.cloud.security.privateca.v1.CertificateTemplate 
   *  to include in the response. Further
   *  CertificateTemplates google.cloud.security.privateca.v1.CertificateTemplate 
   *  can subsequently be obtained by including the
   *  ListCertificateTemplatesResponse.next_page_token google.cloud.security.privateca.v1.ListCertificateTemplatesResponse.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
   *  ListCertificateTemplatesResponse.next_page_token google.cloud.security.privateca.v1.ListCertificateTemplatesResponse.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').v1;

  // Instantiates a client
  const privatecaClient = new CertificateAuthorityServiceClient();

  async function callListCertificateTemplates() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = privatecaClient.listCertificateTemplatesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCertificateTemplates();

listCertificateTemplatesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the CertificateTemplates, in the format projects/* /locations/*.
pageSize number <optional>

Optional. Limit on the number of CertificateTemplates to include in the response. Further CertificateTemplates can subsequently be obtained by including the ListCertificateTemplatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificateTemplatesResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response.
orderBy string <optional>

Optional. Specify how the results should be sorted.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing CertificateTemplate on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateTemplatesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCertificatesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the Certificates, in the format projects/* /locations/* /caPools/*.
pageSize number <optional>

Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.
orderBy string <optional>

Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Certificate. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * 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.v1.Certificate, in the
   *  format `projects/* /locations/* /caPools/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Limit on the number of
   *  Certificates google.cloud.security.privateca.v1.Certificate  to include
   *  in the response. Further
   *  Certificates google.cloud.security.privateca.v1.Certificate  can
   *  subsequently be obtained by including the
   *  ListCertificatesResponse.next_page_token google.cloud.security.privateca.v1.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.v1.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').v1;

  // 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, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the location associated with the Certificates, in the format projects/* /locations/* /caPools/*.
pageSize number <optional>

Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken string <optional>

Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.
filter string <optional>

Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.
orderBy string <optional>

Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Certificate on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificatesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

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

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

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

Resource name string.

matchCaPoolFromCaPoolName(caPoolName) → {string}

Parse the ca_pool from CaPool resource.

Parameters:
Name Type Description
caPoolName string

A fully-qualified path representing CaPool resource.
Returns:
Type Description
string

A string representing the ca_pool.

matchCaPoolFromCertificateAuthorityName(certificateAuthorityName) → {string}

Parse the ca_pool from CertificateAuthority resource.

Parameters:
Name Type Description
certificateAuthorityName string

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

A string representing the ca_pool.

matchCaPoolFromCertificateName(certificateName) → {string}

Parse the ca_pool from Certificate resource.

Parameters:
Name Type Description
certificateName string

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

A string representing the ca_pool.

matchCaPoolFromCertificateRevocationListName(certificateRevocationListName) → {string}

Parse the ca_pool from CertificateRevocationList resource.

Parameters:
Name Type Description
certificateRevocationListName string

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

A string representing the ca_pool.

matchCertificateAuthorityFromCertificateAuthorityName(certificateAuthorityName) → {string}

Parse the certificate_authority from CertificateAuthority resource.

Parameters:
Name Type Description
certificateAuthorityName string

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

A string representing the certificate_authority.

matchCertificateAuthorityFromCertificateRevocationListName(certificateRevocationListName) → {string}

Parse the certificate_authority from CertificateRevocationList resource.

Parameters:
Name Type Description
certificateRevocationListName string

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

A string representing the certificate_authority.

matchCertificateFromCertificateName(certificateName) → {string}

Parse the certificate from Certificate resource.

Parameters:
Name Type Description
certificateName string

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

A string representing the certificate.

matchCertificateRevocationListFromCertificateRevocationListName(certificateRevocationListName) → {string}

Parse the certificate_revocation_list from CertificateRevocationList resource.

Parameters:
Name Type Description
certificateRevocationListName string

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

A string representing the certificate_revocation_list.

matchCertificateTemplateFromCertificateTemplateName(certificateTemplateName) → {string}

Parse the certificate_template from CertificateTemplate resource.

Parameters:
Name Type Description
certificateTemplateName string

A fully-qualified path representing CertificateTemplate resource.
Returns:
Type Description
string

A string representing the certificate_template.

matchLocationFromCaPoolName(caPoolName) → {string}

Parse the location from CaPool resource.

Parameters:
Name Type Description
caPoolName string

A fully-qualified path representing CaPool resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromCertificateAuthorityName(certificateAuthorityName) → {string}

Parse the location from CertificateAuthority resource.

Parameters:
Name Type Description
certificateAuthorityName string

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

A string representing the location.

matchLocationFromCertificateName(certificateName) → {string}

Parse the location from Certificate resource.

Parameters:
Name Type Description
certificateName string

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

A string representing the location.

matchLocationFromCertificateRevocationListName(certificateRevocationListName) → {string}

Parse the location from CertificateRevocationList resource.

Parameters:
Name Type Description
certificateRevocationListName string

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

A string representing the location.

matchLocationFromCertificateTemplateName(certificateTemplateName) → {string}

Parse the location from CertificateTemplate resource.

Parameters:
Name Type Description
certificateTemplateName string

A fully-qualified path representing CertificateTemplate resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

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

A string representing the location.

matchProjectFromCaPoolName(caPoolName) → {string}

Parse the project from CaPool resource.

Parameters:
Name Type Description
caPoolName string

A fully-qualified path representing CaPool resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromCertificateAuthorityName(certificateAuthorityName) → {string}

Parse the project from CertificateAuthority resource.

Parameters:
Name Type Description
certificateAuthorityName string

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

A string representing the project.

matchProjectFromCertificateName(certificateName) → {string}

Parse the project from Certificate resource.

Parameters:
Name Type Description
certificateName string

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

A string representing the project.

matchProjectFromCertificateRevocationListName(certificateRevocationListName) → {string}

Parse the project from CertificateRevocationList resource.

Parameters:
Name Type Description
certificateRevocationListName string

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

A string representing the project.

matchProjectFromCertificateTemplateName(certificateTemplateName) → {string}

Parse the project from CertificateTemplate resource.

Parameters:
Name Type Description
certificateTemplateName string

A fully-qualified path representing CertificateTemplate resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

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

A string representing the project.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

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

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, optionsopt, callbackopt) → {Promise}

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

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.