Class protos.google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest (2.3.1)

Represents a LoadSnapshotRequest.

Package

@google-cloud/orchestration-airflow

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest);

Constructs a new LoadSnapshotRequest.

Parameter
NameDescription
properties google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest

Properties to set

Properties

environment

public environment: string;

LoadSnapshotRequest environment.

skipAirflowOverridesSetting

public skipAirflowOverridesSetting: boolean;

LoadSnapshotRequest skipAirflowOverridesSetting.

skipEnvironmentVariablesSetting

public skipEnvironmentVariablesSetting: boolean;

LoadSnapshotRequest skipEnvironmentVariablesSetting.

skipGcsDataCopying

public skipGcsDataCopying: boolean;

LoadSnapshotRequest skipGcsDataCopying.

skipPypiPackagesInstallation

public skipPypiPackagesInstallation: boolean;

LoadSnapshotRequest skipPypiPackagesInstallation.

snapshotPath

public snapshotPath: string;

LoadSnapshotRequest snapshotPath.

Methods

create(properties)

public static create(properties?: google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest): google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest;

Creates a new LoadSnapshotRequest instance using the specified properties.

Parameter
NameDescription
properties google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest

Properties to set

Returns
TypeDescription
google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest

LoadSnapshotRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest;

Decodes a LoadSnapshotRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest

LoadSnapshotRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest;

Decodes a LoadSnapshotRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest

LoadSnapshotRequest

encode(message, writer)

public static encode(message: google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LoadSnapshotRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest

LoadSnapshotRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LoadSnapshotRequest message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.orchestration.airflow.service.v1.ILoadSnapshotRequest

LoadSnapshotRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest;

Creates a LoadSnapshotRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest

LoadSnapshotRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for LoadSnapshotRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this LoadSnapshotRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a LoadSnapshotRequest message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest

LoadSnapshotRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a LoadSnapshotRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not