Class LoadSnapshotRequest.Builder (1.85.0)

public static final class LoadSnapshotRequest.Builder extends GeneratedMessage.Builder<LoadSnapshotRequest.Builder> implements LoadSnapshotRequestOrBuilder

Request to load a snapshot into a Cloud Composer environment.

Protobuf type google.cloud.orchestration.airflow.service.v1beta1.LoadSnapshotRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public LoadSnapshotRequest build()
Returns
Type Description
LoadSnapshotRequest

buildPartial()

public LoadSnapshotRequest buildPartial()
Returns
Type Description
LoadSnapshotRequest

clear()

public LoadSnapshotRequest.Builder clear()
Returns
Type Description
LoadSnapshotRequest.Builder
Overrides

clearEnvironment()

public LoadSnapshotRequest.Builder clearEnvironment()

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

string environment = 1;

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

clearSkipAirflowOverridesSetting()

public LoadSnapshotRequest.Builder clearSkipAirflowOverridesSetting()

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

bool skip_airflow_overrides_setting = 5;

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

clearSkipEnvironmentVariablesSetting()

public LoadSnapshotRequest.Builder clearSkipEnvironmentVariablesSetting()

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

bool skip_environment_variables_setting = 4;

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

clearSkipGcsDataCopying()

public LoadSnapshotRequest.Builder clearSkipGcsDataCopying()

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

bool skip_gcs_data_copying = 6;

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

clearSkipPypiPackagesInstallation()

public LoadSnapshotRequest.Builder clearSkipPypiPackagesInstallation()

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

bool skip_pypi_packages_installation = 3;

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

clearSnapshotPath()

public LoadSnapshotRequest.Builder clearSnapshotPath()

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

string snapshot_path = 2;

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public LoadSnapshotRequest getDefaultInstanceForType()
Returns
Type Description
LoadSnapshotRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnvironment()

public String getEnvironment()

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

string environment = 1;

Returns
Type Description
String

The environment.

getEnvironmentBytes()

public ByteString getEnvironmentBytes()

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

string environment = 1;

Returns
Type Description
ByteString

The bytes for environment.

getSkipAirflowOverridesSetting()

public boolean getSkipAirflowOverridesSetting()

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

bool skip_airflow_overrides_setting = 5;

Returns
Type Description
boolean

The skipAirflowOverridesSetting.

getSkipEnvironmentVariablesSetting()

public boolean getSkipEnvironmentVariablesSetting()

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

bool skip_environment_variables_setting = 4;

Returns
Type Description
boolean

The skipEnvironmentVariablesSetting.

getSkipGcsDataCopying()

public boolean getSkipGcsDataCopying()

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

bool skip_gcs_data_copying = 6;

Returns
Type Description
boolean

The skipGcsDataCopying.

getSkipPypiPackagesInstallation()

public boolean getSkipPypiPackagesInstallation()

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

bool skip_pypi_packages_installation = 3;

Returns
Type Description
boolean

The skipPypiPackagesInstallation.

getSnapshotPath()

public String getSnapshotPath()

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

string snapshot_path = 2;

Returns
Type Description
String

The snapshotPath.

getSnapshotPathBytes()

public ByteString getSnapshotPathBytes()

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

string snapshot_path = 2;

Returns
Type Description
ByteString

The bytes for snapshotPath.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LoadSnapshotRequest other)

public LoadSnapshotRequest.Builder mergeFrom(LoadSnapshotRequest other)
Parameter
Name Description
other LoadSnapshotRequest
Returns
Type Description
LoadSnapshotRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LoadSnapshotRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LoadSnapshotRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LoadSnapshotRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LoadSnapshotRequest.Builder
Overrides

setEnvironment(String value)

public LoadSnapshotRequest.Builder setEnvironment(String value)

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

string environment = 1;

Parameter
Name Description
value String

The environment to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

setEnvironmentBytes(ByteString value)

public LoadSnapshotRequest.Builder setEnvironmentBytes(ByteString value)

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

string environment = 1;

Parameter
Name Description
value ByteString

The bytes for environment to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

setSkipAirflowOverridesSetting(boolean value)

public LoadSnapshotRequest.Builder setSkipAirflowOverridesSetting(boolean value)

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

bool skip_airflow_overrides_setting = 5;

Parameter
Name Description
value boolean

The skipAirflowOverridesSetting to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

setSkipEnvironmentVariablesSetting(boolean value)

public LoadSnapshotRequest.Builder setSkipEnvironmentVariablesSetting(boolean value)

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

bool skip_environment_variables_setting = 4;

Parameter
Name Description
value boolean

The skipEnvironmentVariablesSetting to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

setSkipGcsDataCopying(boolean value)

public LoadSnapshotRequest.Builder setSkipGcsDataCopying(boolean value)

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

bool skip_gcs_data_copying = 6;

Parameter
Name Description
value boolean

The skipGcsDataCopying to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

setSkipPypiPackagesInstallation(boolean value)

public LoadSnapshotRequest.Builder setSkipPypiPackagesInstallation(boolean value)

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

bool skip_pypi_packages_installation = 3;

Parameter
Name Description
value boolean

The skipPypiPackagesInstallation to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

setSnapshotPath(String value)

public LoadSnapshotRequest.Builder setSnapshotPath(String value)

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

string snapshot_path = 2;

Parameter
Name Description
value String

The snapshotPath to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.

setSnapshotPathBytes(ByteString value)

public LoadSnapshotRequest.Builder setSnapshotPathBytes(ByteString value)

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

string snapshot_path = 2;

Parameter
Name Description
value ByteString

The bytes for snapshotPath to set.

Returns
Type Description
LoadSnapshotRequest.Builder

This builder for chaining.