Class v1.CertificateManagerClient (0.7.2)

API Overview

Certificates Manager API allows customers to see and manage all their TLS certificates.

Certificates Manager API service provides methods to manage certificates, group them into collections, and create serving configuration that can be easily applied to other Cloud resources e.g. Target Proxies.

Data Model

The Certificates Manager service exposes the following resources:

* Certificate that describes a single TLS certificate. * CertificateMap that describes a collection of certificates that can be attached to a target resource. * CertificateMapEntry that describes a single configuration entry that consists of a SNI and a group of certificates. It's a subresource of CertificateMap.

Certificate, CertificateMap and CertificateMapEntry IDs have to fully match the regexp [a-z0-9-]{1,63}. In other words, - only lower case letters, digits, and hyphen are allowed - length of the resource ID has to be in [1,63] range.

Provides methods to manage Cloud Certificate Manager entities. v1

Package

@google-cloud/certificate-manager

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of CertificateManagerClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof gax.fallback

: 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 CertificateManagerClient({fallback: 'rest'}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

certificateManagerStub

certificateManagerStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

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

Parameters
NameDescription
request protos.google.longrunning.CancelOperationRequest

The request object that will be sent.

options gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

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

callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

certificateIssuanceConfigPath(project, location, certificateIssuanceConfig)

certificateIssuanceConfigPath(project: string, location: string, certificateIssuanceConfig: string): string;

Return a fully-qualified certificateIssuanceConfig resource name string.

Parameters
NameDescription
project string
location string
certificateIssuanceConfig string
Returns
TypeDescription
string

{string} Resource name string.

certificateMapEntryPath(project, location, certificateMap, certificateMapEntry)

certificateMapEntryPath(project: string, location: string, certificateMap: string, certificateMapEntry: string): string;

Return a fully-qualified certificateMapEntry resource name string.

Parameters
NameDescription
project string
location string
certificateMap string
certificateMapEntry string
Returns
TypeDescription
string

{string} Resource name string.

certificateMapPath(project, location, certificateMap)

certificateMapPath(project: string, location: string, certificateMap: string): string;

Return a fully-qualified certificateMap resource name string.

Parameters
NameDescription
project string
location string
certificateMap string
Returns
TypeDescription
string

{string} Resource name string.

certificatePath(project, location, certificate)

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

Return a fully-qualified certificate resource name string.

Parameters
NameDescription
project string
location string
certificate string
Returns
TypeDescription
string

{string} Resource name string.

checkCreateCertificateIssuanceConfigProgress(name)

checkCreateCertificateIssuanceConfigProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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 parent resource of the certificate issuance config. Must be
   *  in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate config.
   */
  // const certificateIssuanceConfigId = 'abc123'
  /**
   *  Required. A definition of the certificate issuance config to create.
   */
  // const certificateIssuanceConfig = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificateIssuanceConfig() {
    // Construct request
    const request = {
      parent,
      certificateIssuanceConfigId,
      certificateIssuanceConfig,
    };

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

  callCreateCertificateIssuanceConfig();

checkCreateCertificateMapEntryProgress(name)

checkCreateCertificateMapEntryProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMapEntry, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMapEntry, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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 parent resource of the certificate map entry. Must be in the
   *  format `projects/* /locations/* /certificateMaps/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate map entry.
   */
  // const certificateMapEntryId = 'abc123'
  /**
   *  Required. A definition of the certificate map entry to create.
   */
  // const certificateMapEntry = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificateMapEntry() {
    // Construct request
    const request = {
      parent,
      certificateMapEntryId,
      certificateMapEntry,
    };

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

  callCreateCertificateMapEntry();

checkCreateCertificateMapProgress(name)

checkCreateCertificateMapProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMap, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMap, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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 parent resource of the certificate map. Must be in the format
   *  `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate map.
   */
  // const certificateMapId = 'abc123'
  /**
   *  Required. A definition of the certificate map to create.
   */
  // const certificateMap = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificateMap() {
    // Construct request
    const request = {
      parent,
      certificateMapId,
      certificateMap,
    };

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

  callCreateCertificateMap();

checkCreateCertificateProgress(name)

checkCreateCertificateProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.Certificate, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.Certificate, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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 parent resource of the certificate. Must be in the format
   *  `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate.
   */
  // const certificateId = 'abc123'
  /**
   *  Required. A definition of the certificate to create.
   */
  // const certificate = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificate() {
    // Construct request
    const request = {
      parent,
      certificateId,
      certificate,
    };

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

  callCreateCertificate();

checkCreateDnsAuthorizationProgress(name)

checkCreateDnsAuthorizationProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.DnsAuthorization, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.DnsAuthorization, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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 parent resource of the dns authorization. Must be in the
   *  format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the dns authorization.
   */
  // const dnsAuthorizationId = 'abc123'
  /**
   *  Required. A definition of the dns authorization to create.
   */
  // const dnsAuthorization = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateDnsAuthorization() {
    // Construct request
    const request = {
      parent,
      dnsAuthorizationId,
      dnsAuthorization,
    };

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

  callCreateDnsAuthorization();

checkDeleteCertificateIssuanceConfigProgress(name)

checkDeleteCertificateIssuanceConfigProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A name of the certificate issuance config to delete. Must be in
   *  the format `projects/* /locations/* /certificateIssuanceConfigs/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificateIssuanceConfig();

checkDeleteCertificateMapEntryProgress(name)

checkDeleteCertificateMapEntryProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A name of the certificate map entry to delete. Must be in the
   *  format `projects/* /locations/* /certificateMaps/* /certificateMapEntries/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificateMapEntry();

checkDeleteCertificateMapProgress(name)

checkDeleteCertificateMapProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A name of the certificate map to delete. Must be in the format
   *  `projects/* /locations/* /certificateMaps/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificateMap();

checkDeleteCertificateProgress(name)

checkDeleteCertificateProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A name of the certificate to delete. Must be in the format
   *  `projects/* /locations/* /certificates/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificate();

checkDeleteDnsAuthorizationProgress(name)

checkDeleteDnsAuthorizationProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A name of the dns authorization to delete. Must be in the format
   *  `projects/* /locations/* /dnsAuthorizations/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteDnsAuthorization();

checkUpdateCertificateMapEntryProgress(name)

checkUpdateCertificateMapEntryProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMapEntry, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMapEntry, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A definition of the certificate map entry to create map entry.
   */
  // const certificateMapEntry = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateCertificateMapEntry() {
    // Construct request
    const request = {
      certificateMapEntry,
      updateMask,
    };

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

  callUpdateCertificateMapEntry();

checkUpdateCertificateMapProgress(name)

checkUpdateCertificateMapProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMap, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.CertificateMap, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A definition of the certificate map to update.
   */
  // const certificateMap = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateCertificateMap() {
    // Construct request
    const request = {
      certificateMap,
      updateMask,
    };

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

  callUpdateCertificateMap();

checkUpdateCertificateProgress(name)

checkUpdateCertificateProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.Certificate, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.Certificate, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A definition of the certificate to update.
   */
  // const certificate = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateCertificate() {
    // Construct request
    const request = {
      certificate,
      updateMask,
    };

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

  callUpdateCertificate();

checkUpdateDnsAuthorizationProgress(name)

checkUpdateDnsAuthorizationProgress(name: string): Promise<LROperation<protos.google.cloud.certificatemanager.v1.DnsAuthorization, protos.google.cloud.certificatemanager.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.certificatemanager.v1.DnsAuthorization, protos.google.cloud.certificatemanager.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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. A definition of the dns authorization to update.
   */
  // const dnsAuthorization = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateDnsAuthorization() {
    // Construct request
    const request = {
      dnsAuthorization,
      updateMask,
    };

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

  callUpdateDnsAuthorization();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createCertificate(request, options)

createCertificate(request?: protos.google.cloud.certificatemanager.v1.ICreateCertificateRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Certificate in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 parent resource of the certificate. Must be in the format
   *  `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate.
   */
  // const certificateId = 'abc123'
  /**
   *  Required. A definition of the certificate to create.
   */
  // const certificate = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificate() {
    // Construct request
    const request = {
      parent,
      certificateId,
      certificate,
    };

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

  callCreateCertificate();

createCertificate(request, options, callback)

createCertificate(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCertificate(request, callback)

createCertificate(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCertificateIssuanceConfig(request, options)

createCertificateIssuanceConfig(request?: protos.google.cloud.certificatemanager.v1.ICreateCertificateIssuanceConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new CertificateIssuanceConfig in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateIssuanceConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 parent resource of the certificate issuance config. Must be
   *  in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate config.
   */
  // const certificateIssuanceConfigId = 'abc123'
  /**
   *  Required. A definition of the certificate issuance config to create.
   */
  // const certificateIssuanceConfig = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificateIssuanceConfig() {
    // Construct request
    const request = {
      parent,
      certificateIssuanceConfigId,
      certificateIssuanceConfig,
    };

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

  callCreateCertificateIssuanceConfig();

createCertificateIssuanceConfig(request, options, callback)

createCertificateIssuanceConfig(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateIssuanceConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateIssuanceConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCertificateIssuanceConfig(request, callback)

createCertificateIssuanceConfig(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateIssuanceConfigRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateIssuanceConfigRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCertificateMap(request, options)

createCertificateMap(request?: protos.google.cloud.certificatemanager.v1.ICreateCertificateMapRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new CertificateMap in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateMapRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 parent resource of the certificate map. Must be in the format
   *  `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate map.
   */
  // const certificateMapId = 'abc123'
  /**
   *  Required. A definition of the certificate map to create.
   */
  // const certificateMap = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificateMap() {
    // Construct request
    const request = {
      parent,
      certificateMapId,
      certificateMap,
    };

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

  callCreateCertificateMap();

createCertificateMap(request, options, callback)

createCertificateMap(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateMapRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateMapRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCertificateMap(request, callback)

createCertificateMap(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateMapRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateMapRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCertificateMapEntry(request, options)

createCertificateMapEntry(request?: protos.google.cloud.certificatemanager.v1.ICreateCertificateMapEntryRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new CertificateMapEntry in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateMapEntryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 parent resource of the certificate map entry. Must be in the
   *  format `projects/* /locations/* /certificateMaps/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the certificate map entry.
   */
  // const certificateMapEntryId = 'abc123'
  /**
   *  Required. A definition of the certificate map entry to create.
   */
  // const certificateMapEntry = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateCertificateMapEntry() {
    // Construct request
    const request = {
      parent,
      certificateMapEntryId,
      certificateMapEntry,
    };

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

  callCreateCertificateMapEntry();

createCertificateMapEntry(request, options, callback)

createCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateMapEntryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateMapEntryRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCertificateMapEntry(request, callback)

createCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.ICreateCertificateMapEntryRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateCertificateMapEntryRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createDnsAuthorization(request, options)

createDnsAuthorization(request?: protos.google.cloud.certificatemanager.v1.ICreateDnsAuthorizationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new DnsAuthorization in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateDnsAuthorizationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 parent resource of the dns authorization. Must be in the
   *  format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. A user-provided name of the dns authorization.
   */
  // const dnsAuthorizationId = 'abc123'
  /**
   *  Required. A definition of the dns authorization to create.
   */
  // const dnsAuthorization = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callCreateDnsAuthorization() {
    // Construct request
    const request = {
      parent,
      dnsAuthorizationId,
      dnsAuthorization,
    };

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

  callCreateDnsAuthorization();

createDnsAuthorization(request, options, callback)

createDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.ICreateDnsAuthorizationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateDnsAuthorizationRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createDnsAuthorization(request, callback)

createDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.ICreateDnsAuthorizationRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.ICreateDnsAuthorizationRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificate(request, options)

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

Deletes a single Certificate.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A name of the certificate to delete. Must be in the format
   *  `projects/* /locations/* /certificates/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificate();

deleteCertificate(request, options, callback)

deleteCertificate(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificate(request, callback)

deleteCertificate(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificateIssuanceConfig(request, options)

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

Deletes a single CertificateIssuanceConfig.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateIssuanceConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A name of the certificate issuance config to delete. Must be in
   *  the format `projects/* /locations/* /certificateIssuanceConfigs/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificateIssuanceConfig();

deleteCertificateIssuanceConfig(request, options, callback)

deleteCertificateIssuanceConfig(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateIssuanceConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateIssuanceConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificateIssuanceConfig(request, callback)

deleteCertificateIssuanceConfig(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateIssuanceConfigRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateIssuanceConfigRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificateMap(request, options)

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

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A name of the certificate map to delete. Must be in the format
   *  `projects/* /locations/* /certificateMaps/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificateMap();

deleteCertificateMap(request, options, callback)

deleteCertificateMap(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificateMap(request, callback)

deleteCertificateMap(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificateMapEntry(request, options)

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

Deletes a single CertificateMapEntry.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapEntryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A name of the certificate map entry to delete. Must be in the
   *  format `projects/* /locations/* /certificateMaps/* /certificateMapEntries/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteCertificateMapEntry();

deleteCertificateMapEntry(request, options, callback)

deleteCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapEntryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapEntryRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCertificateMapEntry(request, callback)

deleteCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapEntryRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapEntryRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDnsAuthorization(request, options)

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

Deletes a single DnsAuthorization.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteDnsAuthorizationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A name of the dns authorization to delete. Must be in the format
   *  `projects/* /locations/* /dnsAuthorizations/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callDeleteDnsAuthorization();

deleteDnsAuthorization(request, options, callback)

deleteDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.IDeleteDnsAuthorizationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteDnsAuthorizationRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDnsAuthorization(request, callback)

deleteDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.IDeleteDnsAuthorizationRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IDeleteDnsAuthorizationRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

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

Parameters
NameDescription
request protos.google.longrunning.DeleteOperationRequest

The request object that will be sent.

options gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

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

callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

dnsAuthorizationPath(project, location, dnsAuthorization)

dnsAuthorizationPath(project: string, location: string, dnsAuthorization: string): string;

Return a fully-qualified dnsAuthorization resource name string.

Parameters
NameDescription
project string
location string
dnsAuthorization string
Returns
TypeDescription
string

{string} Resource name string.

getCertificate(request, options)

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

Gets details of a single Certificate.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificate, (protos.google.cloud.certificatemanager.v1.IGetCertificateRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. A name of the certificate to describe. Must be in the format
   *  `projects/* /locations/* /certificates/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

    // Run request
    const response = await certificatemanagerClient.getCertificate(request);
    console.log(response);
  }

  callGetCertificate();

getCertificate(request, options, callback)

getCertificate(request: protos.google.cloud.certificatemanager.v1.IGetCertificateRequest, options: CallOptions, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateRequest
options CallOptions
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IGetCertificateRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCertificate(request, callback)

getCertificate(request: protos.google.cloud.certificatemanager.v1.IGetCertificateRequest, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IGetCertificateRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateRequest
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IGetCertificateRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCertificateIssuanceConfig(request, options)

getCertificateIssuanceConfig(request?: protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig,
        (protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single CertificateIssuanceConfig.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, (protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. A name of the certificate issuance config to describe. Must be in
   *  the format `projects/* /locations/* /certificateIssuanceConfigs/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

    // Run request
    const response = await certificatemanagerClient.getCertificateIssuanceConfig(request);
    console.log(response);
  }

  callGetCertificateIssuanceConfig();

getCertificateIssuanceConfig(request, options, callback)

getCertificateIssuanceConfig(request: protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest
options CallOptions
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCertificateIssuanceConfig(request, callback)

getCertificateIssuanceConfig(request: protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig, protos.google.cloud.certificatemanager.v1.IGetCertificateIssuanceConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCertificateMap(request, options)

getCertificateMap(request?: protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.ICertificateMap,
        (protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single CertificateMap.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificateMap, (protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. A name of the certificate map to describe. Must be in the format
   *  `projects/* /locations/* /certificateMaps/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

    // Run request
    const response = await certificatemanagerClient.getCertificateMap(request);
    console.log(response);
  }

  callGetCertificateMap();

getCertificateMap(request, options, callback)

getCertificateMap(request: protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest, options: CallOptions, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest
options CallOptions
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCertificateMap(request, callback)

getCertificateMap(request: protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCertificateMapEntry(request, options)

getCertificateMapEntry(request?: protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.ICertificateMapEntry,
        (protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single CertificateMapEntry.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, (protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. A name of the certificate map entry to describe. Must be in the
   *  format `projects/* /locations/* /certificateMaps/* /certificateMapEntries/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

    // Run request
    const response = await certificatemanagerClient.getCertificateMapEntry(request);
    console.log(response);
  }

  callGetCertificateMapEntry();

getCertificateMapEntry(request, options, callback)

getCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest, options: CallOptions, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest
options CallOptions
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCertificateMapEntry(request, callback)

getCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest, callback: Callback<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest
callback Callback<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDnsAuthorization(request, options)

getDnsAuthorization(request?: protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.IDnsAuthorization,
        (protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single DnsAuthorization.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.IDnsAuthorization, (protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. A name of the dns authorization to describe. Must be in the
   *  format `projects/* /locations/* /dnsAuthorizations/*`.
   */
  // const name = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

    // Run request
    const response = await certificatemanagerClient.getDnsAuthorization(request);
    console.log(response);
  }

  callGetDnsAuthorization();

getDnsAuthorization(request, options, callback)

getDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest, options: CallOptions, callback: Callback<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest
options CallOptions
callback Callback<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDnsAuthorization(request, callback)

getDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest, callback: Callback<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest
callback Callback<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getLocation(request, options, callback)

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

Gets information about a location.

Parameters
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<LocationProtos.google.cloud.location.ILocation>

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

Example

const [response] = await client.getLocation(request);

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

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
NameDescription
request protos.google.longrunning.GetOperationRequest

The request object that will be sent.

options gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

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

callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

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

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listCertificateIssuanceConfigs(request, options)

listCertificateIssuanceConfigs(request?: protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig[],
        protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest | null,
        protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsResponse
    ]>;

Lists CertificateIssuanceConfigs in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig[], protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest | null, protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCertificateIssuanceConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateIssuanceConfigs(request, options, callback)

listCertificateIssuanceConfigs(request: protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig>
Returns
TypeDescription
void

listCertificateIssuanceConfigs(request, callback)

listCertificateIssuanceConfigs(request: protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig>
Returns
TypeDescription
void

listCertificateIssuanceConfigsAsync(request, options)

listCertificateIssuanceConfigsAsync(request?: protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig>;

Equivalent to listCertificateIssuanceConfigs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificateIssuanceConfig>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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 project and location from which the certificate should be
   *  listed, specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of certificate configs to return per call.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListCertificateIssuanceConfigsResponse`.
   *  Indicates that this is a continuation of a prior
   *  `ListCertificateIssuanceConfigs` call, and that the system should return
   *  the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  Filter expression to restrict the Certificates Configs returned.
   */
  // const filter = 'abc123'
  /**
   *  A list of Certificate Config field names used to specify the order of the
   *  returned results. The default sorting order is ascending. To specify
   *  descending order for a field, add a suffix " desc".
   */
  // const orderBy = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callListCertificateIssuanceConfigs();

listCertificateIssuanceConfigsStream(request, options)

listCertificateIssuanceConfigsStream(request?: protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateIssuanceConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateIssuanceConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateMapEntries(request, options)

listCertificateMapEntries(request?: protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.ICertificateMapEntry[],
        protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest | null,
        protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesResponse
    ]>;

Lists CertificateMapEntries in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificateMapEntry[], protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest | null, protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCertificateMapEntriesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateMapEntries(request, options, callback)

listCertificateMapEntries(request: protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMapEntry>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMapEntry>
Returns
TypeDescription
void

listCertificateMapEntries(request, callback)

listCertificateMapEntries(request: protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMapEntry>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMapEntry>
Returns
TypeDescription
void

listCertificateMapEntriesAsync(request, options)

listCertificateMapEntriesAsync(request?: protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry>;

Equivalent to listCertificateMapEntries, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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 project, location and certificate map from which the
   *  certificate map entries should be listed, specified in the format
   *  `projects/* /locations/* /certificateMaps/*`.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of certificate map entries to return. The service may return
   *  fewer than this value.
   *  If unspecified, at most 50 certificate map entries will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListCertificateMapEntriesResponse`.
   *  Indicates that this is a continuation of a prior
   *  `ListCertificateMapEntries` call, and that the system should return the
   *  next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  Filter expression to restrict the returned Certificate Map Entries.
   */
  // const filter = 'abc123'
  /**
   *  A list of Certificate Map Entry field names used to specify
   *  the order of the returned results. The default sorting order is ascending.
   *  To specify descending order for a field, add a suffix " desc".
   */
  // const orderBy = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callListCertificateMapEntries();

listCertificateMapEntriesStream(request, options)

listCertificateMapEntriesStream(request?: protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateMapEntriesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateMaps(request, options)

listCertificateMaps(request?: protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.ICertificateMap[],
        protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest | null,
        protos.google.cloud.certificatemanager.v1.IListCertificateMapsResponse
    ]>;

Lists CertificateMaps in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificateMap[], protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest | null, protos.google.cloud.certificatemanager.v1.IListCertificateMapsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCertificateMapsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificateMaps(request, options, callback)

listCertificateMaps(request: protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMap>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMap>
Returns
TypeDescription
void

listCertificateMaps(request, callback)

listCertificateMaps(request: protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMap>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, protos.google.cloud.certificatemanager.v1.IListCertificateMapsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificateMap>
Returns
TypeDescription
void

listCertificateMapsAsync(request, options)

listCertificateMapsAsync(request?: protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificateMap>;

Equivalent to listCertificateMaps, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificateMap>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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 project and location from which the certificate maps should
   *  be listed, specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of certificate maps to return per call.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListCertificateMapsResponse`. Indicates
   *  that this is a continuation of a prior `ListCertificateMaps` call, and that
   *  the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  Filter expression to restrict the Certificates Maps returned.
   */
  // const filter = 'abc123'
  /**
   *  A list of Certificate Map field names used to specify the order of the
   *  returned results. The default sorting order is ascending. To specify
   *  descending order for a field, add a suffix " desc".
   */
  // const orderBy = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callListCertificateMaps();

listCertificateMapsStream(request, options)

listCertificateMapsStream(request?: protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificateMapsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificates(request, options)

listCertificates(request?: protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.ICertificate[],
        protos.google.cloud.certificatemanager.v1.IListCertificatesRequest | null,
        protos.google.cloud.certificatemanager.v1.IListCertificatesResponse
    ]>;

Lists Certificates in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificatesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.ICertificate[], protos.google.cloud.certificatemanager.v1.IListCertificatesRequest | null, protos.google.cloud.certificatemanager.v1.IListCertificatesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCertificatesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCertificates(request, options, callback)

listCertificates(request: protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, protos.google.cloud.certificatemanager.v1.IListCertificatesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificate>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificatesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, protos.google.cloud.certificatemanager.v1.IListCertificatesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificate>
Returns
TypeDescription
void

listCertificates(request, callback)

listCertificates(request: protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, protos.google.cloud.certificatemanager.v1.IListCertificatesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificate>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificatesRequest
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, protos.google.cloud.certificatemanager.v1.IListCertificatesResponse | null | undefined, protos.google.cloud.certificatemanager.v1.ICertificate>
Returns
TypeDescription
void

listCertificatesAsync(request, options)

listCertificatesAsync(request?: protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificate>;

Equivalent to listCertificates, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificatesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.certificatemanager.v1.ICertificate>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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 project and location from which the certificate should be
   *  listed, specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of certificates to return per call.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListCertificatesResponse`. Indicates that
   *  this is a continuation of a prior `ListCertificates` call, and that the
   *  system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  Filter expression to restrict the Certificates returned.
   */
  // const filter = 'abc123'
  /**
   *  A list of Certificate field names used to specify the order of the returned
   *  results. The default sorting order is ascending. To specify descending
   *  order for a field, add a suffix " desc".
   */
  // const orderBy = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callListCertificates();

listCertificatesStream(request, options)

listCertificatesStream(request?: protos.google.cloud.certificatemanager.v1.IListCertificatesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListCertificatesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificatesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDnsAuthorizations(request, options)

listDnsAuthorizations(request?: protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.certificatemanager.v1.IDnsAuthorization[],
        protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest | null,
        protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsResponse
    ]>;

Lists DnsAuthorizations in a given project and location.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.certificatemanager.v1.IDnsAuthorization[], protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest | null, protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDnsAuthorizationsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDnsAuthorizations(request, options, callback)

listDnsAuthorizations(request: protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.IDnsAuthorization>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.IDnsAuthorization>
Returns
TypeDescription
void

listDnsAuthorizations(request, callback)

listDnsAuthorizations(request: protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, callback: PaginationCallback<protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.IDnsAuthorization>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest
callback PaginationCallback<protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsResponse | null | undefined, protos.google.cloud.certificatemanager.v1.IDnsAuthorization>
Returns
TypeDescription
void

listDnsAuthorizationsAsync(request, options)

listDnsAuthorizationsAsync(request?: protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.certificatemanager.v1.IDnsAuthorization>;

Equivalent to listDnsAuthorizations, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.certificatemanager.v1.IDnsAuthorization>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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 project and location from which the dns authorizations should
   *  be listed, specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of dns authorizations to return per call.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListDnsAuthorizationsResponse`. Indicates
   *  that this is a continuation of a prior `ListDnsAuthorizations` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  Filter expression to restrict the Dns Authorizations returned.
   */
  // const filter = 'abc123'
  /**
   *  A list of Dns Authorization field names used to specify the order of the
   *  returned results. The default sorting order is ascending. To specify
   *  descending order for a field, add a suffix " desc".
   */
  // const orderBy = 'abc123'

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

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

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

  callListDnsAuthorizations();

listDnsAuthorizationsStream(request, options)

listDnsAuthorizationsStream(request?: protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDnsAuthorizationsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listLocationsAsync(request, options)

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

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

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

Parameters
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

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
NameDescription
request protos.google.longrunning.ListOperationsRequest

The request object that will be sent.

options gax.CallOptions

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

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{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)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchCertificateFromCertificateName(certificateName)

matchCertificateFromCertificateName(certificateName: string): string | number;

Parse the certificate from Certificate resource.

Parameter
NameDescription
certificateName string

A fully-qualified path representing Certificate resource.

Returns
TypeDescription
string | number

{string} A string representing the certificate.

matchCertificateIssuanceConfigFromCertificateIssuanceConfigName(certificateIssuanceConfigName)

matchCertificateIssuanceConfigFromCertificateIssuanceConfigName(certificateIssuanceConfigName: string): string | number;

Parse the certificate_issuance_config from CertificateIssuanceConfig resource.

Parameter
NameDescription
certificateIssuanceConfigName string

A fully-qualified path representing CertificateIssuanceConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the certificate_issuance_config.

matchCertificateMapEntryFromCertificateMapEntryName(certificateMapEntryName)

matchCertificateMapEntryFromCertificateMapEntryName(certificateMapEntryName: string): string | number;

Parse the certificate_map_entry from CertificateMapEntry resource.

Parameter
NameDescription
certificateMapEntryName string

A fully-qualified path representing CertificateMapEntry resource.

Returns
TypeDescription
string | number

{string} A string representing the certificate_map_entry.

matchCertificateMapFromCertificateMapEntryName(certificateMapEntryName)

matchCertificateMapFromCertificateMapEntryName(certificateMapEntryName: string): string | number;

Parse the certificate_map from CertificateMapEntry resource.

Parameter
NameDescription
certificateMapEntryName string

A fully-qualified path representing CertificateMapEntry resource.

Returns
TypeDescription
string | number

{string} A string representing the certificate_map.

matchCertificateMapFromCertificateMapName(certificateMapName)

matchCertificateMapFromCertificateMapName(certificateMapName: string): string | number;

Parse the certificate_map from CertificateMap resource.

Parameter
NameDescription
certificateMapName string

A fully-qualified path representing CertificateMap resource.

Returns
TypeDescription
string | number

{string} A string representing the certificate_map.

matchDnsAuthorizationFromDnsAuthorizationName(dnsAuthorizationName)

matchDnsAuthorizationFromDnsAuthorizationName(dnsAuthorizationName: string): string | number;

Parse the dns_authorization from DnsAuthorization resource.

Parameter
NameDescription
dnsAuthorizationName string

A fully-qualified path representing DnsAuthorization resource.

Returns
TypeDescription
string | number

{string} A string representing the dns_authorization.

matchLocationFromCertificateIssuanceConfigName(certificateIssuanceConfigName)

matchLocationFromCertificateIssuanceConfigName(certificateIssuanceConfigName: string): string | number;

Parse the location from CertificateIssuanceConfig resource.

Parameter
NameDescription
certificateIssuanceConfigName string

A fully-qualified path representing CertificateIssuanceConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCertificateMapEntryName(certificateMapEntryName)

matchLocationFromCertificateMapEntryName(certificateMapEntryName: string): string | number;

Parse the location from CertificateMapEntry resource.

Parameter
NameDescription
certificateMapEntryName string

A fully-qualified path representing CertificateMapEntry resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCertificateMapName(certificateMapName)

matchLocationFromCertificateMapName(certificateMapName: string): string | number;

Parse the location from CertificateMap resource.

Parameter
NameDescription
certificateMapName string

A fully-qualified path representing CertificateMap resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCertificateName(certificateName)

matchLocationFromCertificateName(certificateName: string): string | number;

Parse the location from Certificate resource.

Parameter
NameDescription
certificateName string

A fully-qualified path representing Certificate resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDnsAuthorizationName(dnsAuthorizationName)

matchLocationFromDnsAuthorizationName(dnsAuthorizationName: string): string | number;

Parse the location from DnsAuthorization resource.

Parameter
NameDescription
dnsAuthorizationName string

A fully-qualified path representing DnsAuthorization resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromCertificateIssuanceConfigName(certificateIssuanceConfigName)

matchProjectFromCertificateIssuanceConfigName(certificateIssuanceConfigName: string): string | number;

Parse the project from CertificateIssuanceConfig resource.

Parameter
NameDescription
certificateIssuanceConfigName string

A fully-qualified path representing CertificateIssuanceConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCertificateMapEntryName(certificateMapEntryName)

matchProjectFromCertificateMapEntryName(certificateMapEntryName: string): string | number;

Parse the project from CertificateMapEntry resource.

Parameter
NameDescription
certificateMapEntryName string

A fully-qualified path representing CertificateMapEntry resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCertificateMapName(certificateMapName)

matchProjectFromCertificateMapName(certificateMapName: string): string | number;

Parse the project from CertificateMap resource.

Parameter
NameDescription
certificateMapName string

A fully-qualified path representing CertificateMap resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCertificateName(certificateName)

matchProjectFromCertificateName(certificateName: string): string | number;

Parse the project from Certificate resource.

Parameter
NameDescription
certificateName string

A fully-qualified path representing Certificate resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDnsAuthorizationName(dnsAuthorizationName)

matchProjectFromDnsAuthorizationName(dnsAuthorizationName: string): string | number;

Parse the project from DnsAuthorization resource.

Parameter
NameDescription
dnsAuthorizationName string

A fully-qualified path representing DnsAuthorization resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

updateCertificate(request, options)

updateCertificate(request?: protos.google.cloud.certificatemanager.v1.IUpdateCertificateRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a Certificate.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A definition of the certificate to update.
   */
  // const certificate = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateCertificate() {
    // Construct request
    const request = {
      certificate,
      updateMask,
    };

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

  callUpdateCertificate();

updateCertificate(request, options, callback)

updateCertificate(request: protos.google.cloud.certificatemanager.v1.IUpdateCertificateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCertificate(request, callback)

updateCertificate(request: protos.google.cloud.certificatemanager.v1.IUpdateCertificateRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificate, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCertificateMap(request, options)

updateCertificateMap(request?: protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a CertificateMap.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A definition of the certificate map to update.
   */
  // const certificateMap = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateCertificateMap() {
    // Construct request
    const request = {
      certificateMap,
      updateMask,
    };

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

  callUpdateCertificateMap();

updateCertificateMap(request, options, callback)

updateCertificateMap(request: protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCertificateMap(request, callback)

updateCertificateMap(request: protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMap, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCertificateMapEntry(request, options)

updateCertificateMapEntry(request?: protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapEntryRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a CertificateMapEntry.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapEntryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A definition of the certificate map entry to create map entry.
   */
  // const certificateMapEntry = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateCertificateMapEntry() {
    // Construct request
    const request = {
      certificateMapEntry,
      updateMask,
    };

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

  callUpdateCertificateMapEntry();

updateCertificateMapEntry(request, options, callback)

updateCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapEntryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapEntryRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCertificateMapEntry(request, callback)

updateCertificateMapEntry(request: protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapEntryRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapEntryRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.ICertificateMapEntry, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDnsAuthorization(request, options)

updateDnsAuthorization(request?: protos.google.cloud.certificatemanager.v1.IUpdateDnsAuthorizationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a DnsAuthorization.

Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateDnsAuthorizationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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. A definition of the dns authorization to update.
   */
  // const dnsAuthorization = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask`
   *  definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const updateMask = {}

  // Imports the Certificatemanager library
  const {CertificateManagerClient} = require('@google-cloud/certificate-manager').v1;

  // Instantiates a client
  const certificatemanagerClient = new CertificateManagerClient();

  async function callUpdateDnsAuthorization() {
    // Construct request
    const request = {
      dnsAuthorization,
      updateMask,
    };

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

  callUpdateDnsAuthorization();

updateDnsAuthorization(request, options, callback)

updateDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.IUpdateDnsAuthorizationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateDnsAuthorizationRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDnsAuthorization(request, callback)

updateDnsAuthorization(request: protos.google.cloud.certificatemanager.v1.IUpdateDnsAuthorizationRequest, callback: Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.certificatemanager.v1.IUpdateDnsAuthorizationRequest
callback Callback<LROperation<protos.google.cloud.certificatemanager.v1.IDnsAuthorization, protos.google.cloud.certificatemanager.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void