Class protos.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig (2.3.2)

Represents an EnvironmentConfig.

Package

@google-cloud/orchestration-airflow

Constructors

(constructor)(properties)

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

Constructs a new EnvironmentConfig.

Parameter
Name Description
properties IEnvironmentConfig

Properties to set

Properties

airflowUri

public airflowUri: string;

EnvironmentConfig airflowUri.

dagGcsPrefix

public dagGcsPrefix: string;

EnvironmentConfig dagGcsPrefix.

databaseConfig

public databaseConfig?: (google.cloud.orchestration.airflow.service.v1.IDatabaseConfig|null);

EnvironmentConfig databaseConfig.

encryptionConfig

public encryptionConfig?: (google.cloud.orchestration.airflow.service.v1.IEncryptionConfig|null);

EnvironmentConfig encryptionConfig.

environmentSize

public environmentSize: (google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize|keyof typeof google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize);

EnvironmentConfig environmentSize.

gkeCluster

public gkeCluster: string;

EnvironmentConfig gkeCluster.

maintenanceWindow

public maintenanceWindow?: (google.cloud.orchestration.airflow.service.v1.IMaintenanceWindow|null);

EnvironmentConfig maintenanceWindow.

masterAuthorizedNetworksConfig

public masterAuthorizedNetworksConfig?: (google.cloud.orchestration.airflow.service.v1.IMasterAuthorizedNetworksConfig|null);

EnvironmentConfig masterAuthorizedNetworksConfig.

nodeConfig

public nodeConfig?: (google.cloud.orchestration.airflow.service.v1.INodeConfig|null);

EnvironmentConfig nodeConfig.

nodeCount

public nodeCount: number;

EnvironmentConfig nodeCount.

privateEnvironmentConfig

public privateEnvironmentConfig?: (google.cloud.orchestration.airflow.service.v1.IPrivateEnvironmentConfig|null);

EnvironmentConfig privateEnvironmentConfig.

recoveryConfig

public recoveryConfig?: (google.cloud.orchestration.airflow.service.v1.IRecoveryConfig|null);

EnvironmentConfig recoveryConfig.

softwareConfig

public softwareConfig?: (google.cloud.orchestration.airflow.service.v1.ISoftwareConfig|null);

EnvironmentConfig softwareConfig.

webServerConfig

public webServerConfig?: (google.cloud.orchestration.airflow.service.v1.IWebServerConfig|null);

EnvironmentConfig webServerConfig.

webServerNetworkAccessControl

public webServerNetworkAccessControl?: (google.cloud.orchestration.airflow.service.v1.IWebServerNetworkAccessControl|null);

EnvironmentConfig webServerNetworkAccessControl.

workloadsConfig

public workloadsConfig?: (google.cloud.orchestration.airflow.service.v1.IWorkloadsConfig|null);

EnvironmentConfig workloadsConfig.

Methods

create(properties)

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

Creates a new EnvironmentConfig instance using the specified properties.

Parameter
Name Description
properties IEnvironmentConfig

Properties to set
Returns
Type Description
google.cloud.orchestration.airflow.service.v1.EnvironmentConfig

EnvironmentConfig instance

decode(reader, length)

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

Decodes an EnvironmentConfig message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.orchestration.airflow.service.v1.EnvironmentConfig

EnvironmentConfig

decodeDelimited(reader)

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

Decodes an EnvironmentConfig message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.orchestration.airflow.service.v1.EnvironmentConfig

EnvironmentConfig

encode(message, writer)

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

Encodes the specified EnvironmentConfig message. Does not implicitly messages.

Parameters
Name Description
message IEnvironmentConfig

EnvironmentConfig message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Name Description
message IEnvironmentConfig

EnvironmentConfig message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
google.cloud.orchestration.airflow.service.v1.EnvironmentConfig

EnvironmentConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EnvironmentConfig

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

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

Converts this EnvironmentConfig to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.orchestration.airflow.service.v1.EnvironmentConfig

EnvironmentConfig
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an EnvironmentConfig message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not