Class protos.google.cloud.orchestration.airflow.service.v1.Environment

Represents an Environment.

Package

@google-cloud/orchestration-airflow!

Constructors

(constructor)(properties)

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

Constructs a new Environment.

Parameter
NameDescription
properties IEnvironment

Properties to set

Properties

config

public config?: (google.cloud.orchestration.airflow.service.v1.IEnvironmentConfig|null);

Environment config.

Property Value
TypeDescription
(google.cloud.orchestration.airflow.service.v1.IEnvironmentConfig|null)

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Environment createTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

labels

public labels: { [k: string]: string };

Environment labels.

Property Value
TypeDescription
{ [k: string]: string }

name

public name: string;

Environment name.

Property Value
TypeDescription
string

state

public state: (google.cloud.orchestration.airflow.service.v1.Environment.State|keyof typeof google.cloud.orchestration.airflow.service.v1.Environment.State);

Environment state.

Property Value
TypeDescription
(google.cloud.orchestration.airflow.service.v1.Environment.State|keyof typeof google.cloud.orchestration.airflow.service.v1.Environment.State)

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Environment updateTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

uuid

public uuid: string;

Environment uuid.

Property Value
TypeDescription
string

Methods

create(properties)

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

Creates a new Environment instance using the specified properties.

Parameter
NameDescription
properties IEnvironment

Properties to set

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

Environment instance

decode(reader, length)

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

Decodes an Environment 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.Environment

Environment

decodeDelimited(reader)

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

Decodes an Environment 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.Environment

Environment

encode(message, writer)

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

Encodes the specified Environment message. Does not implicitly messages.

Parameters
NameDescription
message IEnvironment

Environment 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.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IEnvironment

Environment 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.Environment;

Creates an Environment 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.Environment

Environment

toJSON()

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

Converts this Environment to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

Environment

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Environment 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