Class v1beta1.EnvironmentsClient (3.6.0)

Managed Apache Airflow Environments. v1beta1

Package

@google-cloud/orchestration-airflow

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of EnvironmentsClient.

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 EnvironmentsClient({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;

descriptors

descriptors: Descriptors;

environmentsStub

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

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

cancelOperation(request, options, callback)

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

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

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.

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

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

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

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

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

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

checkCheckUpgradeProgress(name)

checkCheckUpgradeProgress(name: string): Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.CheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.CheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The resource name of the environment to check upgrade for, in the
   *  form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const environment = 'abc123'
  /**
   *  The version of the software running in the environment.
   *  This encapsulates both the version of Cloud Composer functionality and the
   *  version of Apache Airflow. It must match the regular expression
   *  `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`.
   *  When used as input, the server also checks if the provided version is
   *  supported and denies the request for an unsupported version.
   *  The Cloud Composer portion of the image version is a full
   *  semantic version (https://semver.org), or an alias in the form of major
   *  version number or `latest`. When an alias is provided, the server replaces
   *  it with the current Cloud Composer version that satisfies the alias.
   *  The Apache Airflow portion of the image version is a full semantic version
   *  that points to one of the supported Apache Airflow versions, or an alias in
   *  the form of only major or major.minor versions specified. When an alias is
   *  provided, the server replaces it with the latest Apache Airflow version
   *  that satisfies the alias and is supported in the given Cloud Composer
   *  version.
   *  In all cases, the resolved image version is stored in the same field.
   *  See also version
   *  list (/composer/docs/concepts/versioning/composer-versions) and versioning
   *  overview (/composer/docs/concepts/versioning/composer-versioning-overview).
   */
  // const imageVersion = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callCheckUpgrade() {
    // Construct request
    const request = {
    };

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

  callCheckUpgrade();

checkCreateEnvironmentProgress(name)

checkCreateEnvironmentProgress(name: string): Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.Environment, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.Environment, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The parent must be of the form
   *  "projects/{projectId}/locations/{locationId}".
   */
  // const parent = 'abc123'
  /**
   *  The environment to create.
   */
  // const environment = {}

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callCreateEnvironment() {
    // Construct request
    const request = {
    };

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

  callCreateEnvironment();

checkDatabaseFailoverProgress(name)

checkDatabaseFailoverProgress(name: string): Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.DatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.DatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  Target environment:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const environment = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callDatabaseFailover() {
    // Construct request
    const request = {
    };

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

  callDatabaseFailover();

checkDeleteEnvironmentProgress(name)

checkDeleteEnvironmentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The environment to delete, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callDeleteEnvironment() {
    // Construct request
    const request = {
    };

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

  callDeleteEnvironment();

checkLoadSnapshotProgress(name)

checkLoadSnapshotProgress(name: string): Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.LoadSnapshotResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.LoadSnapshotResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The resource name of the target environment in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const environment = 'abc123'
  /**
   *  A Cloud Storage path to a snapshot to load, e.g.:
   *  "gs://my-bucket/snapshots/project_location_environment_timestamp".
   */
  // const snapshotPath = 'abc123'
  /**
   *  Whether or not to skip installing Pypi packages when loading the
   *  environment's state.
   */
  // const skipPypiPackagesInstallation = true
  /**
   *  Whether or not to skip setting environment variables when loading the
   *  environment's state.
   */
  // const skipEnvironmentVariablesSetting = true
  /**
   *  Whether or not to skip setting Airflow overrides when loading the
   *  environment's state.
   */
  // const skipAirflowOverridesSetting = true
  /**
   *  Whether or not to skip copying Cloud Storage data when loading the
   *  environment's state.
   */
  // const skipGcsDataCopying = true

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callLoadSnapshot() {
    // Construct request
    const request = {
    };

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

  callLoadSnapshot();

checkRestartWebServerProgress(name)

checkRestartWebServerProgress(name: string): Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.Environment, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.Environment, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The resource name of the environment to restart the web server for, in the
   *  form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callRestartWebServer() {
    // Construct request
    const request = {
    };

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

  callRestartWebServer();

checkSaveSnapshotProgress(name)

checkSaveSnapshotProgress(name: string): Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.SaveSnapshotResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.SaveSnapshotResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The resource name of the source environment in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const environment = 'abc123'
  /**
   *  Location in a Cloud Storage where the snapshot is going to be stored, e.g.:
   *  "gs://my-bucket/snapshots".
   */
  // const snapshotLocation = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callSaveSnapshot() {
    // Construct request
    const request = {
    };

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

  callSaveSnapshot();

checkUpdateEnvironmentProgress(name)

checkUpdateEnvironmentProgress(name: string): Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.Environment, protos.google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.Environment, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The relative resource name of the environment to update, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const name = 'abc123'
  /**
   *  A patch environment. Fields specified by the `updateMask` will be copied
   *  from the patch environment into the environment under update.
   */
  // const environment = {}
  /**
   *  Required. A comma-separated list of paths, relative to `Environment`, of
   *  fields to update.
   *  For example, to set the version of scikit-learn to install in the
   *  environment to 0.19.0 and to remove an existing installation of
   *  argparse, the `updateMask` parameter would include the following two
   *  `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and
   *  "config.softwareConfig.pypiPackages.argparse". The included patch
   *  environment would specify the scikit-learn version as follows:
   *      {
   *        "config":{
   *          "softwareConfig":{
   *            "pypiPackages":{
   *              "scikit-learn":"==0.19.0"
   *            }
   *          }
   *        }
   *      }
   *  Note that in the above example, any existing PyPI packages
   *  other than scikit-learn and argparse will be unaffected.
   *  Only one update type may be included in a single request's `updateMask`.
   *  For example, one cannot update both the PyPI packages and
   *  labels in the same request. However, it is possible to update multiple
   *  members of a map field simultaneously in the same request. For example,
   *  to set the labels "label1" and "label2" while clearing "label3" (assuming
   *  it already exists), one can
   *  provide the paths "labels.label1", "labels.label2", and "labels.label3"
   *  and populate the patch environment as follows:
   *      {
   *        "labels":{
   *          "label1":"new-label1-value"
   *          "label2":"new-label2-value"
   *        }
   *      }
   *  Note that in the above example, any existing labels that are not
   *  included in the `updateMask` will be unaffected.
   *  It is also possible to replace an entire map field by providing the
   *  map field's path in the `updateMask`. The new value of the field will
   *  be that which is provided in the patch environment. For example, to
   *  delete all pre-existing user-specified PyPI packages and
   *  install botocore at version 1.7.14, the `updateMask` would contain
   *  the path "config.softwareConfig.pypiPackages", and
   *  the patch environment would be the following:
   *      {
   *        "config":{
   *          "softwareConfig":{
   *            "pypiPackages":{
   *              "botocore":"==1.7.14"
   *            }
   *          }
   *        }
   *      }
   *  **Note:** Only the following fields can be updated:
   *  * `config.softwareConfig.pypiPackages`
   *      * Replace all custom custom PyPI packages. If a replacement
   *        package map is not included in `environment`, all custom
   *        PyPI packages are cleared. It is an error to provide both
   *        this mask and a mask specifying an individual package.
   *  * `config.softwareConfig.pypiPackages.`packagename
   *      * Update the custom PyPI package *packagename*,
   *        preserving other packages. To delete the package, include it in
   *        `updateMask`, and omit the mapping for it in
   *        `environment.config.softwareConfig.pypiPackages`. It is an error
   *        to provide both a mask of this form and the
   *        `config.softwareConfig.pypiPackages` mask.
   *  * `labels`
   *      * Replace all environment labels. If a replacement labels map is not
   *        included in `environment`, all labels are cleared. It is an error to
   *        provide both this mask and a mask specifying one or more individual
   *        labels.
   *  * `labels.`labelName
   *      * Set the label named *labelName*, while preserving other
   *        labels. To delete the label, include it in `updateMask` and omit its
   *        mapping in `environment.labels`. It is an error to provide both a
   *        mask of this form and the `labels` mask.
   *  * `config.nodeCount`
   *      * Horizontally scale the number of nodes in the environment. An integer
   *        greater than or equal to 3 must be provided in the `config.nodeCount`
   *        field. Supported for Cloud Composer environments in versions
   *        composer-1.*.*-airflow-*.*.*.
   *  * `config.webServerNetworkAccessControl`
   *      * Replace the environment's current WebServerNetworkAccessControl.
   *  * `config.softwareConfig.airflowConfigOverrides`
   *      * Replace all Apache Airflow config overrides. If a replacement config
   *        overrides map is not included in `environment`, all config overrides
   *        are cleared.
   *        It is an error to provide both this mask and a mask specifying one or
   *        more individual config overrides.
   *  * `config.softwareConfig.airflowConfigOverrides.`section-name
   *      * Override the Apache Airflow config property *name* in the
   *        section named *section*, preserving other properties. To
   *        delete the property override, include it in `updateMask` and omit its
   *        mapping in
   *        `environment.config.softwareConfig.airflowConfigOverrides`.
   *        It is an error to provide both a mask of this form and the
   *        `config.softwareConfig.airflowConfigOverrides` mask.
   *  * `config.softwareConfig.envVariables`
   *      * Replace all environment variables. If a replacement environment
   *        variable map is not included in `environment`, all custom environment
   *        variables are cleared.
   *  * `config.softwareConfig.imageVersion`
   *      * Upgrade the version of the environment in-place. Refer to
   *        `SoftwareConfig.image_version` for information on how to format the
   *        new image version. Additionally, the new image version cannot effect
   *        a version downgrade, and must match the current image version's
   *        Composer and Airflow major versions. Consult the Cloud Composer
   *        version list (/composer/docs/concepts/versioning/composer-versions)
   *        for valid values.
   *  * `config.softwareConfig.schedulerCount`
   *      * Horizontally scale the number of schedulers in Airflow. A positive
   *        integer not greater than the number of nodes must be provided in the
   *        `config.softwareConfig.schedulerCount` field. Supported for Cloud
   *        Composer environments in versions composer-1.*.*-airflow-2.*.*.
   *  * `config.softwareConfig.cloudDataLineageIntegration`
   *      * Configuration for Cloud Data Lineage integration.
   *  * `config.databaseConfig.machineType`
   *      * Cloud SQL machine type used by Airflow database.
   *        It has to be one of: db-n1-standard-2, db-n1-standard-4,
   *        db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer
   *        environments in versions composer-1.*.*-airflow-*.*.*.
   *  * `config.webServerConfig.machineType`
   *      * Machine type on which Airflow web server is running.
   *        It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4
   *        or composer-n1-webserver-8. Supported for Cloud Composer environments
   *        in versions composer-1.*.*-airflow-*.*.*.
   *  * `config.maintenanceWindow`
   *      * Maintenance window during which Cloud Composer components may be
   *        under maintenance.
   *  * `config.workloadsConfig`
   *      * The workloads configuration settings for the GKE cluster associated
   *        with the Cloud Composer environment. Supported for Cloud Composer
   *        environments in versions composer-2.*.*-airflow-*.*.* and newer.
   *  * `config.environmentSize`
   *      * The size of the Cloud Composer environment. Supported for Cloud
   *        Composer environments in versions composer-2.*.*-airflow-*.*.* and
   *        newer.
   */
  // const updateMask = {}

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

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

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

  callUpdateEnvironment();

checkUpgrade(request, options)

checkUpgrade(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Check if an upgrade operation on the environment will succeed.

In case of problems detailed info can be found in the returned Operation.

Parameters
Name Description
request ICheckUpgradeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The resource name of the environment to check upgrade for, in the
   *  form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const environment = 'abc123'
  /**
   *  The version of the software running in the environment.
   *  This encapsulates both the version of Cloud Composer functionality and the
   *  version of Apache Airflow. It must match the regular expression
   *  `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`.
   *  When used as input, the server also checks if the provided version is
   *  supported and denies the request for an unsupported version.
   *  The Cloud Composer portion of the image version is a full
   *  semantic version (https://semver.org), or an alias in the form of major
   *  version number or `latest`. When an alias is provided, the server replaces
   *  it with the current Cloud Composer version that satisfies the alias.
   *  The Apache Airflow portion of the image version is a full semantic version
   *  that points to one of the supported Apache Airflow versions, or an alias in
   *  the form of only major or major.minor versions specified. When an alias is
   *  provided, the server replaces it with the latest Apache Airflow version
   *  that satisfies the alias and is supported in the given Cloud Composer
   *  version.
   *  In all cases, the resolved image version is stored in the same field.
   *  See also version
   *  list (/composer/docs/concepts/versioning/composer-versions) and versioning
   *  overview (/composer/docs/concepts/versioning/composer-versioning-overview).
   */
  // const imageVersion = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callCheckUpgrade() {
    // Construct request
    const request = {
    };

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

  callCheckUpgrade();

checkUpgrade(request, options, callback)

checkUpgrade(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICheckUpgradeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

checkUpgrade(request, callback)

checkUpgrade(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeRequest, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICheckUpgradeRequest
callback Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.

createEnvironment(request, options)

createEnvironment(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateEnvironmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Create a new environment.

Parameters
Name Description
request ICreateEnvironmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The parent must be of the form
   *  "projects/{projectId}/locations/{locationId}".
   */
  // const parent = 'abc123'
  /**
   *  The environment to create.
   */
  // const environment = {}

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callCreateEnvironment() {
    // Construct request
    const request = {
    };

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

  callCreateEnvironment();

createEnvironment(request, options, callback)

createEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEnvironmentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createEnvironment(request, callback)

createEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateEnvironmentRequest, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEnvironmentRequest
callback Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createUserWorkloadsConfigMap(request, options)

createUserWorkloadsConfigMap(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest | undefined),
        {} | undefined
    ]>;

Creates a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

Parameters
Name Description
request ICreateUserWorkloadsConfigMapRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, (protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserWorkloadsConfigMap. 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 environment name to create a ConfigMap for, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const parent = 'abc123'
  /**
   *  Required. User workloads ConfigMap to create.
   */
  // const userWorkloadsConfigMap = {}

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

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

    // Run request
    const response = await serviceClient.createUserWorkloadsConfigMap(request);
    console.log(response);
  }

  callCreateUserWorkloadsConfigMap();

createUserWorkloadsConfigMap(request, options, callback)

createUserWorkloadsConfigMap(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateUserWorkloadsConfigMapRequest
options CallOptions
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createUserWorkloadsConfigMap(request, callback)

createUserWorkloadsConfigMap(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateUserWorkloadsConfigMapRequest
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createUserWorkloadsSecret(request, options)

createUserWorkloadsSecret(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest | undefined),
        {} | undefined
    ]>;

Creates a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

Parameters
Name Description
request ICreateUserWorkloadsSecretRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, (protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserWorkloadsSecret. 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 environment name to create a Secret for, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const parent = 'abc123'
  /**
   *  Required. User workloads Secret to create.
   */
  // const userWorkloadsSecret = {}

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

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

    // Run request
    const response = await serviceClient.createUserWorkloadsSecret(request);
    console.log(response);
  }

  callCreateUserWorkloadsSecret();

createUserWorkloadsSecret(request, options, callback)

createUserWorkloadsSecret(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateUserWorkloadsSecretRequest
options CallOptions
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createUserWorkloadsSecret(request, callback)

createUserWorkloadsSecret(request: protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateUserWorkloadsSecretRequest
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, protos.google.cloud.orchestration.airflow.service.v1beta1.ICreateUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

databaseFailover(request, options)

databaseFailover(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Triggers database failover (only for highly resilient environments).

Parameters
Name Description
request IDatabaseFailoverRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  Target environment:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const environment = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callDatabaseFailover() {
    // Construct request
    const request = {
    };

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

  callDatabaseFailover();

databaseFailover(request, options, callback)

databaseFailover(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDatabaseFailoverRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

databaseFailover(request, callback)

databaseFailover(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverRequest, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDatabaseFailoverRequest
callback Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1beta1.IDatabaseFailoverResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteEnvironment(request, options)

deleteEnvironment(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteEnvironmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Delete an environment.

Parameters
Name Description
request IDeleteEnvironmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.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.
   */
  /**
   *  The environment to delete, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callDeleteEnvironment() {
    // Construct request
    const request = {
    };

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

  callDeleteEnvironment();

deleteEnvironment(request, options, callback)

deleteEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteEnvironmentRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteEnvironment(request, callback)

deleteEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteEnvironmentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteEnvironmentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, options, callback)

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

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

Parameters
Name Description
request DeleteOperationRequest

The request object that will be sent.

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

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

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

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

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

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

deleteUserWorkloadsConfigMap(request, options)

deleteUserWorkloadsConfigMap(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest | undefined),
        {} | undefined
    ]>;

Deletes a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

Parameters
Name Description
request IDeleteUserWorkloadsConfigMapRequest

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.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest | 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 ConfigMap to delete, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

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

    // Run request
    const response = await serviceClient.deleteUserWorkloadsConfigMap(request);
    console.log(response);
  }

  callDeleteUserWorkloadsConfigMap();

deleteUserWorkloadsConfigMap(request, options, callback)

deleteUserWorkloadsConfigMap(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteUserWorkloadsConfigMapRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteUserWorkloadsConfigMap(request, callback)

deleteUserWorkloadsConfigMap(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteUserWorkloadsConfigMapRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteUserWorkloadsSecret(request, options)

deleteUserWorkloadsSecret(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest | undefined),
        {} | undefined
    ]>;

Deletes a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

Parameters
Name Description
request IDeleteUserWorkloadsSecretRequest

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.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest | 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 Secret to delete, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

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

    // Run request
    const response = await serviceClient.deleteUserWorkloadsSecret(request);
    console.log(response);
  }

  callDeleteUserWorkloadsSecret();

deleteUserWorkloadsSecret(request, options, callback)

deleteUserWorkloadsSecret(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteUserWorkloadsSecretRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteUserWorkloadsSecret(request, callback)

deleteUserWorkloadsSecret(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteUserWorkloadsSecretRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1beta1.IDeleteUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

environmentPath(project, location, environment)

environmentPath(project: string, location: string, environment: string): string;

Return a fully-qualified environment resource name string.

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

{string} Resource name string.

executeAirflowCommand(request, options)

executeAirflowCommand(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandResponse,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest | undefined),
        {} | undefined
    ]>;

Executes Airflow CLI command.

Parameters
Name Description
request IExecuteAirflowCommandRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandResponse, (protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ExecuteAirflowCommandResponse. 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.
   */
  /**
   *  The resource name of the environment in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}".
   */
  // const environment = 'abc123'
  /**
   *  Airflow command.
   */
  // const command = 'abc123'
  /**
   *  Airflow subcommand.
   */
  // const subcommand = 'abc123'
  /**
   *  Parameters for the Airflow command/subcommand as an array of arguments.
   *  It may contain positional arguments like `["my-dag-id"]`, key-value
   *  parameters like `["--foo=bar"]` or `["--foo","bar"]`,
   *  or other flags like `["-f"]`.
   */
  // const parameters = ['abc','def']

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callExecuteAirflowCommand() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await serviceClient.executeAirflowCommand(request);
    console.log(response);
  }

  callExecuteAirflowCommand();

executeAirflowCommand(request, options, callback)

executeAirflowCommand(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExecuteAirflowCommandRequest
options CallOptions
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

executeAirflowCommand(request, callback)

executeAirflowCommand(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExecuteAirflowCommandRequest
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IExecuteAirflowCommandRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

fetchDatabaseProperties(request, options)

fetchDatabaseProperties(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesResponse,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest | undefined),
        {} | undefined
    ]>;

Fetches database properties.

Parameters
Name Description
request IFetchDatabasePropertiesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesResponse, (protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing FetchDatabasePropertiesResponse. Please see the documentation for more details and examples.

Example

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

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callFetchDatabaseProperties() {
    // Construct request
    const request = {
      environment,
    };

    // Run request
    const response = await serviceClient.fetchDatabaseProperties(request);
    console.log(response);
  }

  callFetchDatabaseProperties();

fetchDatabaseProperties(request, options, callback)

fetchDatabaseProperties(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IFetchDatabasePropertiesRequest
options CallOptions
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

fetchDatabaseProperties(request, callback)

fetchDatabaseProperties(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IFetchDatabasePropertiesRequest
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesResponse, protos.google.cloud.orchestration.airflow.service.v1beta1.IFetchDatabasePropertiesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEnvironment(request, options)

getEnvironment(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest | undefined),
        {} | undefined
    ]>;

Get an existing environment.

Parameters
Name Description
request IGetEnvironmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, (protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest | 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.
   */
  /**
   *  The resource name of the environment to get, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

  async function callGetEnvironment() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await serviceClient.getEnvironment(request);
    console.log(response);
  }

  callGetEnvironment();

getEnvironment(request, options, callback)

getEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEnvironmentRequest
options CallOptions
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEnvironment(request, callback)

getEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEnvironmentRequest
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOperation(request, options, callback)

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

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

Parameters
Name Description
request GetOperationRequest

The request object that will be sent.

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

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

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

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

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

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

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

getProjectId()

getProjectId(): Promise<string>;
Returns
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

getUserWorkloadsConfigMap(request, options)

getUserWorkloadsConfigMap(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest | undefined),
        {} | undefined
    ]>;

Gets an existing user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

Parameters
Name Description
request IGetUserWorkloadsConfigMapRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, (protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserWorkloadsConfigMap. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the ConfigMap to get, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

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

    // Run request
    const response = await serviceClient.getUserWorkloadsConfigMap(request);
    console.log(response);
  }

  callGetUserWorkloadsConfigMap();

getUserWorkloadsConfigMap(request, options, callback)

getUserWorkloadsConfigMap(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetUserWorkloadsConfigMapRequest
options CallOptions
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getUserWorkloadsConfigMap(request, callback)

getUserWorkloadsConfigMap(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetUserWorkloadsConfigMapRequest
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsConfigMap, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsConfigMapRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getUserWorkloadsSecret(request, options)

getUserWorkloadsSecret(request?: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret,
        (protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest | undefined),
        {} | undefined
    ]>;

Gets an existing user workloads Secret. Values of the "data" field in the response are cleared.

This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

Parameters
Name Description
request IGetUserWorkloadsSecretRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, (protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserWorkloadsSecret. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Secret to get, in the form:
   *  "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
   */
  // const name = 'abc123'

  // Imports the Service library
  const {EnvironmentsClient} = require('@google-cloud/orchestration-airflow').v1beta1;

  // Instantiates a client
  const serviceClient = new EnvironmentsClient();

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

    // Run request
    const response = await serviceClient.getUserWorkloadsSecret(request);
    console.log(response);
  }

  callGetUserWorkloadsSecret();

getUserWorkloadsSecret(request, options, callback)

getUserWorkloadsSecret(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetUserWorkloadsSecretRequest
options CallOptions
callback Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getUserWorkloadsSecret(request, callback)

getUserWorkloadsSecret(request: protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1beta1.IUserWorkloadsSecret, protos.google.cloud.orchestration.airflow.service.v1beta1.IGetUserWorkloadsSecretRequest | null | undefined, {} | null | undefined>)