Class v1.CertificateManagerClient (0.1.0)

Version 0.1.0

• 0.7.2 (latest)
• 0.7.1
• 0.6.2
• 0.5.0
• 0.1.0

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 which describes a single TLS certificate. * CertificateMap which describes a collection of certificates that can be attached to a target resource. * CertificateMapEntry which 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 match "^[a-z0-9-]{1,63}$" regexp, which means that - 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)

constructor(opts?: ClientOptions);

Construct an instance of CertificateManagerClient.

Parameter

Name	Description
opts	ClientOptions

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;
    };

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

certificateMapEntryPath(project, location, certificateMap, certificateMapEntry)

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

Return a fully-qualified certificateMapEntry resource name string.

Parameters

Name	Description
project	string
location	string
certificateMap	string
certificateMapEntry	string

Returns

Type	Description
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

Name	Description
project	string
location	string
certificateMap	string

Returns

Type	Description
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

Name	Description
project	string
location	string
certificate	string

Returns

Type	Description
string	{string} Resource name string.

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Name	Description
name	string The operation name that will be passed.

Returns

Type	Description
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

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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.ICreateCertificateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.ICreateCertificateMapRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.ICreateCertificateMapEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.ICreateDnsAuthorizationRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IDeleteCertificateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IDeleteCertificateMapEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IDeleteDnsAuthorizationRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
void

dnsAuthorizationPath(project, location, dnsAuthorization)

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

Return a fully-qualified dnsAuthorization resource name string.

Parameters

Name	Description
project	string
location	string
dnsAuthorization	string

Returns

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IGetCertificateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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 [Certificate]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IGetCertificateMapRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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 [CertificateMap]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IGetCertificateMapEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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 [CertificateMapEntry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IGetDnsAuthorizationRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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 [DnsAuthorization]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	Callback<string, undefined, undefined>

Returns

Type	Description
void

initialize()

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

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

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

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [CertificateMapEntry]. 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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [CertificateMapEntry]. 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

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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificateMapEntriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [CertificateMapEntry] 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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [CertificateMap]. 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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [CertificateMap]. 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

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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificateMapsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [CertificateMap] 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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificatesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [Certificate]. 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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificatesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [Certificate]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListCertificatesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [Certificate] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCertificatesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [DnsAuthorization]. 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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

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 [DnsAuthorization]. 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

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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IListDnsAuthorizationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [DnsAuthorization] 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.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	string
location	string

Returns

Type	Description
string	{string} Resource name string.

matchCertificateFromCertificateName(certificateName)

matchCertificateFromCertificateName(certificateName: string): string | number;

Parse the certificate from Certificate resource.

Parameter

Name	Description
certificateName	string A fully-qualified path representing Certificate resource.

Returns

Type	Description
string | number	{string} A string representing the certificate.

matchCertificateMapEntryFromCertificateMapEntryName(certificateMapEntryName)

matchCertificateMapEntryFromCertificateMapEntryName(certificateMapEntryName: string): string | number;

Parse the certificate_map_entry from CertificateMapEntry resource.

Parameter

Name	Description
certificateMapEntryName	string A fully-qualified path representing CertificateMapEntry resource.

Returns

Type	Description
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

Name	Description
certificateMapEntryName	string A fully-qualified path representing CertificateMapEntry resource.

Returns

Type	Description
string | number	{string} A string representing the certificate_map.

matchCertificateMapFromCertificateMapName(certificateMapName)

matchCertificateMapFromCertificateMapName(certificateMapName: string): string | number;

Parse the certificate_map from CertificateMap resource.

Parameter

Name	Description
certificateMapName	string A fully-qualified path representing CertificateMap resource.

Returns

Type	Description
string | number	{string} A string representing the certificate_map.

matchDnsAuthorizationFromDnsAuthorizationName(dnsAuthorizationName)

matchDnsAuthorizationFromDnsAuthorizationName(dnsAuthorizationName: string): string | number;

Parse the dns_authorization from DnsAuthorization resource.

Parameter

Name	Description
dnsAuthorizationName	string A fully-qualified path representing DnsAuthorization resource.

Returns

Type	Description
string | number	{string} A string representing the dns_authorization.

matchLocationFromCertificateMapEntryName(certificateMapEntryName)

matchLocationFromCertificateMapEntryName(certificateMapEntryName: string): string | number;

Parse the location from CertificateMapEntry resource.

Parameter

Name	Description
certificateMapEntryName	string A fully-qualified path representing CertificateMapEntry resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromCertificateMapName(certificateMapName)

matchLocationFromCertificateMapName(certificateMapName: string): string | number;

Parse the location from CertificateMap resource.

Parameter

Name	Description
certificateMapName	string A fully-qualified path representing CertificateMap resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromCertificateName(certificateName)

matchLocationFromCertificateName(certificateName: string): string | number;

Parse the location from Certificate resource.

Parameter

Name	Description
certificateName	string A fully-qualified path representing Certificate resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromDnsAuthorizationName(dnsAuthorizationName)

matchLocationFromDnsAuthorizationName(dnsAuthorizationName: string): string | number;

Parse the location from DnsAuthorization resource.

Parameter

Name	Description
dnsAuthorizationName	string A fully-qualified path representing DnsAuthorization resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	string A fully-qualified path representing Location resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchProjectFromCertificateMapEntryName(certificateMapEntryName)

matchProjectFromCertificateMapEntryName(certificateMapEntryName: string): string | number;

Parse the project from CertificateMapEntry resource.

Parameter

Name	Description
certificateMapEntryName	string A fully-qualified path representing CertificateMapEntry resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromCertificateMapName(certificateMapName)

matchProjectFromCertificateMapName(certificateMapName: string): string | number;

Parse the project from CertificateMap resource.

Parameter

Name	Description
certificateMapName	string A fully-qualified path representing CertificateMap resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromCertificateName(certificateName)

matchProjectFromCertificateName(certificateName: string): string | number;

Parse the project from Certificate resource.

Parameter

Name	Description
certificateName	string A fully-qualified path representing Certificate resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromDnsAuthorizationName(dnsAuthorizationName)

matchProjectFromDnsAuthorizationName(dnsAuthorizationName: string): string | number;

Parse the project from DnsAuthorization resource.

Parameter

Name	Description
dnsAuthorizationName	string A fully-qualified path representing DnsAuthorization resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	string A fully-qualified path representing Location resource.

Returns

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IUpdateCertificateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IUpdateCertificateMapEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
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

Name	Description
request	protos.google.cloud.certificatemanager.v1.IUpdateDnsAuthorizationRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
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

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

Name	Description
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

Type	Description
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

Name	Description
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

Type	Description
void