Class v1.EnvironmentsClient (1.0.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

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;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

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

Methods

checkCreateEnvironmentProgress(name)

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

  /**
   * 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').v1;

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

checkDeleteEnvironmentProgress(name)

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

  /**
   * 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').v1;

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

checkUpdateEnvironmentProgress(name)

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

  /**
   * 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
   *  numpy, the `updateMask` parameter would include the following two
   *  `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and
   *  "config.softwareConfig.pypiPackages.numpy". 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 numpy 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.
   *  * `config.webServerNetworkAccessControl`
   *      * Replace the environment's current `WebServerNetworkAccessControl`.
   *  * `config.databaseConfig`
   *      * Replace the environment's current `DatabaseConfig`.
   *  * `config.webServerConfig`
   *      * Replace the environment's current `WebServerConfig`.
   *  * `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.
   *        It is an error to provide both this mask and a mask specifying one or
   *        more individual environment variables.
   */
  // const updateMask = {}

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

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

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

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

  callUpdateEnvironment();

close()

close(): Promise<void>;

createEnvironment(request, options)

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

  /**
   * 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').v1;

  // 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.v1.ICreateEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createEnvironment(request, callback)

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

deleteEnvironment(request, options)

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

  /**
   * 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').v1;

  // 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.v1.IDeleteEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.orchestration.airflow.service.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteEnvironment(request, callback)

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

environmentPath(project, location, environment)

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

getEnvironment(request, options)

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

  /**
   * 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').v1;

  // 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.v1.IGetEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;

getEnvironment(request, callback)

getEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1.IGetEnvironmentRequest, callback: Callback<protos.google.cloud.orchestration.airflow.service.v1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

initialize()

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

listEnvironments(request, options)

listEnvironments(request?: protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.orchestration.airflow.service.v1.IEnvironment[],
        protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest | null,
        protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsResponse
    ]>;

listEnvironments(request, options, callback)

listEnvironments(request: protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest, protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.orchestration.airflow.service.v1.IEnvironment>): void;

listEnvironments(request, callback)

listEnvironments(request: protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest, callback: PaginationCallback<protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest, protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.orchestration.airflow.service.v1.IEnvironment>): void;

listEnvironmentsAsync(request, options)

listEnvironmentsAsync(request?: protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.orchestration.airflow.service.v1.IEnvironment>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  List environments in the given project and location, in the form:
   *  "projects/{projectId}/locations/{locationId}"
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of environments to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListEnvironments();

listEnvironmentsStream(request, options)

listEnvironmentsStream(request?: protos.google.cloud.orchestration.airflow.service.v1.IListEnvironmentsRequest, options?: CallOptions): Transform;

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

updateEnvironment(request, options)

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

  /**
   * 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
   *  numpy, the `updateMask` parameter would include the following two
   *  `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and
   *  "config.softwareConfig.pypiPackages.numpy". 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 numpy 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.
   *  * `config.webServerNetworkAccessControl`
   *      * Replace the environment's current `WebServerNetworkAccessControl`.
   *  * `config.databaseConfig`
   *      * Replace the environment's current `DatabaseConfig`.
   *  * `config.webServerConfig`
   *      * Replace the environment's current `WebServerConfig`.
   *  * `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.
   *        It is an error to provide both this mask and a mask specifying one or
   *        more individual environment variables.
   */
  // const updateMask = {}

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

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

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

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

  callUpdateEnvironment();

updateEnvironment(request, options, callback)

updateEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1.IUpdateEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateEnvironment(request, callback)

updateEnvironment(request: protos.google.cloud.orchestration.airflow.service.v1.IUpdateEnvironmentRequest, callback: Callback<LROperation<protos.google.cloud.orchestration.airflow.service.v1.IEnvironment, protos.google.cloud.orchestration.airflow.service.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;