Google Cloud Orchestration Airflow V1 Client - Class LoadSnapshotRequest (1.6.4)

Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class LoadSnapshotRequest.

Request to load a snapshot into a Cloud Composer environment.

Generated from protobuf message google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest

Namespace

Google \ Cloud \ Orchestration \ Airflow \ Service \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ environment string

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

↳ snapshot_path string

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

↳ skip_pypi_packages_installation bool

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

↳ skip_environment_variables_setting bool

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

↳ skip_airflow_overrides_setting bool

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

↳ skip_gcs_data_copying bool

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

getEnvironment

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

Returns
Type Description
string

setEnvironment

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSnapshotPath

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

Returns
Type Description
string

setSnapshotPath

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSkipPypiPackagesInstallation

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

Returns
Type Description
bool

setSkipPypiPackagesInstallation

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getSkipEnvironmentVariablesSetting

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

Returns
Type Description
bool

setSkipEnvironmentVariablesSetting

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getSkipAirflowOverridesSetting

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

Returns
Type Description
bool

setSkipAirflowOverridesSetting

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getSkipGcsDataCopying

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

Returns
Type Description
bool

setSkipGcsDataCopying

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

Parameter
Name Description
var bool
Returns
Type Description
$this