CertificateAuthorityServiceClient

Constructor

new CertificateAuthorityServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of CertificateAuthorityServiceClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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

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

Return a fully-qualified certificateAuthority resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`certificate_authority`	string

Returns:

Type	Description
string	Resource name string.

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

Return a fully-qualified certificate resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`certificate_authority`	string
`certificate`	string

Returns:

Type	Description
string	Resource name string.

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

Return a fully-qualified certificateRevocationList resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`certificate_authority`	string
`certificate_revocation_list`	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.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();

(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 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();

(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.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();

(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.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();

(async) checkRestoreCertificateAuthorityProgress(name) → {Promise}

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

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.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();

(async) checkScheduleDeleteCertificateAuthorityProgress(name) → {Promise}

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

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.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();

(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.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();

(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.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() → {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.

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.

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 location associated with the CertificateAuthorities, in the format `projects/* /locations/*`.
`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

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 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, 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 CertificateAuthorities, in the format `projects/* /locations/*`.
`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

Call options. See CallOptions for more details.

Returns:

Type Description

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.

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/* /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

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.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, 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/* /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

Call options. See CallOptions for more details.

Returns:

Type Description

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.

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.

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/* /certificateauthorities/*`.
`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

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.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, 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/* /certificateauthorities/*`.
`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

Call options. See CallOptions for more details.

Returns:

Type Description

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.

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.

listReusableConfigsAsync(request, optionsopt) → {Object}

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 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 ReusableConfigs, in the format `projects/* /locations/*`.
`pageSize`	number	<optional>	Optional. Limit on the number of ReusableConfigs to include in the response. Further ReusableConfigs can subsequently be obtained by including the ListReusableConfigsResponse.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 ListReusableConfigsResponse.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

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 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.

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
   *  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, 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 ReusableConfigs, in the format `projects/* /locations/*`.
`pageSize`	number	<optional>	Optional. Limit on the number of ReusableConfigs to include in the response. Further ReusableConfigs can subsequently be obtained by including the ListReusableConfigsResponse.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 ListReusableConfigsResponse.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

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

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

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.

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.

matchCertificateAuthorityFromCertificateName(certificateName) → {string}

Parse the certificate_authority 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_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.

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.

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.

matchLocationFromReusableConfigName(reusableConfigName) → {string}

Parse the location from ReusableConfig resource.

Parameters:

Name	Type	Description
`reusableConfigName`	string	A fully-qualified path representing ReusableConfig resource.

Returns:

Type	Description
string	A string representing the location.

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.

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.

matchProjectFromReusableConfigName(reusableConfigName) → {string}

Parse the project from ReusableConfig resource.

Parameters:

Name	Type	Description
`reusableConfigName`	string	A fully-qualified path representing ReusableConfig resource.

Returns:

Type	Description
string	A string representing the project.

matchReusableConfigFromReusableConfigName(reusableConfigName) → {string}

Parse the reusable_config from ReusableConfig resource.

Parameters:

Name	Type	Description
`reusableConfigName`	string	A fully-qualified path representing ReusableConfig resource.

Returns:

Type	Description
string	A string representing the reusable_config.

reusableConfigPath(project, location, reusable_config) → {string}

Return a fully-qualified reusableConfig resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`reusable_config`	string

Returns:

Type	Description
string	Resource name string.