Method: projects.locations.environments.loadSnapshot

Loads a snapshot of a Cloud Composer environment.

As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.

HTTP request

POST https://composer.googleapis.com/v1/{environment=projects/*/locations/*/environments/*}:loadSnapshot

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
environment

string

The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Authorization requires the following IAM permission on the specified resource environment:

  • composer.environments.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "snapshotPath": string,
  "skipPypiPackagesInstallation": boolean,
  "skipEnvironmentVariablesSetting": boolean,
  "skipAirflowOverridesSetting": boolean,
  "skipGcsDataCopying": boolean
}
Fields
snapshotPath

string

A Cloud Storage path to a snapshot to load, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp".
skipPypiPackagesInstallation

boolean

Whether or not to skip installing Pypi packages when loading the environment's state.
skipEnvironmentVariablesSetting

boolean

Whether or not to skip setting environment variables when loading the environment's state.
skipAirflowOverridesSetting

boolean

Whether or not to skip setting Airflow overrides when loading the environment's state.
skipGcsDataCopying

boolean

Whether or not to skip copying Cloud Storage data when loading the environment's state.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.