Class v1.ConfigClient (0.12.0)

0.12.0 (latest) 0.7.0 0.5.0 0.2.0 0.1.1

Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources. v1

Package

@google-cloud/config

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of ConfigClient.

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

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

configStub

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

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

autoMigrationConfigPath(project, location)

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

Return a fully-qualified autoMigrationConfig resource name string.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	{string} Resource name string.

cancelOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name	Description
request	CancelOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback	Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

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

checkCreateDeploymentGroupProgress(name)

checkCreateDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Deployment Group is created. The
   *  parent value is in the format: 'projects/{project_id}/locations/{location}'
   */
  // const parent = 'abc123'
  /**
   *  Required. The deployment group ID.
   */
  // const deploymentGroupId = 'abc123'
  /**
   *  Required. Deployment Group   resource to create
   */
  // const deploymentGroup = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callCreateDeploymentGroup() {
    // Construct request
    const request = {
      parent,
      deploymentGroupId,
      deploymentGroup,
    };

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

  callCreateDeploymentGroup();

checkCreateDeploymentProgress(name)

checkCreateDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Deployment is created. The parent
   *  value is in the format: 'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Deployment ID.
   */
  // const deploymentId = 'abc123'
  /**
   *  Required. Deployment google.cloud.config.v1.Deployment  resource to be
   *  created.
   */
  // const deployment = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callCreateDeployment() {
    // Construct request
    const request = {
      parent,
      deploymentId,
      deployment,
    };

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

  callCreateDeployment();

checkCreatePreviewProgress(name)

checkCreatePreviewProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.Preview, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.Preview, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Preview is created. The parent
   *  value is in the format: 'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The preview ID.
   */
  // const previewId = 'abc123'
  /**
   *  Required. Preview google.cloud.config.v1.Preview  resource to be created.
   */
  // const preview = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callCreatePreview();

checkDeleteDeploymentGroupProgress(name)

checkDeleteDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of DeploymentGroup in the format
   *  projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup}
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, any revisions for this deployment group will also
   *  be deleted. (Otherwise, the request will only work if the deployment group
   *  has no revisions.)
   */
  // const force = true
  /**
   *  Optional. Policy on how to handle referenced deployments when deleting the
   *  DeploymentGroup.
   *  If unspecified, the default behavior is to fail the deletion if any
   *  deployments currently referenced in the `deployment_units` of the
   *  DeploymentGroup or in the latest revision are not deleted.
   */
  // const deploymentReferencePolicy = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeleteDeploymentGroup();

checkDeleteDeploymentProgress(name)

checkDeleteDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, any revisions for this deployment will also be
   *  deleted. (Otherwise, the request will only work if the deployment has no
   *  revisions.)
   */
  // const force = true
  /**
   *  Optional. Policy on how resources actuated by the deployment should be
   *  deleted. If unspecified, the default behavior is to delete the underlying
   *  resources.
   */
  // const deletePolicy = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeleteDeployment();

checkDeletePreviewProgress(name)

checkDeletePreviewProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.Preview, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.Preview, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Preview in the format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeletePreview();

checkDeprovisionDeploymentGroupProgress(name)

checkDeprovisionDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment group to deprovision.
   *  Format:
   *  'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. If set to true, this option is propagated to the deletion of each
   *  deployment in the group. This corresponds to the 'force' field
   *  in DeleteDeploymentRequest.
   */
  // const force = true
  /**
   *  Optional. Policy on how resources within each deployment should be handled
   *  during deletion. This policy is applied globally to the deletion of all
   *  deployments in this group. This corresponds to the 'delete_policy' field
   *  in DeleteDeploymentRequest.
   */
  // const deletePolicy = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeprovisionDeploymentGroup();

checkLockDeploymentProgress(name)

checkLockDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callLockDeployment();

checkProvisionDeploymentGroupProgress(name)

checkProvisionDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment group to provision.
   *  Format:
   *  'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. The deployment specs of the deployment units to be created within
   *  the same project and location of the deployment group. The key is the unit
   *  ID, and the value is the `DeploymentSpec`. Provisioning will fail if a
   *  `deployment_spec` has a `deployment_id` that matches an existing deployment
   *  in the same project and location. If an existing deployment was part of the
   *  last successful revision but is no longer in the current DeploymentGroup's
   *  `deployment_units`, it will be recreated if included in `deployment_specs`.
   */
  // const deploymentSpecs = [1,2,3,4]

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callProvisionDeploymentGroup();

checkUnlockDeploymentProgress(name)

checkUnlockDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'
  /**
   *  Required. Lock ID of the lock file to be unlocked.
   */
  // const lockId = 1234

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callUnlockDeployment();

checkUpdateAutoMigrationConfigProgress(name)

checkUpdateAutoMigrationConfigProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.AutoMigrationConfig, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.AutoMigrationConfig, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. The update mask applies to the resource. See
   *  google.protobuf.FieldMask google.protobuf.FieldMask.
   */
  // const updateMask = {}
  /**
   *  Required. The AutoMigrationConfig to update.
   */
  // const autoMigrationConfig = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callUpdateAutoMigrationConfig() {
    // Construct request
    const request = {
      autoMigrationConfig,
    };

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

  callUpdateAutoMigrationConfig();

checkUpdateDeploymentGroupProgress(name)

checkUpdateDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.DeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Field mask used to specify the fields to be overwritten in the
   *  Deployment Group resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. DeploymentGroup google.cloud.config.v1.DeploymentGroup  to
   *  update.
   *  The deployment group's `name` field is used to identify the resource to be
   *  updated. Format:
   *  `projects/{project}/locations/{location}/deploymentGroups/{deployment_group_id}`
   */
  // const deploymentGroup = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callUpdateDeploymentGroup() {
    // Construct request
    const request = {
      deploymentGroup,
    };

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

  callUpdateDeploymentGroup();

checkUpdateDeploymentProgress(name)

checkUpdateDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.config.v1.Deployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Field mask used to specify the fields to be overwritten in the
   *  Deployment resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. Deployment google.cloud.config.v1.Deployment  to update.
   *  The deployment's `name` field is used to identify the resource to be
   *  updated. Format:
   *  `projects/{project}/locations/{location}/deployments/{deployment}`
   */
  // const deployment = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callUpdateDeployment() {
    // Construct request
    const request = {
      deployment,
    };

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

  callUpdateDeployment();

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.

createDeployment(request, options)

createDeployment(request?: protos.google.cloud.config.v1.ICreateDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a .

Parameters
Name	Description
request	ICreateDeploymentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Deployment is created. The parent
   *  value is in the format: 'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Deployment ID.
   */
  // const deploymentId = 'abc123'
  /**
   *  Required. Deployment google.cloud.config.v1.Deployment  resource to be
   *  created.
   */
  // const deployment = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callCreateDeployment() {
    // Construct request
    const request = {
      parent,
      deploymentId,
      deployment,
    };

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

  callCreateDeployment();

createDeployment(request, options, callback)

createDeployment(request: protos.google.cloud.config.v1.ICreateDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateDeploymentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createDeployment(request, callback)

createDeployment(request: protos.google.cloud.config.v1.ICreateDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateDeploymentRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createDeploymentGroup(request, options)

createDeploymentGroup(request?: protos.google.cloud.config.v1.ICreateDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a The newly created DeploymentGroup will be in the CREATING state and can be retrieved via Get and List calls.

Parameters
Name	Description
request	ICreateDeploymentGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Deployment Group is created. The
   *  parent value is in the format: 'projects/{project_id}/locations/{location}'
   */
  // const parent = 'abc123'
  /**
   *  Required. The deployment group ID.
   */
  // const deploymentGroupId = 'abc123'
  /**
   *  Required. Deployment Group   resource to create
   */
  // const deploymentGroup = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callCreateDeploymentGroup() {
    // Construct request
    const request = {
      parent,
      deploymentGroupId,
      deploymentGroup,
    };

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

  callCreateDeploymentGroup();

createDeploymentGroup(request, options, callback)

createDeploymentGroup(request: protos.google.cloud.config.v1.ICreateDeploymentGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateDeploymentGroupRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createDeploymentGroup(request, callback)

createDeploymentGroup(request: protos.google.cloud.config.v1.ICreateDeploymentGroupRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateDeploymentGroupRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createPreview(request, options)

createPreview(request?: protos.google.cloud.config.v1.ICreatePreviewRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a .

Parameters
Name	Description
request	ICreatePreviewRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Preview is created. The parent
   *  value is in the format: 'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The preview ID.
   */
  // const previewId = 'abc123'
  /**
   *  Required. Preview google.cloud.config.v1.Preview  resource to be created.
   */
  // const preview = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callCreatePreview();

createPreview(request, options, callback)

createPreview(request: protos.google.cloud.config.v1.ICreatePreviewRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreatePreviewRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createPreview(request, callback)

createPreview(request: protos.google.cloud.config.v1.ICreatePreviewRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreatePreviewRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteDeployment(request, options)

deleteDeployment(request?: protos.google.cloud.config.v1.IDeleteDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a .

Parameters
Name	Description
request	IDeleteDeploymentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, any revisions for this deployment will also be
   *  deleted. (Otherwise, the request will only work if the deployment has no
   *  revisions.)
   */
  // const force = true
  /**
   *  Optional. Policy on how resources actuated by the deployment should be
   *  deleted. If unspecified, the default behavior is to delete the underlying
   *  resources.
   */
  // const deletePolicy = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeleteDeployment();

deleteDeployment(request, options, callback)

deleteDeployment(request: protos.google.cloud.config.v1.IDeleteDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteDeploymentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteDeployment(request, callback)

deleteDeployment(request: protos.google.cloud.config.v1.IDeleteDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteDeploymentRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteDeploymentGroup(request, options)

deleteDeploymentGroup(request?: protos.google.cloud.config.v1.IDeleteDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a

Parameters
Name	Description
request	IDeleteDeploymentGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of DeploymentGroup in the format
   *  projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup}
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, any revisions for this deployment group will also
   *  be deleted. (Otherwise, the request will only work if the deployment group
   *  has no revisions.)
   */
  // const force = true
  /**
   *  Optional. Policy on how to handle referenced deployments when deleting the
   *  DeploymentGroup.
   *  If unspecified, the default behavior is to fail the deletion if any
   *  deployments currently referenced in the `deployment_units` of the
   *  DeploymentGroup or in the latest revision are not deleted.
   */
  // const deploymentReferencePolicy = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeleteDeploymentGroup();

deleteDeploymentGroup(request, options, callback)

deleteDeploymentGroup(request: protos.google.cloud.config.v1.IDeleteDeploymentGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteDeploymentGroupRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteDeploymentGroup(request, callback)

deleteDeploymentGroup(request: protos.google.cloud.config.v1.IDeleteDeploymentGroupRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteDeploymentGroupRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name	Description
request	DeleteOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback	Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

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

deletePreview(request, options)

deletePreview(request?: protos.google.cloud.config.v1.IDeletePreviewRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a .

Parameters
Name	Description
request	IDeletePreviewRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Preview in the format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeletePreview();

deletePreview(request, options, callback)

deletePreview(request: protos.google.cloud.config.v1.IDeletePreviewRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeletePreviewRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deletePreview(request, callback)

deletePreview(request: protos.google.cloud.config.v1.IDeletePreviewRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeletePreviewRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteStatefile(request, options)

deleteStatefile(request?: protos.google.cloud.config.v1.IDeleteStatefileRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.config.v1.IDeleteStatefileRequest | undefined,
        {} | undefined
    ]>;

Deletes Terraform state file in a given deployment.

Parameters
Name	Description
request	IDeleteStatefileRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.config.v1.IDeleteStatefileRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'
  /**
   *  Required. Lock ID of the lock file to verify that the user who is deleting
   *  the state file previously locked the Deployment.
   */
  // const lockId = 1234

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.deleteStatefile(request);
    console.log(response);
  }

  callDeleteStatefile();

deleteStatefile(request, options, callback)

deleteStatefile(request: protos.google.cloud.config.v1.IDeleteStatefileRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.config.v1.IDeleteStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteStatefileRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.config.v1.IDeleteStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteStatefile(request, callback)

deleteStatefile(request: protos.google.cloud.config.v1.IDeleteStatefileRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.config.v1.IDeleteStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteStatefileRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.config.v1.IDeleteStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deploymentGroupPath(project, location, deploymentGroup)

deploymentGroupPath(project: string, location: string, deploymentGroup: string): string;

Return a fully-qualified deploymentGroup resource name string.

Parameters
Name	Description
project	string
location	string
deploymentGroup	string

Returns
Type	Description
string	{string} Resource name string.

deploymentGroupRevisionPath(project, location, deploymentGroup, revision)

deploymentGroupRevisionPath(project: string, location: string, deploymentGroup: string, revision: string): string;

Return a fully-qualified deploymentGroupRevision resource name string.

Parameters
Name	Description
project	string
location	string
deploymentGroup	string
revision	string

Returns
Type	Description
string	{string} Resource name string.

deploymentPath(project, location, deployment)

deploymentPath(project: string, location: string, deployment: string): string;

Return a fully-qualified deployment resource name string.

Parameters
Name	Description
project	string
location	string
deployment	string

Returns
Type	Description
string	{string} Resource name string.

deprovisionDeploymentGroup(request, options)

deprovisionDeploymentGroup(request?: protos.google.cloud.config.v1.IDeprovisionDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deprovisions a deployment group.

NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the *last successful* DeploymentGroupRevision but are *no longer* included in the *current* definition (e.g., following an UpdateDeploymentGroup call), along with their actuated resources.

Parameters
Name	Description
request	IDeprovisionDeploymentGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment group to deprovision.
   *  Format:
   *  'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. If set to true, this option is propagated to the deletion of each
   *  deployment in the group. This corresponds to the 'force' field
   *  in DeleteDeploymentRequest.
   */
  // const force = true
  /**
   *  Optional. Policy on how resources within each deployment should be handled
   *  during deletion. This policy is applied globally to the deletion of all
   *  deployments in this group. This corresponds to the 'delete_policy' field
   *  in DeleteDeploymentRequest.
   */
  // const deletePolicy = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callDeprovisionDeploymentGroup();

deprovisionDeploymentGroup(request, options, callback)

deprovisionDeploymentGroup(request: protos.google.cloud.config.v1.IDeprovisionDeploymentGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeprovisionDeploymentGroupRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deprovisionDeploymentGroup(request, callback)

deprovisionDeploymentGroup(request: protos.google.cloud.config.v1.IDeprovisionDeploymentGroupRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeprovisionDeploymentGroupRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportDeploymentStatefile(request, options)

exportDeploymentStatefile(request?: protos.google.cloud.config.v1.IExportDeploymentStatefileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IStatefile,
        protos.google.cloud.config.v1.IExportDeploymentStatefileRequest | undefined,
        {} | undefined
    ]>;

Exports Terraform state file from a given deployment.

Parameters
Name	Description
request	IExportDeploymentStatefileRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportDeploymentStatefileRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Statefile. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the statefile is listed. The parent
   *  value is in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. If this flag is set to true, the exported deployment state file
   *  will be the draft state. This will enable the draft file to be validated
   *  before copying it over to the working state on unlock.
   */
  // const draft = true

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.exportDeploymentStatefile(request);
    console.log(response);
  }

  callExportDeploymentStatefile();

exportDeploymentStatefile(request, options, callback)

exportDeploymentStatefile(request: protos.google.cloud.config.v1.IExportDeploymentStatefileRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportDeploymentStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportDeploymentStatefileRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportDeploymentStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportDeploymentStatefile(request, callback)

exportDeploymentStatefile(request: protos.google.cloud.config.v1.IExportDeploymentStatefileRequest, callback: Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportDeploymentStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportDeploymentStatefileRequest
callback	Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportDeploymentStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportLockInfo(request, options)

exportLockInfo(request?: protos.google.cloud.config.v1.IExportLockInfoRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.ILockInfo,
        protos.google.cloud.config.v1.IExportLockInfoRequest | undefined,
        {} | undefined
    ]>;

Exports the lock info on a locked deployment.

Parameters
Name	Description
request	IExportLockInfoRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.ILockInfo, protos.google.cloud.config.v1.IExportLockInfoRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing LockInfo. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.exportLockInfo(request);
    console.log(response);
  }

  callExportLockInfo();

exportLockInfo(request, options, callback)

exportLockInfo(request: protos.google.cloud.config.v1.IExportLockInfoRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.ILockInfo, protos.google.cloud.config.v1.IExportLockInfoRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportLockInfoRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.ILockInfo, protos.google.cloud.config.v1.IExportLockInfoRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportLockInfo(request, callback)

exportLockInfo(request: protos.google.cloud.config.v1.IExportLockInfoRequest, callback: Callback<protos.google.cloud.config.v1.ILockInfo, protos.google.cloud.config.v1.IExportLockInfoRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportLockInfoRequest
callback	Callback<protos.google.cloud.config.v1.ILockInfo, protos.google.cloud.config.v1.IExportLockInfoRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportPreviewResult(request, options)

exportPreviewResult(request?: protos.google.cloud.config.v1.IExportPreviewResultRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IExportPreviewResultResponse,
        protos.google.cloud.config.v1.IExportPreviewResultRequest | undefined,
        {} | undefined
    ]>;

Export results.

Parameters
Name	Description
request	IExportPreviewResultRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IExportPreviewResultResponse, protos.google.cloud.config.v1.IExportPreviewResultRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing ExportPreviewResultResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The preview whose results should be exported. The preview value
   *  is in the format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}'.
   */
  // const parent = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.exportPreviewResult(request);
    console.log(response);
  }

  callExportPreviewResult();

exportPreviewResult(request, options, callback)

exportPreviewResult(request: protos.google.cloud.config.v1.IExportPreviewResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IExportPreviewResultResponse, protos.google.cloud.config.v1.IExportPreviewResultRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportPreviewResultRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IExportPreviewResultResponse, protos.google.cloud.config.v1.IExportPreviewResultRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportPreviewResult(request, callback)

exportPreviewResult(request: protos.google.cloud.config.v1.IExportPreviewResultRequest, callback: Callback<protos.google.cloud.config.v1.IExportPreviewResultResponse, protos.google.cloud.config.v1.IExportPreviewResultRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportPreviewResultRequest
callback	Callback<protos.google.cloud.config.v1.IExportPreviewResultResponse, protos.google.cloud.config.v1.IExportPreviewResultRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportRevisionStatefile(request, options)

exportRevisionStatefile(request?: protos.google.cloud.config.v1.IExportRevisionStatefileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IStatefile,
        protos.google.cloud.config.v1.IExportRevisionStatefileRequest | undefined,
        {} | undefined
    ]>;

Exports Terraform state file from a given revision.

Parameters
Name	Description
request	IExportRevisionStatefileRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportRevisionStatefileRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Statefile. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the statefile is listed. The parent
   *  value is in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
   */
  // const parent = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.exportRevisionStatefile(request);
    console.log(response);
  }

  callExportRevisionStatefile();

exportRevisionStatefile(request, options, callback)

exportRevisionStatefile(request: protos.google.cloud.config.v1.IExportRevisionStatefileRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportRevisionStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportRevisionStatefileRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportRevisionStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportRevisionStatefile(request, callback)

exportRevisionStatefile(request: protos.google.cloud.config.v1.IExportRevisionStatefileRequest, callback: Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportRevisionStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportRevisionStatefileRequest
callback	Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IExportRevisionStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getAutoMigrationConfig(request, options)

getAutoMigrationConfig(request?: protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IAutoMigrationConfig,
        protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest | undefined,
        {} | undefined
    ]>;

Get the AutoMigrationConfig for a given project and location.

Parameters
Name	Description
request	IGetAutoMigrationConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing AutoMigrationConfig. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the AutoMigrationConfig.
   *  Format:
   *  'projects/{project_id}/locations/{location}/AutoMigrationConfig'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getAutoMigrationConfig(request);
    console.log(response);
  }

  callGetAutoMigrationConfig();

getAutoMigrationConfig(request, options, callback)

getAutoMigrationConfig(request: protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAutoMigrationConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getAutoMigrationConfig(request, callback)

getAutoMigrationConfig(request: protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest, callback: Callback<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAutoMigrationConfigRequest
callback	Callback<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IGetAutoMigrationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getDeployment(request, options)

getDeployment(request?: protos.google.cloud.config.v1.IGetDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IDeployment,
        protos.google.cloud.config.v1.IGetDeploymentRequest | undefined,
        {} | undefined
    ]>;

Gets details about a .

Parameters
Name	Description
request	IGetDeploymentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IGetDeploymentRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment. Format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getDeployment(request);
    console.log(response);
  }

  callGetDeployment();

getDeployment(request, options, callback)

getDeployment(request: protos.google.cloud.config.v1.IGetDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IGetDeploymentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetDeploymentRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IGetDeploymentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getDeployment(request, callback)

getDeployment(request: protos.google.cloud.config.v1.IGetDeploymentRequest, callback: Callback<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IGetDeploymentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetDeploymentRequest
callback	Callback<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IGetDeploymentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getDeploymentGroup(request, options)

getDeploymentGroup(request?: protos.google.cloud.config.v1.IGetDeploymentGroupRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IDeploymentGroup,
        protos.google.cloud.config.v1.IGetDeploymentGroupRequest | undefined,
        {} | undefined
    ]>;

Get a DeploymentGroup for a given project and location.

Parameters
Name	Description
request	IGetDeploymentGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IGetDeploymentGroupRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment group to retrieve.
   *  Format:
   *  'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getDeploymentGroup(request);
    console.log(response);
  }

  callGetDeploymentGroup();

getDeploymentGroup(request, options, callback)

getDeploymentGroup(request: protos.google.cloud.config.v1.IGetDeploymentGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IGetDeploymentGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetDeploymentGroupRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IGetDeploymentGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getDeploymentGroup(request, callback)

getDeploymentGroup(request: protos.google.cloud.config.v1.IGetDeploymentGroupRequest, callback: Callback<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IGetDeploymentGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetDeploymentGroupRequest
callback	Callback<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IGetDeploymentGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getDeploymentGroupRevision(request, options)

getDeploymentGroupRevision(request?: protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IDeploymentGroupRevision,
        protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest | undefined,
        {} | undefined
    ]>;

Gets details about a DeploymentGroupRevision.

Parameters
Name	Description
request	IGetDeploymentGroupRevisionRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IDeploymentGroupRevision, protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing DeploymentGroupRevision. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment group revision to retrieve.
   *  Format:
   *  'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getDeploymentGroupRevision(request);
    console.log(response);
  }

  callGetDeploymentGroupRevision();

getDeploymentGroupRevision(request, options, callback)

getDeploymentGroupRevision(request: protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IDeploymentGroupRevision, protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetDeploymentGroupRevisionRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IDeploymentGroupRevision, protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getDeploymentGroupRevision(request, callback)

getDeploymentGroupRevision(request: protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest, callback: Callback<protos.google.cloud.config.v1.IDeploymentGroupRevision, protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetDeploymentGroupRevisionRequest
callback	Callback<protos.google.cloud.config.v1.IDeploymentGroupRevision, protos.google.cloud.config.v1.IGetDeploymentGroupRevisionRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

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

Parameters
Name	Description
request	IamProtos.google.iam.v1.GetIamPolicyRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.Policy]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

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

Gets information about a location.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IGetLocationRequest The request object that will be sent.
options	CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> Call options. See CallOptions for more details.
callback	Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
Promise<google.cloud.location.ILocation>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

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

getOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name	Description
request	GetOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback	Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<[protos.google.longrunning.Operation]>

Example

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

getPreview(request, options)

getPreview(request?: protos.google.cloud.config.v1.IGetPreviewRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IPreview,
        protos.google.cloud.config.v1.IGetPreviewRequest | undefined,
        {} | undefined
    ]>;

Gets details about a .

Parameters
Name	Description
request	IGetPreviewRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IGetPreviewRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the preview. Format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getPreview(request);
    console.log(response);
  }

  callGetPreview();

getPreview(request, options, callback)

getPreview(request: protos.google.cloud.config.v1.IGetPreviewRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IGetPreviewRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetPreviewRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IGetPreviewRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getPreview(request, callback)

getPreview(request: protos.google.cloud.config.v1.IGetPreviewRequest, callback: Callback<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IGetPreviewRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetPreviewRequest
callback	Callback<protos.google.cloud.config.v1.IPreview, protos.google.cloud.config.v1.IGetPreviewRequest | 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

getResource(request, options)

getResource(request?: protos.google.cloud.config.v1.IGetResourceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IResource,
        protos.google.cloud.config.v1.IGetResourceRequest | undefined,
        {} | undefined
    ]>;

Gets details about a deployed by Infra Manager.

Parameters
Name	Description
request	IGetResourceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IResource, protos.google.cloud.config.v1.IGetResourceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Resource in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getResource(request);
    console.log(response);
  }

  callGetResource();

getResource(request, options, callback)

getResource(request: protos.google.cloud.config.v1.IGetResourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IResource, protos.google.cloud.config.v1.IGetResourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IResource, protos.google.cloud.config.v1.IGetResourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getResource(request, callback)

getResource(request: protos.google.cloud.config.v1.IGetResourceRequest, callback: Callback<protos.google.cloud.config.v1.IResource, protos.google.cloud.config.v1.IGetResourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceRequest
callback	Callback<protos.google.cloud.config.v1.IResource, protos.google.cloud.config.v1.IGetResourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getResourceChange(request, options)

getResourceChange(request?: protos.google.cloud.config.v1.IGetResourceChangeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IResourceChange,
        protos.google.cloud.config.v1.IGetResourceChangeRequest | undefined,
        {} | undefined
    ]>;

Get a ResourceChange for a given preview.

Parameters
Name	Description
request	IGetResourceChangeRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IResourceChange, protos.google.cloud.config.v1.IGetResourceChangeRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the resource change to retrieve.
   *  Format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getResourceChange(request);
    console.log(response);
  }

  callGetResourceChange();

getResourceChange(request, options, callback)

getResourceChange(request: protos.google.cloud.config.v1.IGetResourceChangeRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IResourceChange, protos.google.cloud.config.v1.IGetResourceChangeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceChangeRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IResourceChange, protos.google.cloud.config.v1.IGetResourceChangeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getResourceChange(request, callback)

getResourceChange(request: protos.google.cloud.config.v1.IGetResourceChangeRequest, callback: Callback<protos.google.cloud.config.v1.IResourceChange, protos.google.cloud.config.v1.IGetResourceChangeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceChangeRequest
callback	Callback<protos.google.cloud.config.v1.IResourceChange, protos.google.cloud.config.v1.IGetResourceChangeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getResourceDrift(request, options)

getResourceDrift(request?: protos.google.cloud.config.v1.IGetResourceDriftRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IResourceDrift,
        protos.google.cloud.config.v1.IGetResourceDriftRequest | undefined,
        {} | undefined
    ]>;

Get a ResourceDrift for a given preview.

Parameters
Name	Description
request	IGetResourceDriftRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IResourceDrift, protos.google.cloud.config.v1.IGetResourceDriftRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing ResourceDrift. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the resource drift to retrieve.
   *  Format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getResourceDrift(request);
    console.log(response);
  }

  callGetResourceDrift();

getResourceDrift(request, options, callback)

getResourceDrift(request: protos.google.cloud.config.v1.IGetResourceDriftRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IResourceDrift, protos.google.cloud.config.v1.IGetResourceDriftRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceDriftRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IResourceDrift, protos.google.cloud.config.v1.IGetResourceDriftRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getResourceDrift(request, callback)

getResourceDrift(request: protos.google.cloud.config.v1.IGetResourceDriftRequest, callback: Callback<protos.google.cloud.config.v1.IResourceDrift, protos.google.cloud.config.v1.IGetResourceDriftRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceDriftRequest
callback	Callback<protos.google.cloud.config.v1.IResourceDrift, protos.google.cloud.config.v1.IGetResourceDriftRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRevision(request, options)

getRevision(request?: protos.google.cloud.config.v1.IGetRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IRevision,
        protos.google.cloud.config.v1.IGetRevisionRequest | undefined,
        {} | undefined
    ]>;

Gets details about a .

Parameters
Name	Description
request	IGetRevisionRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IRevision, protos.google.cloud.config.v1.IGetRevisionRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Revision in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getRevision(request);
    console.log(response);
  }

  callGetRevision();

getRevision(request, options, callback)

getRevision(request: protos.google.cloud.config.v1.IGetRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IRevision, protos.google.cloud.config.v1.IGetRevisionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRevisionRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IRevision, protos.google.cloud.config.v1.IGetRevisionRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRevision(request, callback)

getRevision(request: protos.google.cloud.config.v1.IGetRevisionRequest, callback: Callback<protos.google.cloud.config.v1.IRevision, protos.google.cloud.config.v1.IGetRevisionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRevisionRequest
callback	Callback<protos.google.cloud.config.v1.IRevision, protos.google.cloud.config.v1.IGetRevisionRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTerraformVersion(request, options)

getTerraformVersion(request?: protos.google.cloud.config.v1.IGetTerraformVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.ITerraformVersion,
        protos.google.cloud.config.v1.IGetTerraformVersionRequest | undefined,
        {} | undefined
    ]>;

Gets details about a .

Parameters
Name	Description
request	IGetTerraformVersionRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.ITerraformVersion, protos.google.cloud.config.v1.IGetTerraformVersionRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TerraformVersion. Format:
   *  'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.getTerraformVersion(request);
    console.log(response);
  }

  callGetTerraformVersion();

getTerraformVersion(request, options, callback)

getTerraformVersion(request: protos.google.cloud.config.v1.IGetTerraformVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.ITerraformVersion, protos.google.cloud.config.v1.IGetTerraformVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTerraformVersionRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.ITerraformVersion, protos.google.cloud.config.v1.IGetTerraformVersionRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTerraformVersion(request, callback)

getTerraformVersion(request: protos.google.cloud.config.v1.IGetTerraformVersionRequest, callback: Callback<protos.google.cloud.config.v1.ITerraformVersion, protos.google.cloud.config.v1.IGetTerraformVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTerraformVersionRequest
callback	Callback<protos.google.cloud.config.v1.ITerraformVersion, protos.google.cloud.config.v1.IGetTerraformVersionRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

importStatefile(request, options)

importStatefile(request?: protos.google.cloud.config.v1.IImportStatefileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IStatefile,
        protos.google.cloud.config.v1.IImportStatefileRequest | undefined,
        {} | undefined
    ]>;

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
Name	Description
request	IImportStatefileRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IImportStatefileRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Statefile. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the statefile is listed. The parent
   *  value is in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const parent = 'abc123'
  /**
   *  Required. Lock ID of the lock file to verify that the user who is importing
   *  the state file previously locked the Deployment.
   */
  // const lockId = 1234
  /**
   *  Optional.
   */
  // const skipDraft = true

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

    // Run request
    const response = await configClient.importStatefile(request);
    console.log(response);
  }

  callImportStatefile();

importStatefile(request, options, callback)

importStatefile(request: protos.google.cloud.config.v1.IImportStatefileRequest, options: CallOptions, callback: Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IImportStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IImportStatefileRequest
options	CallOptions
callback	Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IImportStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

importStatefile(request, callback)

importStatefile(request: protos.google.cloud.config.v1.IImportStatefileRequest, callback: Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IImportStatefileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IImportStatefileRequest
callback	Callback<protos.google.cloud.config.v1.IStatefile, protos.google.cloud.config.v1.IImportStatefileRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

initialize()

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

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

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

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

listDeploymentGroupRevisions(request, options)

listDeploymentGroupRevisions(request?: protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IDeploymentGroupRevision[],
        protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest | null,
        protos.google.cloud.config.v1.IListDeploymentGroupRevisionsResponse
    ]>;

Lists DeploymentGroupRevisions in a given .

Parameters
Name	Description
request	IListDeploymentGroupRevisionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IDeploymentGroupRevision[], protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest | null, protos.google.cloud.config.v1.IListDeploymentGroupRevisionsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of DeploymentGroupRevision. 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 listDeploymentGroupRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDeploymentGroupRevisions(request, options, callback)

listDeploymentGroupRevisions(request: protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, protos.google.cloud.config.v1.IListDeploymentGroupRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroupRevision>): void;

Parameters
Name	Description
request	IListDeploymentGroupRevisionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, protos.google.cloud.config.v1.IListDeploymentGroupRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroupRevision>

Returns
Type	Description
void

listDeploymentGroupRevisions(request, callback)

listDeploymentGroupRevisions(request: protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, protos.google.cloud.config.v1.IListDeploymentGroupRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroupRevision>): void;

Parameters
Name	Description
request	IListDeploymentGroupRevisionsRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, protos.google.cloud.config.v1.IListDeploymentGroupRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroupRevision>

Returns
Type	Description
void

listDeploymentGroupRevisionsAsync(request, options)

listDeploymentGroupRevisionsAsync(request?: protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IDeploymentGroupRevision>;

Equivalent to listDeploymentGroupRevisions, but returns an iterable object.

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

Parameters
Name	Description
request	IListDeploymentGroupRevisionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IDeploymentGroupRevision>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DeploymentGroupRevision. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, which owns this collection of deployment group
   *  revisions. Format:
   *  'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. When requesting a page of resources, 'page_size' specifies number
   *  of resources to return. If unspecified, a sensible default will be used by
   *  the server. The maximum value is 1000; values above 1000 will be coerced to
   *  1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to 'ListDeploymentGroupRevisions'
   *  which specifies the position in the list from where to continue listing the
   *  deployment group revisions. All other parameters provided to
   *  `ListDeploymentGroupRevisions` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListDeploymentGroupRevisions();

listDeploymentGroupRevisionsStream(request, options)

listDeploymentGroupRevisionsStream(request?: protos.google.cloud.config.v1.IListDeploymentGroupRevisionsRequest, options?: CallOptions): Transform;

Equivalent to listDeploymentGroupRevisions, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDeploymentGroupRevisionsRequest 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 DeploymentGroupRevision 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 listDeploymentGroupRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDeploymentGroups(request, options)

listDeploymentGroups(request?: protos.google.cloud.config.v1.IListDeploymentGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IDeploymentGroup[],
        protos.google.cloud.config.v1.IListDeploymentGroupsRequest | null,
        protos.google.cloud.config.v1.IListDeploymentGroupsResponse
    ]>;

List DeploymentGroups for a given project and location.

Parameters
Name	Description
request	IListDeploymentGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IDeploymentGroup[], protos.google.cloud.config.v1.IListDeploymentGroupsRequest | null, protos.google.cloud.config.v1.IListDeploymentGroupsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDeploymentGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDeploymentGroups(request, options, callback)

listDeploymentGroups(request: protos.google.cloud.config.v1.IListDeploymentGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupsRequest, protos.google.cloud.config.v1.IListDeploymentGroupsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroup>): void;

Parameters
Name	Description
request	IListDeploymentGroupsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupsRequest, protos.google.cloud.config.v1.IListDeploymentGroupsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroup>

Returns
Type	Description
void

listDeploymentGroups(request, callback)

listDeploymentGroups(request: protos.google.cloud.config.v1.IListDeploymentGroupsRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupsRequest, protos.google.cloud.config.v1.IListDeploymentGroupsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroup>): void;

Parameters
Name	Description
request	IListDeploymentGroupsRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListDeploymentGroupsRequest, protos.google.cloud.config.v1.IListDeploymentGroupsResponse | null | undefined, protos.google.cloud.config.v1.IDeploymentGroup>

Returns
Type	Description
void

listDeploymentGroupsAsync(request, options)

listDeploymentGroupsAsync(request?: protos.google.cloud.config.v1.IListDeploymentGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IDeploymentGroup>;

Equivalent to listDeploymentGroups, but returns an iterable object.

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

Parameters
Name	Description
request	IListDeploymentGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IDeploymentGroup>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, which owns this collection of deployment groups.
   *  Format: 'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. When requesting a page of resources, 'page_size' specifies number
   *  of resources to return. If unspecified, at most 500 will be returned. The
   *  maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to 'ListDeploymentGroups' which
   *  specifies the position in the list from where to continue listing the
   *  deployment groups.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists the DeploymentGroups that match the filter expression. A
   *  filter expression filters the deployment groups listed in the response. The
   *  expression must be of the form '{field} {operator} {value}' where
   *  operators: '<', '="">',
   *  '<=', '="">=', '!=', '=', ':' are supported (colon ':' represents a HAS
   *  operator which is roughly synonymous with equality). {field} can refer to a
   *  proto or JSON field, or a synthetic field. Field names can be camelCase or
   *  snake_case.
   *  Examples:
   *  - Filter by name:
   *    name = "projects/foo/locations/us-central1/deploymentGroups/bar"
   *  - Filter by labels:
   *    - Resources that have a key called 'foo'
   *      labels.foo:*
   *    - Resources that have a key called 'foo' whose value is 'bar'
   *      labels.foo = bar
   *  - Filter by state:
   *    - DeploymentGroups in CREATING state.
   *      state=CREATING
   */
  // const filter = 'abc123'
  /**
   *  Optional. Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListDeploymentGroups();

listDeploymentGroupsStream(request, options)

listDeploymentGroupsStream(request?: protos.google.cloud.config.v1.IListDeploymentGroupsRequest, options?: CallOptions): Transform;

Equivalent to listDeploymentGroups, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDeploymentGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

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

listDeployments(request, options)

listDeployments(request?: protos.google.cloud.config.v1.IListDeploymentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IDeployment[],
        protos.google.cloud.config.v1.IListDeploymentsRequest | null,
        protos.google.cloud.config.v1.IListDeploymentsResponse
    ]>;

Lists s in a given project and location.

Parameters
Name	Description
request	IListDeploymentsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IDeployment[], protos.google.cloud.config.v1.IListDeploymentsRequest | null, protos.google.cloud.config.v1.IListDeploymentsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDeployments(request, options, callback)

listDeployments(request: protos.google.cloud.config.v1.IListDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListDeploymentsRequest, protos.google.cloud.config.v1.IListDeploymentsResponse | null | undefined, protos.google.cloud.config.v1.IDeployment>): void;

Parameters
Name	Description
request	IListDeploymentsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListDeploymentsRequest, protos.google.cloud.config.v1.IListDeploymentsResponse | null | undefined, protos.google.cloud.config.v1.IDeployment>

Returns
Type	Description
void

listDeployments(request, callback)

listDeployments(request: protos.google.cloud.config.v1.IListDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListDeploymentsRequest, protos.google.cloud.config.v1.IListDeploymentsResponse | null | undefined, protos.google.cloud.config.v1.IDeployment>): void;

Parameters
Name	Description
request	IListDeploymentsRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListDeploymentsRequest, protos.google.cloud.config.v1.IListDeploymentsResponse | null | undefined, protos.google.cloud.config.v1.IDeployment>

Returns
Type	Description
void

listDeploymentsAsync(request, options)

listDeploymentsAsync(request?: protos.google.cloud.config.v1.IListDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IDeployment>;

Equivalent to listDeployments, but returns an iterable object.

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

Parameters
Name	Description
request	IListDeploymentsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IDeployment>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Deployments are listed. The
   *  parent value is in the format:
   *  'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  When requesting a page of resources, 'page_size' specifies number of
   *  resources to return. If unspecified, at most 500 will be returned. The
   *  maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Token returned by previous call to 'ListDeployments' which specifies the
   *  position in the list from where to continue listing the resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Lists the Deployments that match the filter expression. A filter
   *  expression filters the resources listed in the response. The expression
   *  must be of the form '{field} {operator} {value}' where operators: '<', '="">',
   *  '<=', '="">=', '!=', '=', ':' are supported (colon ':' represents a HAS
   *  operator which is roughly synonymous with equality). {field} can refer to a
   *  proto or JSON field, or a synthetic field. Field names can be camelCase or
   *  snake_case.
   *  Examples:
   *  - Filter by name:
   *    name = "projects/foo/locations/us-central1/deployments/bar
   *  - Filter by labels:
   *    - Resources that have a key called 'foo'
   *      labels.foo:*
   *    - Resources that have a key called 'foo' whose value is 'bar'
   *      labels.foo = bar
   *  - Filter by state:
   *    - Deployments in CREATING state.
   *      state=CREATING
   */
  // const filter = 'abc123'
  /**
   *  Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListDeployments();

listDeploymentsStream(request, options)

listDeploymentsStream(request?: protos.google.cloud.config.v1.IListDeploymentsRequest, options?: CallOptions): Transform;

Equivalent to listDeployments, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDeploymentsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

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

listLocationsAsync(request, options)

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

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

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

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IListLocationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<google.cloud.location.ILocation>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

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

listOperationsAsync(request, options)

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

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

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

Parameters
Name	Description
request	ListOperationsRequest The request object that will be sent.
options	CallOptions Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
AsyncIterable<protos.google.longrunning.IOperation>	{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listPreviews(request, options)

listPreviews(request?: protos.google.cloud.config.v1.IListPreviewsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IPreview[],
        protos.google.cloud.config.v1.IListPreviewsRequest | null,
        protos.google.cloud.config.v1.IListPreviewsResponse
    ]>;

Lists s in a given project and location.

Parameters
Name	Description
request	IListPreviewsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IPreview[], protos.google.cloud.config.v1.IListPreviewsRequest | null, protos.google.cloud.config.v1.IListPreviewsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listPreviewsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPreviews(request, options, callback)

listPreviews(request: protos.google.cloud.config.v1.IListPreviewsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListPreviewsRequest, protos.google.cloud.config.v1.IListPreviewsResponse | null | undefined, protos.google.cloud.config.v1.IPreview>): void;

Parameters
Name	Description
request	IListPreviewsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListPreviewsRequest, protos.google.cloud.config.v1.IListPreviewsResponse | null | undefined, protos.google.cloud.config.v1.IPreview>

Returns
Type	Description
void

listPreviews(request, callback)

listPreviews(request: protos.google.cloud.config.v1.IListPreviewsRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListPreviewsRequest, protos.google.cloud.config.v1.IListPreviewsResponse | null | undefined, protos.google.cloud.config.v1.IPreview>): void;

Parameters
Name	Description
request	IListPreviewsRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListPreviewsRequest, protos.google.cloud.config.v1.IListPreviewsResponse | null | undefined, protos.google.cloud.config.v1.IPreview>

Returns
Type	Description
void

listPreviewsAsync(request, options)

listPreviewsAsync(request?: protos.google.cloud.config.v1.IListPreviewsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IPreview>;

Equivalent to listPreviews, but returns an iterable object.

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

Parameters
Name	Description
request	IListPreviewsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IPreview>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Previews are listed. The parent
   *  value is in the format: 'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. When requesting a page of resources, 'page_size' specifies number
   *  of resources to return. If unspecified, at most 500 will be returned. The
   *  maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to 'ListDeployments' which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists the Deployments that match the filter expression. A filter
   *  expression filters the resources listed in the response. The expression
   *  must be of the form '{field} {operator} {value}' where operators: '<', '="">',
   *  '<=', '="">=', '!=', '=', ':' are supported (colon ':' represents a HAS
   *  operator which is roughly synonymous with equality). {field} can refer to a
   *  proto or JSON field, or a synthetic field. Field names can be camelCase or
   *  snake_case.
   *  Examples:
   *  - Filter by name:
   *    name = "projects/foo/locations/us-central1/deployments/bar
   *  - Filter by labels:
   *    - Resources that have a key called 'foo'
   *      labels.foo:*
   *    - Resources that have a key called 'foo' whose value is 'bar'
   *      labels.foo = bar
   *  - Filter by state:
   *    - Deployments in CREATING state.
   *      state=CREATING
   */
  // const filter = 'abc123'
  /**
   *  Optional. Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListPreviews();

listPreviewsStream(request, options)

listPreviewsStream(request?: protos.google.cloud.config.v1.IListPreviewsRequest, options?: CallOptions): Transform;

Equivalent to listPreviews, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListPreviewsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

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

listResourceChanges(request, options)

listResourceChanges(request?: protos.google.cloud.config.v1.IListResourceChangesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IResourceChange[],
        protos.google.cloud.config.v1.IListResourceChangesRequest | null,
        protos.google.cloud.config.v1.IListResourceChangesResponse
    ]>;

Lists ResourceChanges for a given preview.

Parameters
Name	Description
request	IListResourceChangesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IResourceChange[], protos.google.cloud.config.v1.IListResourceChangesRequest | null, protos.google.cloud.config.v1.IListResourceChangesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listResourceChangesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listResourceChanges(request, options, callback)

listResourceChanges(request: protos.google.cloud.config.v1.IListResourceChangesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListResourceChangesRequest, protos.google.cloud.config.v1.IListResourceChangesResponse | null | undefined, protos.google.cloud.config.v1.IResourceChange>): void;

Parameters
Name	Description
request	IListResourceChangesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListResourceChangesRequest, protos.google.cloud.config.v1.IListResourceChangesResponse | null | undefined, protos.google.cloud.config.v1.IResourceChange>

Returns
Type	Description
void

listResourceChanges(request, callback)

listResourceChanges(request: protos.google.cloud.config.v1.IListResourceChangesRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListResourceChangesRequest, protos.google.cloud.config.v1.IListResourceChangesResponse | null | undefined, protos.google.cloud.config.v1.IResourceChange>): void;

Parameters
Name	Description
request	IListResourceChangesRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListResourceChangesRequest, protos.google.cloud.config.v1.IListResourceChangesResponse | null | undefined, protos.google.cloud.config.v1.IResourceChange>

Returns
Type	Description
void

listResourceChangesAsync(request, options)

listResourceChangesAsync(request?: protos.google.cloud.config.v1.IListResourceChangesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IResourceChange>;

Equivalent to listResourceChanges, but returns an iterable object.

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

Parameters
Name	Description
request	IListResourceChangesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IResourceChange>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the ResourceChanges are listed. The
   *  parent value is in the format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. When requesting a page of resource changes, 'page_size' specifies
   *  number of resource changes to return. If unspecified, at most 500 will be
   *  returned. The maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to 'ListResourceChanges' which
   *  specifies the position in the list from where to continue listing the
   *  resource changes.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists the resource changes that match the filter expression. A
   *  filter expression filters the resource changes listed in the response. The
   *  expression must be of the form '{field} {operator} {value}' where
   *  operators: '<', '="">',
   *  '<=', *="" '="">=',
   *  '!=', '=', ':' are supported (colon ':' represents a HAS operator which is
   *  roughly synonymous with equality). {field} can refer to a proto or JSON
   *  field, or a synthetic field. Field names can be camelCase or snake_case.
   *  Examples:
   *  - Filter by name:
   *    name =
   *    "projects/foo/locations/us-central1/previews/dep/resourceChanges/baz
   */
  // const filter = 'abc123'
  /**
   *  Optional. Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListResourceChanges();

listResourceChangesStream(request, options)

listResourceChangesStream(request?: protos.google.cloud.config.v1.IListResourceChangesRequest, options?: CallOptions): Transform;

Equivalent to listResourceChanges, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListResourceChangesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

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

listResourceDrifts(request, options)

listResourceDrifts(request?: protos.google.cloud.config.v1.IListResourceDriftsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IResourceDrift[],
        protos.google.cloud.config.v1.IListResourceDriftsRequest | null,
        protos.google.cloud.config.v1.IListResourceDriftsResponse
    ]>;

List ResourceDrifts for a given preview.

Parameters
Name	Description
request	IListResourceDriftsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IResourceDrift[], protos.google.cloud.config.v1.IListResourceDriftsRequest | null, protos.google.cloud.config.v1.IListResourceDriftsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of ResourceDrift. 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 listResourceDriftsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listResourceDrifts(request, options, callback)

listResourceDrifts(request: protos.google.cloud.config.v1.IListResourceDriftsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListResourceDriftsRequest, protos.google.cloud.config.v1.IListResourceDriftsResponse | null | undefined, protos.google.cloud.config.v1.IResourceDrift>): void;

Parameters
Name	Description
request	IListResourceDriftsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListResourceDriftsRequest, protos.google.cloud.config.v1.IListResourceDriftsResponse | null | undefined, protos.google.cloud.config.v1.IResourceDrift>

Returns
Type	Description
void

listResourceDrifts(request, callback)

listResourceDrifts(request: protos.google.cloud.config.v1.IListResourceDriftsRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListResourceDriftsRequest, protos.google.cloud.config.v1.IListResourceDriftsResponse | null | undefined, protos.google.cloud.config.v1.IResourceDrift>): void;

Parameters
Name	Description
request	IListResourceDriftsRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListResourceDriftsRequest, protos.google.cloud.config.v1.IListResourceDriftsResponse | null | undefined, protos.google.cloud.config.v1.IResourceDrift>

Returns
Type	Description
void

listResourceDriftsAsync(request, options)

listResourceDriftsAsync(request?: protos.google.cloud.config.v1.IListResourceDriftsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IResourceDrift>;

Equivalent to listResourceDrifts, but returns an iterable object.

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

Parameters
Name	Description
request	IListResourceDriftsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IResourceDrift>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ResourceDrift. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the ResourceDrifts are listed. The
   *  parent value is in the format:
   *  'projects/{project_id}/locations/{location}/previews/{preview}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. When requesting a page of resource drifts, 'page_size' specifies
   *  number of resource drifts to return. If unspecified, at most 500 will be
   *  returned. The maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to 'ListResourceDrifts' which
   *  specifies the position in the list from where to continue listing the
   *  resource drifts.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists the resource drifts that match the filter expression. A
   *  filter expression filters the resource drifts listed in the response. The
   *  expression must be of the form '{field} {operator} {value}' where
   *  operators: '<', '="">',
   *  '<=', *="" '="">=',
   *  '!=', '=', ':' are supported (colon ':' represents a HAS operator which is
   *  roughly synonymous with equality). {field} can refer to a proto or JSON
   *  field, or a synthetic field. Field names can be camelCase or snake_case.
   *  Examples:
   *  - Filter by name:
   *    name =
   *    "projects/foo/locations/us-central1/previews/dep/resourceDrifts/baz
   */
  // const filter = 'abc123'
  /**
   *  Optional. Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListResourceDrifts();

listResourceDriftsStream(request, options)

listResourceDriftsStream(request?: protos.google.cloud.config.v1.IListResourceDriftsRequest, options?: CallOptions): Transform;

Equivalent to listResourceDrifts, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListResourceDriftsRequest 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 ResourceDrift 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 listResourceDriftsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listResources(request, options)

listResources(request?: protos.google.cloud.config.v1.IListResourcesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IResource[],
        protos.google.cloud.config.v1.IListResourcesRequest | null,
        protos.google.cloud.config.v1.IListResourcesResponse
    ]>;

Lists in a given revision.

Parameters
Name	Description
request	IListResourcesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IResource[], protos.google.cloud.config.v1.IListResourcesRequest | null, protos.google.cloud.config.v1.IListResourcesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listResourcesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listResources(request, options, callback)

listResources(request: protos.google.cloud.config.v1.IListResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListResourcesRequest, protos.google.cloud.config.v1.IListResourcesResponse | null | undefined, protos.google.cloud.config.v1.IResource>): void;

Parameters
Name	Description
request	IListResourcesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListResourcesRequest, protos.google.cloud.config.v1.IListResourcesResponse | null | undefined, protos.google.cloud.config.v1.IResource>

Returns
Type	Description
void

listResources(request, callback)

listResources(request: protos.google.cloud.config.v1.IListResourcesRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListResourcesRequest, protos.google.cloud.config.v1.IListResourcesResponse | null | undefined, protos.google.cloud.config.v1.IResource>): void;

Parameters
Name	Description
request	IListResourcesRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListResourcesRequest, protos.google.cloud.config.v1.IListResourcesResponse | null | undefined, protos.google.cloud.config.v1.IResource>

Returns
Type	Description
void

listResourcesAsync(request, options)

listResourcesAsync(request?: protos.google.cloud.config.v1.IListResourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IResource>;

Equivalent to listResources, but returns an iterable object.

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

Parameters
Name	Description
request	IListResourcesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IResource>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Resources are listed. The parent
   *  value is in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
   */
  // const parent = 'abc123'
  /**
   *  When requesting a page of resources, 'page_size' specifies number of
   *  resources to return. If unspecified, at most 500 will be returned. The
   *  maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Token returned by previous call to 'ListResources' which specifies the
   *  position in the list from where to continue listing the resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Lists the Resources that match the filter expression. A filter
   *  expression filters the resources listed in the response. The expression
   *  must be of the form '{field} {operator} {value}' where operators: '<', '="">',
   *  '<=', *="" '="">=',
   *  '!=', '=', ':' are supported (colon ':' represents a HAS operator which is
   *  roughly synonymous with equality). {field} can refer to a proto or JSON
   *  field, or a synthetic field. Field names can be camelCase or snake_case.
   *  Examples:
   *  - Filter by name:
   *    name =
   *    "projects/foo/locations/us-central1/deployments/dep/revisions/bar/resources/baz
   */
  // const filter = 'abc123'
  /**
   *  Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListResources();

listResourcesStream(request, options)

listResourcesStream(request?: protos.google.cloud.config.v1.IListResourcesRequest, options?: CallOptions): Transform;

Equivalent to listResources, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListResourcesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

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

listRevisions(request, options)

listRevisions(request?: protos.google.cloud.config.v1.IListRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.IRevision[],
        protos.google.cloud.config.v1.IListRevisionsRequest | null,
        protos.google.cloud.config.v1.IListRevisionsResponse
    ]>;

Lists s of a deployment.

Parameters
Name	Description
request	IListRevisionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.IRevision[], protos.google.cloud.config.v1.IListRevisionsRequest | null, protos.google.cloud.config.v1.IListRevisionsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRevisions(request, options, callback)

listRevisions(request: protos.google.cloud.config.v1.IListRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListRevisionsRequest, protos.google.cloud.config.v1.IListRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IRevision>): void;

Parameters
Name	Description
request	IListRevisionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListRevisionsRequest, protos.google.cloud.config.v1.IListRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IRevision>

Returns
Type	Description
void

listRevisions(request, callback)

listRevisions(request: protos.google.cloud.config.v1.IListRevisionsRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListRevisionsRequest, protos.google.cloud.config.v1.IListRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IRevision>): void;

Parameters
Name	Description
request	IListRevisionsRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListRevisionsRequest, protos.google.cloud.config.v1.IListRevisionsResponse | null | undefined, protos.google.cloud.config.v1.IRevision>

Returns
Type	Description
void

listRevisionsAsync(request, options)

listRevisionsAsync(request?: protos.google.cloud.config.v1.IListRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.IRevision>;

Equivalent to listRevisions, but returns an iterable object.

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

Parameters
Name	Description
request	IListRevisionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.IRevision>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the Revisions are listed. The parent
   *  value is in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const parent = 'abc123'
  /**
   *  When requesting a page of resources, `page_size` specifies number of
   *  resources to return. If unspecified, at most 500 will be returned. The
   *  maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Token returned by previous call to 'ListRevisions' which specifies the
   *  position in the list from where to continue listing the resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Lists the Revisions that match the filter expression. A filter
   *  expression filters the resources listed in the response. The expression
   *  must be of the form '{field} {operator} {value}' where operators: '<', '="">',
   *  '<=', '="">=', '!=', '=', ':' are supported (colon ':' represents a HAS
   *  operator which is roughly synonymous with equality). {field} can refer to a
   *  proto or JSON field, or a synthetic field. Field names can be camelCase or
   *  snake_case.
   *  Examples:
   *  - Filter by name:
   *    name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar
   *  - Filter by labels:
   *    - Resources that have a key called 'foo'
   *      labels.foo:*
   *    - Resources that have a key called 'foo' whose value is 'bar'
   *      labels.foo = bar
   *  - Filter by state:
   *    - Revisions in CREATING state.
   *      state=CREATING
   */
  // const filter = 'abc123'
  /**
   *  Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListRevisions();

listRevisionsStream(request, options)

listRevisionsStream(request?: protos.google.cloud.config.v1.IListRevisionsRequest, options?: CallOptions): Transform;

Equivalent to listRevisions, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListRevisionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

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

listTerraformVersions(request, options)

listTerraformVersions(request?: protos.google.cloud.config.v1.IListTerraformVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.config.v1.ITerraformVersion[],
        protos.google.cloud.config.v1.IListTerraformVersionsRequest | null,
        protos.google.cloud.config.v1.IListTerraformVersionsResponse
    ]>;

Lists s in a given project and location.

Parameters
Name	Description
request	IListTerraformVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.config.v1.ITerraformVersion[], protos.google.cloud.config.v1.IListTerraformVersionsRequest | null, protos.google.cloud.config.v1.IListTerraformVersionsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTerraformVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTerraformVersions(request, options, callback)

listTerraformVersions(request: protos.google.cloud.config.v1.IListTerraformVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.config.v1.IListTerraformVersionsRequest, protos.google.cloud.config.v1.IListTerraformVersionsResponse | null | undefined, protos.google.cloud.config.v1.ITerraformVersion>): void;

Parameters
Name	Description
request	IListTerraformVersionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.config.v1.IListTerraformVersionsRequest, protos.google.cloud.config.v1.IListTerraformVersionsResponse | null | undefined, protos.google.cloud.config.v1.ITerraformVersion>

Returns
Type	Description
void

listTerraformVersions(request, callback)

listTerraformVersions(request: protos.google.cloud.config.v1.IListTerraformVersionsRequest, callback: PaginationCallback<protos.google.cloud.config.v1.IListTerraformVersionsRequest, protos.google.cloud.config.v1.IListTerraformVersionsResponse | null | undefined, protos.google.cloud.config.v1.ITerraformVersion>): void;

Parameters
Name	Description
request	IListTerraformVersionsRequest
callback	PaginationCallback<protos.google.cloud.config.v1.IListTerraformVersionsRequest, protos.google.cloud.config.v1.IListTerraformVersionsResponse | null | undefined, protos.google.cloud.config.v1.ITerraformVersion>

Returns
Type	Description
void

listTerraformVersionsAsync(request, options)

listTerraformVersionsAsync(request?: protos.google.cloud.config.v1.IListTerraformVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.config.v1.ITerraformVersion>;

Equivalent to listTerraformVersions, but returns an iterable object.

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

Parameters
Name	Description
request	IListTerraformVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.config.v1.ITerraformVersion>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent in whose context the TerraformVersions are listed. The
   *  parent value is in the format:
   *  'projects/{project_id}/locations/{location}'.
   */
  // const parent = 'abc123'
  /**
   *  Optional. When requesting a page of terraform versions, 'page_size'
   *  specifies number of terraform versions to return. If unspecified, at most
   *  500 will be returned. The maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to 'ListTerraformVersions' which
   *  specifies the position in the list from where to continue listing the
   *  terraform versions.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists the TerraformVersions that match the filter expression. A
   *  filter expression filters the resources listed in the response. The
   *  expression must be of the form '{field} {operator} {value}' where
   *  operators: '<', '="">',
   *  '<=', '="">=', '!=', '=', ':' are supported (colon ':' represents a HAS
   *  operator which is roughly synonymous with equality). {field} can refer to a
   *  proto or JSON field, or a synthetic field. Field names can be camelCase or
   *  snake_case.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Field to use to sort the list.
   */
  // const orderBy = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callListTerraformVersions();

listTerraformVersionsStream(request, options)

listTerraformVersionsStream(request?: protos.google.cloud.config.v1.IListTerraformVersionsRequest, options?: CallOptions): Transform;

Equivalent to listTerraformVersions, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListTerraformVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

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

lockDeployment(request, options)

lockDeployment(request?: protos.google.cloud.config.v1.ILockDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Locks a deployment.

Parameters
Name	Description
request	ILockDeploymentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callLockDeployment();

lockDeployment(request, options, callback)

lockDeployment(request: protos.google.cloud.config.v1.ILockDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ILockDeploymentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

lockDeployment(request, callback)

lockDeployment(request: protos.google.cloud.config.v1.ILockDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ILockDeploymentRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter
Name	Description
deploymentName	string A fully-qualified path representing Deployment resource.

Returns
Type	Description
string | number	{string} A string representing the deployment.

matchDeploymentFromResourceName(resourceName)

matchDeploymentFromResourceName(resourceName: string): string | number;

Parse the deployment from Resource resource.

Parameter
Name	Description
resourceName	string A fully-qualified path representing Resource resource.

Returns
Type	Description
string | number	{string} A string representing the deployment.

matchDeploymentFromRevisionName(revisionName)

matchDeploymentFromRevisionName(revisionName: string): string | number;

Parse the deployment from Revision resource.

Parameter
Name	Description
revisionName	string A fully-qualified path representing Revision resource.

Returns
Type	Description
string | number	{string} A string representing the deployment.

matchDeploymentGroupFromDeploymentGroupName(deploymentGroupName)

matchDeploymentGroupFromDeploymentGroupName(deploymentGroupName: string): string | number;

Parse the deployment_group from DeploymentGroup resource.

Parameter
Name	Description
deploymentGroupName	string A fully-qualified path representing DeploymentGroup resource.

Returns
Type	Description
string | number	{string} A string representing the deployment_group.

matchDeploymentGroupFromDeploymentGroupRevisionName(deploymentGroupRevisionName)

matchDeploymentGroupFromDeploymentGroupRevisionName(deploymentGroupRevisionName: string): string | number;

Parse the deployment_group from DeploymentGroupRevision resource.

Parameter
Name	Description
deploymentGroupRevisionName	string A fully-qualified path representing DeploymentGroupRevision resource.

Returns
Type	Description
string | number	{string} A string representing the deployment_group.

matchLocationFromAutoMigrationConfigName(autoMigrationConfigName)

matchLocationFromAutoMigrationConfigName(autoMigrationConfigName: string): string | number;

Parse the location from AutoMigrationConfig resource.

Parameter
Name	Description
autoMigrationConfigName	string A fully-qualified path representing AutoMigrationConfig resource.

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

matchLocationFromDeploymentGroupName(deploymentGroupName)

matchLocationFromDeploymentGroupName(deploymentGroupName: string): string | number;

Parse the location from DeploymentGroup resource.

Parameter
Name	Description
deploymentGroupName	string A fully-qualified path representing DeploymentGroup resource.

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

matchLocationFromDeploymentGroupRevisionName(deploymentGroupRevisionName)

matchLocationFromDeploymentGroupRevisionName(deploymentGroupRevisionName: string): string | number;

Parse the location from DeploymentGroupRevision resource.

Parameter
Name	Description
deploymentGroupRevisionName	string A fully-qualified path representing DeploymentGroupRevision resource.

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

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter
Name	Description
deploymentName	string A fully-qualified path representing Deployment 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.

matchLocationFromPreviewName(previewName)

matchLocationFromPreviewName(previewName: string): string | number;

Parse the location from Preview resource.

Parameter
Name	Description
previewName	string A fully-qualified path representing Preview resource.

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

matchLocationFromResourceChangeName(resourceChangeName)

matchLocationFromResourceChangeName(resourceChangeName: string): string | number;

Parse the location from ResourceChange resource.

Parameter
Name	Description
resourceChangeName	string A fully-qualified path representing ResourceChange resource.

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

matchLocationFromResourceDriftName(resourceDriftName)

matchLocationFromResourceDriftName(resourceDriftName: string): string | number;

Parse the location from ResourceDrift resource.

Parameter
Name	Description
resourceDriftName	string A fully-qualified path representing ResourceDrift resource.

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

matchLocationFromResourceName(resourceName)

matchLocationFromResourceName(resourceName: string): string | number;

Parse the location from Resource resource.

Parameter
Name	Description
resourceName	string A fully-qualified path representing Resource resource.

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

matchLocationFromRevisionName(revisionName)

matchLocationFromRevisionName(revisionName: string): string | number;

Parse the location from Revision resource.

Parameter
Name	Description
revisionName	string A fully-qualified path representing Revision resource.

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

matchLocationFromTerraformVersionName(terraformVersionName)

matchLocationFromTerraformVersionName(terraformVersionName: string): string | number;

Parse the location from TerraformVersion resource.

Parameter
Name	Description
terraformVersionName	string A fully-qualified path representing TerraformVersion resource.

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

matchLocationFromWorkerPoolName(workerPoolName)

matchLocationFromWorkerPoolName(workerPoolName: string): string | number;

Parse the location from WorkerPool resource.

Parameter
Name	Description
workerPoolName	string A fully-qualified path representing WorkerPool resource.

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

matchPreviewFromPreviewName(previewName)

matchPreviewFromPreviewName(previewName: string): string | number;

Parse the preview from Preview resource.

Parameter
Name	Description
previewName	string A fully-qualified path representing Preview resource.

Returns
Type	Description
string | number	{string} A string representing the preview.

matchPreviewFromResourceChangeName(resourceChangeName)

matchPreviewFromResourceChangeName(resourceChangeName: string): string | number;

Parse the preview from ResourceChange resource.

Parameter
Name	Description
resourceChangeName	string A fully-qualified path representing ResourceChange resource.

Returns
Type	Description
string | number	{string} A string representing the preview.

matchPreviewFromResourceDriftName(resourceDriftName)

matchPreviewFromResourceDriftName(resourceDriftName: string): string | number;

Parse the preview from ResourceDrift resource.

Parameter
Name	Description
resourceDriftName	string A fully-qualified path representing ResourceDrift resource.

Returns
Type	Description
string | number	{string} A string representing the preview.

matchProjectFromAutoMigrationConfigName(autoMigrationConfigName)

matchProjectFromAutoMigrationConfigName(autoMigrationConfigName: string): string | number;

Parse the project from AutoMigrationConfig resource.

Parameter
Name	Description
autoMigrationConfigName	string A fully-qualified path representing AutoMigrationConfig resource.

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

matchProjectFromDeploymentGroupName(deploymentGroupName)

matchProjectFromDeploymentGroupName(deploymentGroupName: string): string | number;

Parse the project from DeploymentGroup resource.

Parameter
Name	Description
deploymentGroupName	string A fully-qualified path representing DeploymentGroup resource.

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

matchProjectFromDeploymentGroupRevisionName(deploymentGroupRevisionName)

matchProjectFromDeploymentGroupRevisionName(deploymentGroupRevisionName: string): string | number;

Parse the project from DeploymentGroupRevision resource.

Parameter
Name	Description
deploymentGroupRevisionName	string A fully-qualified path representing DeploymentGroupRevision resource.

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

matchProjectFromDeploymentName(deploymentName)

matchProjectFromDeploymentName(deploymentName: string): string | number;

Parse the project from Deployment resource.

Parameter
Name	Description
deploymentName	string A fully-qualified path representing Deployment 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.

matchProjectFromPreviewName(previewName)

matchProjectFromPreviewName(previewName: string): string | number;

Parse the project from Preview resource.

Parameter
Name	Description
previewName	string A fully-qualified path representing Preview resource.

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

matchProjectFromResourceChangeName(resourceChangeName)

matchProjectFromResourceChangeName(resourceChangeName: string): string | number;

Parse the project from ResourceChange resource.

Parameter
Name	Description
resourceChangeName	string A fully-qualified path representing ResourceChange resource.

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

matchProjectFromResourceDriftName(resourceDriftName)

matchProjectFromResourceDriftName(resourceDriftName: string): string | number;

Parse the project from ResourceDrift resource.

Parameter
Name	Description
resourceDriftName	string A fully-qualified path representing ResourceDrift resource.

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

matchProjectFromResourceName(resourceName)

matchProjectFromResourceName(resourceName: string): string | number;

Parse the project from Resource resource.

Parameter
Name	Description
resourceName	string A fully-qualified path representing Resource resource.

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

matchProjectFromRevisionName(revisionName)

matchProjectFromRevisionName(revisionName: string): string | number;

Parse the project from Revision resource.

Parameter
Name	Description
revisionName	string A fully-qualified path representing Revision resource.

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

matchProjectFromServiceAccountName(serviceAccountName)

matchProjectFromServiceAccountName(serviceAccountName: string): string | number;

Parse the project from ServiceAccount resource.

Parameter
Name	Description
serviceAccountName	string A fully-qualified path representing ServiceAccount resource.

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

matchProjectFromTerraformVersionName(terraformVersionName)

matchProjectFromTerraformVersionName(terraformVersionName: string): string | number;

Parse the project from TerraformVersion resource.

Parameter
Name	Description
terraformVersionName	string A fully-qualified path representing TerraformVersion resource.

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

matchProjectFromWorkerPoolName(workerPoolName)

matchProjectFromWorkerPoolName(workerPoolName: string): string | number;

Parse the project from WorkerPool resource.

Parameter
Name	Description
workerPoolName	string A fully-qualified path representing WorkerPool resource.

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

matchResourceChangeFromResourceChangeName(resourceChangeName)

matchResourceChangeFromResourceChangeName(resourceChangeName: string): string | number;

Parse the resource_change from ResourceChange resource.

Parameter
Name	Description
resourceChangeName	string A fully-qualified path representing ResourceChange resource.

Returns
Type	Description
string | number	{string} A string representing the resource_change.

matchResourceDriftFromResourceDriftName(resourceDriftName)

matchResourceDriftFromResourceDriftName(resourceDriftName: string): string | number;

Parse the resource_drift from ResourceDrift resource.

Parameter
Name	Description
resourceDriftName	string A fully-qualified path representing ResourceDrift resource.

Returns
Type	Description
string | number	{string} A string representing the resource_drift.

matchResourceFromResourceName(resourceName)

matchResourceFromResourceName(resourceName: string): string | number;

Parse the resource from Resource resource.

Parameter
Name	Description
resourceName	string A fully-qualified path representing Resource resource.

Returns
Type	Description
string | number	{string} A string representing the resource.

matchRevisionFromDeploymentGroupRevisionName(deploymentGroupRevisionName)

matchRevisionFromDeploymentGroupRevisionName(deploymentGroupRevisionName: string): string | number;

Parse the revision from DeploymentGroupRevision resource.

Parameter
Name	Description
deploymentGroupRevisionName	string A fully-qualified path representing DeploymentGroupRevision resource.

Returns
Type	Description
string | number	{string} A string representing the revision.

matchRevisionFromResourceName(resourceName)

matchRevisionFromResourceName(resourceName: string): string | number;

Parse the revision from Resource resource.

Parameter
Name	Description
resourceName	string A fully-qualified path representing Resource resource.

Returns
Type	Description
string | number	{string} A string representing the revision.

matchRevisionFromRevisionName(revisionName)

matchRevisionFromRevisionName(revisionName: string): string | number;

Parse the revision from Revision resource.

Parameter
Name	Description
revisionName	string A fully-qualified path representing Revision resource.

Returns
Type	Description
string | number	{string} A string representing the revision.

matchServiceAccountFromServiceAccountName(serviceAccountName)

matchServiceAccountFromServiceAccountName(serviceAccountName: string): string | number;

Parse the service_account from ServiceAccount resource.

Parameter
Name	Description
serviceAccountName	string A fully-qualified path representing ServiceAccount resource.

Returns
Type	Description
string | number	{string} A string representing the service_account.

matchTerraformVersionFromTerraformVersionName(terraformVersionName)

matchTerraformVersionFromTerraformVersionName(terraformVersionName: string): string | number;

Parse the terraform_version from TerraformVersion resource.

Parameter
Name	Description
terraformVersionName	string A fully-qualified path representing TerraformVersion resource.

Returns
Type	Description
string | number	{string} A string representing the terraform_version.

matchWorkerPoolFromWorkerPoolName(workerPoolName)

matchWorkerPoolFromWorkerPoolName(workerPoolName: string): string | number;

Parse the worker_pool from WorkerPool resource.

Parameter
Name	Description
workerPoolName	string A fully-qualified path representing WorkerPool resource.

Returns
Type	Description
string | number	{string} A string representing the worker_pool.

previewPath(project, location, preview)

previewPath(project: string, location: string, preview: string): string;

Return a fully-qualified preview resource name string.

Parameters
Name	Description
project	string
location	string
preview	string

Returns
Type	Description
string	{string} Resource name string.

provisionDeploymentGroup(request, options)

provisionDeploymentGroup(request?: protos.google.cloud.config.v1.IProvisionDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Provisions a deployment group.

NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the *last successful* DeploymentGroupRevision but are *no longer* included in the *current* definition (e.g., following an UpdateDeploymentGroup call), along with their actuated resources.

Parameters
Name	Description
request	IProvisionDeploymentGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment group to provision.
   *  Format:
   *  'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
   */
  // const name = 'abc123'
  /**
   *  Optional. The deployment specs of the deployment units to be created within
   *  the same project and location of the deployment group. The key is the unit
   *  ID, and the value is the `DeploymentSpec`. Provisioning will fail if a
   *  `deployment_spec` has a `deployment_id` that matches an existing deployment
   *  in the same project and location. If an existing deployment was part of the
   *  last successful revision but is no longer in the current DeploymentGroup's
   *  `deployment_units`, it will be recreated if included in `deployment_specs`.
   */
  // const deploymentSpecs = [1,2,3,4]

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callProvisionDeploymentGroup();

provisionDeploymentGroup(request, options, callback)

provisionDeploymentGroup(request: protos.google.cloud.config.v1.IProvisionDeploymentGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IProvisionDeploymentGroupRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

provisionDeploymentGroup(request, callback)

provisionDeploymentGroup(request: protos.google.cloud.config.v1.IProvisionDeploymentGroupRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IProvisionDeploymentGroupRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

resourceChangePath(project, location, preview, resourceChange)

resourceChangePath(project: string, location: string, preview: string, resourceChange: string): string;

Return a fully-qualified resourceChange resource name string.

Parameters
Name	Description
project	string
location	string
preview	string
resourceChange	string

Returns
Type	Description
string	{string} Resource name string.

resourceDriftPath(project, location, preview, resourceDrift)

resourceDriftPath(project: string, location: string, preview: string, resourceDrift: string): string;

Return a fully-qualified resourceDrift resource name string.

Parameters
Name	Description
project	string
location	string
preview	string
resourceDrift	string

Returns
Type	Description
string	{string} Resource name string.

resourcePath(project, location, deployment, revision, resource)

resourcePath(project: string, location: string, deployment: string, revision: string, resource: string): string;

Return a fully-qualified resource resource name string.

Parameters
Name	Description
project	string
location	string
deployment	string
revision	string
resource	string

Returns
Type	Description
string	{string} Resource name string.

revisionPath(project, location, deployment, revision)

revisionPath(project: string, location: string, deployment: string, revision: string): string;

Return a fully-qualified revision resource name string.

Parameters
Name	Description
project	string
location	string
deployment	string
revision	string

Returns
Type	Description
string	{string} Resource name string.

serviceAccountPath(project, serviceAccount)

serviceAccountPath(project: string, serviceAccount: string): string;

Return a fully-qualified serviceAccount resource name string.

Parameters
Name	Description
project	string
serviceAccount	string

Returns
Type	Description
string	{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

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

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

Parameters
Name	Description
request	IamProtos.google.iam.v1.SetIamPolicyRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.Policy]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

terraformVersionPath(project, location, terraformVersion)

terraformVersionPath(project: string, location: string, terraformVersion: string): string;

Return a fully-qualified terraformVersion resource name string.

Parameters
Name	Description
project	string
location	string
terraformVersion	string

Returns
Type	Description
string	{string} Resource name string.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

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

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

Parameters
Name	Description
request	IamProtos.google.iam.v1.TestIamPermissionsRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.TestIamPermissionsResponse]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

unlockDeployment(request, options)

unlockDeployment(request?: protos.google.cloud.config.v1.IUnlockDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Unlocks a locked deployment.

Parameters
Name	Description
request	IUnlockDeploymentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment in the format:
   *  'projects/{project_id}/locations/{location}/deployments/{deployment}'.
   */
  // const name = 'abc123'
  /**
   *  Required. Lock ID of the lock file to be unlocked.
   */
  // const lockId = 1234

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

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

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

  callUnlockDeployment();

unlockDeployment(request, options, callback)

unlockDeployment(request: protos.google.cloud.config.v1.IUnlockDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUnlockDeploymentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

unlockDeployment(request, callback)

unlockDeployment(request: protos.google.cloud.config.v1.IUnlockDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUnlockDeploymentRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateAutoMigrationConfig(request, options)

updateAutoMigrationConfig(request?: protos.google.cloud.config.v1.IUpdateAutoMigrationConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the AutoMigrationConfig for a given project and location.

Parameters
Name	Description
request	IUpdateAutoMigrationConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. The update mask applies to the resource. See
   *  google.protobuf.FieldMask google.protobuf.FieldMask.
   */
  // const updateMask = {}
  /**
   *  Required. The AutoMigrationConfig to update.
   */
  // const autoMigrationConfig = {}

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callUpdateAutoMigrationConfig() {
    // Construct request
    const request = {
      autoMigrationConfig,
    };

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

  callUpdateAutoMigrationConfig();

updateAutoMigrationConfig(request, options, callback)

updateAutoMigrationConfig(request: protos.google.cloud.config.v1.IUpdateAutoMigrationConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateAutoMigrationConfigRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateAutoMigrationConfig(request, callback)

updateAutoMigrationConfig(request: protos.google.cloud.config.v1.IUpdateAutoMigrationConfigRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateAutoMigrationConfigRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IAutoMigrationConfig, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateDeployment(request, options)

updateDeployment(request?: protos.google.cloud.config.v1.IUpdateDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a .

Parameters
Name	Description
request	IUpdateDeploymentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Field mask used to specify the fields to be overwritten in the
   *  Deployment resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. Deployment google.cloud.config.v1.Deployment  to update.
   *  The deployment's `name` field is used to identify the resource to be
   *  updated. Format:
   *  `projects/{project}/locations/{location}/deployments/{deployment}`
   */
  // const deployment = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callUpdateDeployment() {
    // Construct request
    const request = {
      deployment,
    };

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

  callUpdateDeployment();

updateDeployment(request, options, callback)

updateDeployment(request: protos.google.cloud.config.v1.IUpdateDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateDeploymentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateDeployment(request, callback)

updateDeployment(request: protos.google.cloud.config.v1.IUpdateDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateDeploymentRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeployment, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateDeploymentGroup(request, options)

updateDeploymentGroup(request?: protos.google.cloud.config.v1.IUpdateDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a

Parameters
Name	Description
request	IUpdateDeploymentGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Field mask used to specify the fields to be overwritten in the
   *  Deployment Group resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. DeploymentGroup google.cloud.config.v1.DeploymentGroup  to
   *  update.
   *  The deployment group's `name` field is used to identify the resource to be
   *  updated. Format:
   *  `projects/{project}/locations/{location}/deploymentGroups/{deployment_group_id}`
   */
  // const deploymentGroup = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Config library
  const {ConfigClient} = require('@google-cloud/config').v1;

  // Instantiates a client
  const configClient = new ConfigClient();

  async function callUpdateDeploymentGroup() {
    // Construct request
    const request = {
      deploymentGroup,
    };

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

  callUpdateDeploymentGroup();

updateDeploymentGroup(request, options, callback)

updateDeploymentGroup(request: protos.google.cloud.config.v1.IUpdateDeploymentGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateDeploymentGroupRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateDeploymentGroup(request, callback)

updateDeploymentGroup(request: protos.google.cloud.config.v1.IUpdateDeploymentGroupRequest, callback: Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateDeploymentGroupRequest
callback	Callback<LROperation<protos.google.cloud.config.v1.IDeploymentGroup, protos.google.cloud.config.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

workerPoolPath(project, location, workerPool)

workerPoolPath(project: string, location: string, workerPool: string): string;

Return a fully-qualified workerPool resource name string.

Parameters
Name	Description
project	string
location	string
workerPool	string

Returns
Type	Description
string	{string} Resource name string.