Google Cloud Orchestration Airflow V1 Client - Class StopAirflowCommandRequest (2.1.0)

Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class StopAirflowCommandRequest.

Stop Airflow Command request.

Generated from protobuf message google.cloud.orchestration.airflow.service.v1.StopAirflowCommandRequest

Namespace

Google \ Cloud \ Orchestration \ Airflow \ Service \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ environment string

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

↳ execution_id string

The unique ID of the command execution.

↳ pod string

The name of the pod where the command is executed.

↳ pod_namespace string

The namespace of the pod where the command is executed.

↳ force bool

If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.

getEnvironment

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

Returns
Type Description
string

setEnvironment

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

Parameter
Name Description
var string
Returns
Type Description
$this

getExecutionId

The unique ID of the command execution.

Returns
Type Description
string

setExecutionId

The unique ID of the command execution.

Parameter
Name Description
var string
Returns
Type Description
$this

getPod

The name of the pod where the command is executed.

Returns
Type Description
string

setPod

The name of the pod where the command is executed.

Parameter
Name Description
var string
Returns
Type Description
$this

getPodNamespace

The namespace of the pod where the command is executed.

Returns
Type Description
string

setPodNamespace

The namespace of the pod where the command is executed.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.

Returns
Type Description
bool

setForce

If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.

Parameter
Name Description
var bool
Returns
Type Description
$this