API Reference
Packages
batch.tensorstack.dev/v1beta1
Package v1beta1 contains API Schema definitions for the batch v1beta1 API group
Resource Types
BeamJob
BeamJob is the Schema for the beamjobs API
Appears in:
| Field | Description |
|---|---|
apiVersion string | batch.tensorstack.dev/v1beta1 |
kind string | BeamJob |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec BeamJobSpec | |
status BeamJobStatus |
BeamJobList
BeamJobList contains a list of BeamJob
| Field | Description |
|---|---|
apiVersion string | batch.tensorstack.dev/v1beta1 |
kind string | BeamJobList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items BeamJob array |
BeamJobSpec
BeamJobSpec defines the desired state of BeamJob
Appears in:
| Field | Description |
|---|---|
flinkClusterTemplate FlinkClusterTemplateSpec | Specifies the FlinkCluster that will be created when executing a BeamJob. |
jobTemplate JobTemplateSpec | Specifies the Job that will be created when executing a BeamJob. |
runPolicy RunPolicy | Runtime policies governing the behavior of the BeamJob. |
scheduler SchedulePolicy | Identifies the preferred scheduler for allocating resources to replicas. Defaults to cluster default scheduler. |
runMode RunMode | Normal mode and debug mode are supported now. |
BeamJobStatus
BeamJobStatus defines the observed state of BeamJob
Appears in:
| Field | Description |
|---|---|
phase JobPhase | Phase is a label for the condition of the job at the current time. |
conditions JobCondition array | The latest available observations of the BeamJob’s current state. |
tasks Tasks array | The statuses of individual tasks. |
aggregate Aggregate | |
jobURL string | The URL to Web UI of the cluster where details of the job is displayed. |
FlinkClusterTemplateSpec
FlinkClusterTemplateSpec describes the data a FlinkCluster should have when created from a template
Appears in:
| Field | Description |
|---|---|
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec FlinkClusterSpec | Specification of the desired behavior of the FlinkCluster. |
RunPolicy
RunPolicy encapsulates runtime policies governing the behavior of the BeamJob.
Appears in:
| Field | Description |
|---|---|
cleanUpCluster boolean | Whether or not delete cluster after the job finished. Default false. |