REST Resource: projects.locations.applications

Resource: Application

Message describing Application object

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "description": string,
  "applicationConfigs": {
    object (ApplicationConfigs)
  },
  "runtimeInfo": {
    object (ApplicationRuntimeInfo)
  },
  "state": enum (State),
  "billingMode": enum (BillingMode)
}
Fields
name

string

name of resource
createTime

string (Timestamp format)

Output only. [Output only] Create timestamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. [Output only] Update timestamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Required. A user friendly display name for the solution.
description

string

A description for this application.
applicationConfigs

object (ApplicationConfigs)

Application graph configuration.
runtimeInfo

object (ApplicationRuntimeInfo)

Output only. Application graph runtime info. Only exists when application state equals to DEPLOYED.
state

enum (State)

Output only. State of the application.
billingMode

enum (BillingMode)

Billing mode of the application.

ApplicationRuntimeInfo

Message storing the runtime information of the application.

JSON representation 
{
  "deployTime": string,
  "globalOutputResources": [
    {
      object (GlobalOutputResource)
    }
  ],
  "monitoringConfig": {
    object (MonitoringConfig)
  }
}
Fields
deployTime

string (Timestamp format)

Timestamp when the engine be deployed

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
globalOutputResources[]

object (GlobalOutputResource)

Globally created resources like warehouse dataschemas.
monitoringConfig

object (MonitoringConfig)

Monitoring-related configuration for this application.

GlobalOutputResource

Message about output resources from application.

JSON representation 
{
  "outputResource": string,
  "producerNode": string,
  "key": string
}
Fields
outputResource

string

The full resource name of the outputted resources.
producerNode

string

The name of graph node who produces the output resource name. For example: outputResource: /projects/123/locations/us-central1/corpora/my-corpus/dataSchemas/my-schema producerNode: occupancy-count
key

string

The key of the output resource, it has to be unique within the same producer node. One producer node can output several output resources, the key can be used to match corresponding output resources.

MonitoringConfig

Monitoring-related configuration for an application.

JSON representation 
{
  "enabled": boolean
}
Fields
enabled

boolean

Whether this application has monitoring enabled.

State

State of the Application

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
CREATED State CREATED.
DEPLOYING State DEPLOYING.
DEPLOYED State DEPLOYED.
UNDEPLOYING State UNDEPLOYING.
DELETED State DELETED.
ERROR State ERROR.
CREATING State CREATING.
UPDATING State Updating.
DELETING State Deleting.
FIXING State Fixing.

BillingMode

Billing mode of the Application

Enums
BILLING_MODE_UNSPECIFIED The default value.
PAYG Pay as you go billing mode.
MONTHLY Monthly billing mode.

Methods

addStreamInput

 Adds target stream input to the Application.

create

 Creates a new Application in a given project and location.

createApplicationInstances

 Adds target stream input to the Application.

delete

 Deletes a single Application.

deleteApplicationInstances

 Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

deploy

 Deploys a single Application.

get

 Gets details of a single Application.

list

 Lists Applications in a given project and location.

patch

 Updates the parameters of a single Application.

removeStreamInput

 Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

undeploy

 Undeploys a single Application.

updateApplicationInstances

 Adds target stream input to the Application.

updateStreamInput

 Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed.