Class protos.google.cloud.orchestration.airflow.service.v1beta1.Environments

Represents an Environments

Inheritance

$protobuf.rpc.Service > protos.google.cloud.orchestration.airflow.service.v1beta1.Environments

Package

@google-cloud/orchestration-airflow

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Environments service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

checkUpgrade(request, callback)

public checkUpgrade(request: google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeRequest, callback: google.cloud.orchestration.airflow.service.v1beta1.Environments.CheckUpgradeCallback): void;

Calls CheckUpgrade.

Parameters
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeRequest

CheckUpgradeRequest message or plain object

callback google.cloud.orchestration.airflow.service.v1beta1.Environments.CheckUpgradeCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

checkUpgrade(request)

public checkUpgrade(request: google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeRequest): Promise<google.longrunning.Operation>;

Calls CheckUpgrade.

Parameter
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.ICheckUpgradeRequest

CheckUpgradeRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Environments;

Creates new Environments service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
Environments

RPC service. Useful where requests and/or responses are streamed.

createEnvironment(request, callback)

public createEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.ICreateEnvironmentRequest, callback: google.cloud.orchestration.airflow.service.v1beta1.Environments.CreateEnvironmentCallback): void;

Calls CreateEnvironment.

Parameters
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.ICreateEnvironmentRequest

CreateEnvironmentRequest message or plain object

callback google.cloud.orchestration.airflow.service.v1beta1.Environments.CreateEnvironmentCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

createEnvironment(request)

public createEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.ICreateEnvironmentRequest): Promise<google.longrunning.Operation>;

Calls CreateEnvironment.

Parameter
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.ICreateEnvironmentRequest

CreateEnvironmentRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteEnvironment(request, callback)

public deleteEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.IDeleteEnvironmentRequest, callback: google.cloud.orchestration.airflow.service.v1beta1.Environments.DeleteEnvironmentCallback): void;

Calls DeleteEnvironment.

Parameters
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IDeleteEnvironmentRequest

DeleteEnvironmentRequest message or plain object

callback google.cloud.orchestration.airflow.service.v1beta1.Environments.DeleteEnvironmentCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteEnvironment(request)

public deleteEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.IDeleteEnvironmentRequest): Promise<google.longrunning.Operation>;

Calls DeleteEnvironment.

Parameter
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IDeleteEnvironmentRequest

DeleteEnvironmentRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

getEnvironment(request, callback)

public getEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest, callback: google.cloud.orchestration.airflow.service.v1beta1.Environments.GetEnvironmentCallback): void;

Calls GetEnvironment.

Parameters
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest

GetEnvironmentRequest message or plain object

callback google.cloud.orchestration.airflow.service.v1beta1.Environments.GetEnvironmentCallback

Node-style callback called with the error, if any, and Environment

Returns
TypeDescription
void

getEnvironment(request)

public getEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest): Promise<google.cloud.orchestration.airflow.service.v1beta1.Environment>;

Calls GetEnvironment.

Parameter
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IGetEnvironmentRequest

GetEnvironmentRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.orchestration.airflow.service.v1beta1.Environment>

Promise

listEnvironments(request, callback)

public listEnvironments(request: google.cloud.orchestration.airflow.service.v1beta1.IListEnvironmentsRequest, callback: google.cloud.orchestration.airflow.service.v1beta1.Environments.ListEnvironmentsCallback): void;

Calls ListEnvironments.

Parameters
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IListEnvironmentsRequest

ListEnvironmentsRequest message or plain object

callback google.cloud.orchestration.airflow.service.v1beta1.Environments.ListEnvironmentsCallback

Node-style callback called with the error, if any, and ListEnvironmentsResponse

Returns
TypeDescription
void

listEnvironments(request)

public listEnvironments(request: google.cloud.orchestration.airflow.service.v1beta1.IListEnvironmentsRequest): Promise<google.cloud.orchestration.airflow.service.v1beta1.ListEnvironmentsResponse>;

Calls ListEnvironments.

Parameter
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IListEnvironmentsRequest

ListEnvironmentsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.orchestration.airflow.service.v1beta1.ListEnvironmentsResponse>

Promise

restartWebServer(request, callback)

public restartWebServer(request: google.cloud.orchestration.airflow.service.v1beta1.IRestartWebServerRequest, callback: google.cloud.orchestration.airflow.service.v1beta1.Environments.RestartWebServerCallback): void;

Calls RestartWebServer.

Parameters
NameDescription
request IRestartWebServerRequest

RestartWebServerRequest message or plain object

callback google.cloud.orchestration.airflow.service.v1beta1.Environments.RestartWebServerCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

restartWebServer(request)

public restartWebServer(request: google.cloud.orchestration.airflow.service.v1beta1.IRestartWebServerRequest): Promise<google.longrunning.Operation>;

Calls RestartWebServer.

Parameter
NameDescription
request IRestartWebServerRequest

RestartWebServerRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

updateEnvironment(request, callback)

public updateEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.IUpdateEnvironmentRequest, callback: google.cloud.orchestration.airflow.service.v1beta1.Environments.UpdateEnvironmentCallback): void;

Calls UpdateEnvironment.

Parameters
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IUpdateEnvironmentRequest

UpdateEnvironmentRequest message or plain object

callback google.cloud.orchestration.airflow.service.v1beta1.Environments.UpdateEnvironmentCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

updateEnvironment(request)

public updateEnvironment(request: google.cloud.orchestration.airflow.service.v1beta1.IUpdateEnvironmentRequest): Promise<google.longrunning.Operation>;

Calls UpdateEnvironment.

Parameter
NameDescription
request google.cloud.orchestration.airflow.service.v1beta1.IUpdateEnvironmentRequest

UpdateEnvironmentRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise