Application Lifecycle Commands

The CLI includes the following application lifecycle commands:

Command

Description

Command

Description

add time schedule <schedule-name> for workflow <app-id.program-id> [version <app-version>] [description <description>] at <cron-expression> [concurrency <concurrency>] [properties <schedule-properties>]

Adds a schedule which is associated with the program given

check service availability <app-id.service-id> [version <app-version>]

Check if a service is available to accept requests

create app <app-id> [version <app-version>] <artifact-name> <artifact-version> <scope> [<app-config-file>]

Creates an application from an artifact, optionally with a version. If the version is not given, a default version '-SNAPSHOT' will be used. A configuration is also optional. If a configuration is needed, it must be given as a file whose contents are a JSON object containing the application config. For example, the file contents could contain: '{ "config": { "stream": "purchases" } }'. In this case, the application would receive '{ "stream": "purchases" }' as its config object. Finally, an optional principal may be given.

delete app <app-id> [version <app-version>]

Deletes an application with an optional version. If version is not provided, default version '-SNAPSHOT' will be used.

delete app preferences <app-id>

Deletes the preferences of an application

delete instance preferences

Deletes the preferences of an instance

delete mapreduce preferences <app-id.mapreduce-id>

Deletes the preferences of a MapReduce program

delete namespace preferences

Deletes the preferences of a namespace

delete schedule <app-id.schedule-id>

Deletes a schedule

delete service preferences <app-id.service-id>

Deletes the preferences of a service

delete spark preferences <app-id.spark-id>

Deletes the preferences of a Spark program

delete worker preferences <app-id.worker-id>

Deletes the preferences of a worker

delete workflow local datasets <app-id.workflow-id> <runid>

DEPRECATED. Deletes the local datasets associated with the workflow for a given <runid>

delete workflow preferences <app-id.workflow-id>

Deletes the preferences of a workflow

deploy app <app-jar-file> [<app-config>]

Deploys an application, optionally with a serialized configuration string

deploy app <app-jar-file> with config <app-config-file>

Deploys an application, optionally with a configuration file

describe app <app-id> [version <app-version>]

Describes an application with an optional version. If version is not provided, default version '-SNAPSHOT' will be used.

get app <app-id> programs status [of type <program-types>]

Command to get status of one or more programs of an application. By default, gets status of all services and workers. A comma-separated list of program types can be specified, which will get status of all programs of those types. For example, specifying 'service,workflow' will get status of all services and workflows in the application.

get app preferences <app-id>

Gets the preferences of an application

get endpoints service <app-id.service-id> [version <app-version>]

Lists the endpoints that a service exposes

get instance preferences

Gets the preferences of an instance

get mapreduce logs <app-id.mapreduce-id> [<start-time>] [<end-time>]

Gets the logs of a MapReduce program

get mapreduce preferences <app-id.mapreduce-id>

Gets the preferences of a MapReduce program

get mapreduce runs <app-id.mapreduce-id> [<status>] [<start-time>] [<end-time>] [<limit>]

Gets the run history of a MapReduce program

get mapreduce runtimeargs <app-id.mapreduce-id> [version <app-version>]

Gets the runtime arguments of a MapReduce program

get mapreduce status <app-id.mapreduce-id>

Gets the status of a MapReduce program

get namespace preferences

Gets the preferences of a namespace

get resolved app preferences <app-id>

Gets the resolved preferences of an application

get resolved instance preferences

Gets the resolved preferences of an instance

get resolved mapreduce preferences <app-id.mapreduce-id>

Gets the resolved preferences of a MapReduce program

get resolved namespace preferences

Gets the resolved preferences of a namespace

get resolved service preferences <app-id.service-id>

Gets the resolved preferences of a service

get resolved spark preferences <app-id.spark-id>

Gets the resolved preferences of a Spark program

get resolved worker preferences <app-id.worker-id>

Gets the resolved preferences of a worker

get resolved workflow preferences <app-id.workflow-id>

Gets the resolved preferences of a workflow

get schedule status <app-id.schedule-id>

Gets the status of a schedule

get service instances <app-id.service-id>

Gets the number of instances of a service

get service live <app-id.service-id>

Gets the live info of a service

get service logs <app-id.service-id> [<start-time>] [<end-time>]

Gets the logs of a service

get service preferences <app-id.service-id>

Gets the preferences of a service

get service runs <app-id.service-id> [<status>] [<start-time>] [<end-time>] [<limit>]

Gets the run history of a service

get service runtimeargs <app-id.service-id> [version <app-version>]

Gets the runtime arguments of a service

get service status <app-id.service-id>

Gets the status of a service

get spark logs <app-id.spark-id> [<start-time>] [<end-time>]

Gets the logs of a Spark program

get spark preferences <app-id.spark-id>

Gets the preferences of a Spark program

get spark runs <app-id.spark-id> [<status>] [<start-time>] [<end-time>] [<limit>]

Gets the run history of a Spark program

get spark runtimeargs <app-id.spark-id> [version <app-version>]

Gets the runtime arguments of a Spark program

get spark status <app-id.spark-id>

Gets the status of a Spark program

get worker instances <app-id.worker-id>

Gets the number of instances of a worker

get worker live <app-id.worker-id>

Gets the live info of a worker

get worker logs <app-id.worker-id> [<start-time>] [<end-time>]

Gets the logs of a worker

get worker preferences <app-id.worker-id>

Gets the preferences of a worker

get worker runs <app-id.worker-id> [<status>] [<start-time>] [<end-time>] [<limit>]

Gets the run history of a worker

get worker runtimeargs <app-id.worker-id> [version <app-version>]

Gets the runtime arguments of a worker

get worker status <app-id.worker-id>

Gets the status of a worker

get workflow local datasets <app-id.workflow-id> <runid>

DEPRECATED. Gets the local datasets associated with the workflow for a given <runid>

get workflow logs <app-id.workflow-id> [<start-time>] [<end-time>]

Gets the logs of a workflow

get workflow preferences <app-id.workflow-id>

Gets the preferences of a workflow

get workflow runs <app-id.workflow-id> [<status>] [<start-time>] [<end-time>] [<limit>]

Gets the run history of a workflow

get workflow runtimeargs <app-id.workflow-id> [version <app-version>]

Gets the runtime arguments of a workflow

get workflow schedules <app-id.workflow-id>

Gets schedules of a workflow

get workflow state <app-id.workflow-id> <runid>

Gets the state of all nodes associated with the workflow for a given <runid>

get workflow status <app-id.workflow-id>

Gets the status of a workflow

get workflow token <app-id.workflow-id> <runid> [at node <workflow-node>] [scope <workflow-token-scope>] [key <workflow-token-key>]

Gets the workflow token of a workflow for a given <runid>

list app versions <app-id>

Lists all versions of a specific application

list apps [<artifact-name>] [<artifact-version>]

Lists all applications, optionally filtered by artifact name and version

list mapreduce

Lists all MapReduce programs

list programs

Lists all programs

list services

Lists all services

list spark

Lists all Spark programs

list workers

Lists all workers

list workflows

Lists all workflows

load app preferences <app-id> <local-file-path> <content-type>

Sets the preferences of an application from a local JSON config file

load instance preferences <local-file-path> <content-type>

Sets the preferences of an instance from a local JSON config file

load mapreduce preferences <app-id.mapreduce-id> <local-file-path> <content-type>

Sets the preferences of a MapReduce program from a local JSON config file

load namespace preferences <local-file-path> <content-type>

Sets the preferences of a namespace from a local JSON config file

load service preferences <app-id.service-id> <local-file-path> <content-type>

Sets the preferences of a service from a local JSON config file

load spark preferences <app-id.spark-id> <local-file-path> <content-type>

Sets the preferences of a Spark program from a local JSON config file

load worker preferences <app-id.worker-id> <local-file-path> <content-type>

Sets the preferences of a worker from a local JSON config file

load workflow preferences <app-id.workflow-id> <local-file-path> <content-type>

Sets the preferences of a workflow from a local JSON config file

restart app <app-id> programs [of type <program-types>]

Command to restart one or more programs of an application. By default, restarts all services and workers. A comma-separated list of program types can be specified, which will restart all programs of those types. For example, specifying 'service,workflow' will restart all services and workflows in the application.

resume schedule <app-id.schedule-id>

Resumes a schedule

set app preferences <app-id> <preferences>

Sets the preferences of an application. <preferences> is specified in the format 'key1=v1 key2=v2'.

set instance preferences <preferences>

Sets the preferences of an instance. <preferences> is specified in the format 'key1=v1 key2=v2'.

set mapreduce preferences <app-id.mapreduce-id> <preferences>

Sets the preferences of a MapReduce program. <preferences> is specified in the format 'key1=v1 key2=v2'.

set mapreduce runtimeargs <app-id.mapreduce-id> [version <app-version>] <runtime-args>

Sets the runtime arguments of a MapReduce program. <runtime-args> is specified in the format 'key1=v1 key2=v2'.

set namespace preferences <preferences>

Sets the preferences of a namespace. <preferences> is specified in the format 'key1=v1 key2=v2'.

set service instances <app-id.service-id> <num-instances>

Sets the number of instances of a service

set service preferences <app-id.service-id> <preferences>

Sets the preferences of a service. <preferences> is specified in the format 'key1=v1 key2=v2'.

set service runtimeargs <app-id.service-id> [version <app-version>] <runtime-args>

Sets the runtime arguments of a service. <runtime-args> is specified in the format 'key1=v1 key2=v2'.

set spark preferences <app-id.spark-id> <preferences>

Sets the preferences of a Spark program. <preferences> is specified in the format 'key1=v1 key2=v2'.

set spark runtimeargs <app-id.spark-id> [version <app-version>] <runtime-args>

Sets the runtime arguments of a Spark program. <runtime-args> is specified in the format 'key1=v1 key2=v2'.

set worker instances <app-id.worker-id> <num-instances>

Sets the number of instances of a worker

set worker preferences <app-id.worker-id> <preferences>

Sets the preferences of a worker. <preferences> is specified in the format 'key1=v1 key2=v2'.

set worker runtimeargs <app-id.worker-id> [version <app-version>] <runtime-args>

Sets the runtime arguments of a worker. <runtime-args> is specified in the format 'key1=v1 key2=v2'.

set workflow preferences <app-id.workflow-id> <preferences>

Sets the preferences of a workflow. <preferences> is specified in the format 'key1=v1 key2=v2'.

set workflow runtimeargs <app-id.workflow-id> [version <app-version>] <runtime-args>

Sets the runtime arguments of a workflow. <runtime-args> is specified in the format 'key1=v1 key2=v2'.

start app <app-id> programs [of type <program-types>]

Command to start one or more programs of an application. By default, starts all services and workers. A comma-separated list of program types can be specified, which will start all programs of those types. For example, specifying 'service,workflow' will start all services and workflows in the application.

start mapreduce <app-id.mapreduce-id> [version <app-version>] [<runtime-args>]

Starts a MapReduce program. <runtime-args> is specified in the format 'key1=a key2=b'.

start service <app-id.service-id> [version <app-version>] [<runtime-args>]

Starts a service. <runtime-args> is specified in the format 'key1=a key2=b'.

start spark <app-id.spark-id> [version <app-version>] [<runtime-args>]

Starts a Spark program. <runtime-args> is specified in the format 'key1=a key2=b'.

start worker <app-id.worker-id> [version <app-version>] [<runtime-args>]

Starts a worker. <runtime-args> is specified in the format 'key1=a key2=b'.

start workflow <app-id.workflow-id> [version <app-version>] [<runtime-args>]

Starts a workflow. <runtime-args> is specified in the format 'key1=a key2=b'.

start-debug mapreduce <app-id.mapreduce-id> [<runtime-args>]

Starts a MapReduce program in debug mode. <runtime-args> is specified in the format 'key1=a key2=b'.

start-debug service <app-id.service-id> [<runtime-args>]

Starts a service in debug mode. <runtime-args> is specified in the format 'key1=a key2=b'.

start-debug spark <app-id.spark-id> [<runtime-args>]

Starts a Spark program in debug mode. <runtime-args> is specified in the format 'key1=a key2=b'.

start-debug worker <app-id.worker-id> [<runtime-args>]

Starts a worker in debug mode. <runtime-args> is specified in the format 'key1=a key2=b'.

start-debug workflow <app-id.workflow-id> [<runtime-args>]

Starts a workflow in debug mode. <runtime-args> is specified in the format 'key1=a key2=b'.

stop app <app-id> programs [of type <program-types>]

Command to stop one or more programs of an application. By default, stops all services and workers. A comma-separated list of program types can be specified, which will stop all programs of those types. For example, specifying 'service,workflow' will stop all services and workflows in the application.

stop mapreduce <app-id.mapreduce-id> [version <app-version>]

Stops a MapReduce program

stop service <app-id.service-id> [version <app-version>]

Stops a service

stop spark <app-id.spark-id> [version <app-version>]

Stops a Spark program

stop worker <app-id.worker-id> [version <app-version>]

Stops a worker

stop workflow <app-id.workflow-id> [version <app-version>]

Stops a workflow

suspend schedule <app-id.schedule-id>

Suspends a schedule

update app <app-id> <artifact-name> <artifact-version> <scope> [<app-config-file>]

Updates an application to use another artifact version and/or configuration

update time schedule <schedule-name> for workflow <app-id.program-id> [version <app-version>] [description <description>] at <cron-expression> [concurrency <concurrency>] [properties <schedule-properties>]

Updates a schedule which is associated with the program given

Created in 2020 by Google Inc.