REST Resource: projects.locations.clusters.analyses

Resource: Analysis

Message describing the Analysis object.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "analysisDefinition": {
    object (AnalysisDefinition)
  },
  "inputStreamsMapping": {
    string: string,
    ...
  },
  "outputStreamsMapping": {
    string: string,
    ...
  },
  "disableEventWatch": boolean
}
Fields
name

string

The name of resource.
createTime

string (Timestamp format)

Output only. The 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. The 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" }.
analysisDefinition

object (AnalysisDefinition)

The definition of the analysis.
inputStreamsMapping

map (key: string, value: string)

Map from the input parameter in the definition to the real stream. E.g., suppose you had a stream source operator named "input-0" and you try to receive from the real stream "stream-0". You can add the following mapping: [input-0: stream-0].

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

map (key: string, value: string)

Map from the output parameter in the definition to the real stream. E.g., suppose you had a stream sink operator named "output-0" and you try to send to the real stream "stream-0". You can add the following mapping: [output-0: stream-0].

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

boolean

Boolean flag to indicate whether you would like to disable the ability to automatically start a Process when new event happening in the input Stream. If you would like to start a Process manually, the field needs to be set to true.

AnalysisDefinition

Defines a full analysis.

This is a description of the overall live analytics pipeline. You may think of this as an edge list representation of a multigraph.

This may be directly authored by a human in protobuf textformat, or it may be generated by a programming API (perhaps Python or JavaScript depending on context).

JSON representation 
{
  "analyzers": [
    {
      object (AnalyzerDefinition)
    }
  ]
}
Fields
analyzers[]

object (AnalyzerDefinition)

Analyzer definitions.

AnalyzerDefinition

Defines an Analyzer.

An analyzer processes data from its input streams using the logic defined in the Operator that it represents. Of course, it produces data for the output streams declared in the Operator.

JSON representation 
{
  "analyzer": string,
  "operator": string,
  "inputs": [
    {
      object (StreamInput)
    }
  ],
  "attrs": {
    string: {
      object (AttributeValue)
    },
    ...
  },
  "debugOptions": {
    object (DebugOptions)
  }
}
Fields
analyzer

string

The name of this analyzer.

Tentatively [a-z][a-z0-9]*(_[a-z0-9]+)*.
operator

string

The name of the operator that this analyzer runs.

Must match the name of a supported operator.
inputs[]

object (StreamInput)

Input streams.
attrs

map (key: string, value: object (AttributeValue))

The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

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

object (DebugOptions)

Debug options.

StreamInput

The inputs to this analyzer.

We accept input name references of the following form: :

Example:

Suppose you had an operator named "SomeOp" that has 2 output arguments, the first of which is named "foo" and the second of which is named "bar", and an operator named "MyOp" that accepts 2 inputs.

Also suppose that there is an analyzer named "some-analyzer" that is running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".

To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo" output as its first input and "some-analyzer"'s "bar" output as its second input, you can set this field to the following: input = ["some-analyzer:foo", "some-analyzer:bar"]

JSON representation 
{
  "input": string
}
Fields
input

string

The name of the stream input (as discussed above).

DebugOptions

Options available for debugging purposes only.

JSON representation 
{
  "environmentVariables": {
    string: string,
    ...
  }
}
Fields
environmentVariables

map (key: string, value: string)

Environment variables.

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

Methods

create

 Creates a new Analysis in a given project and location.

delete

 Deletes a single Analysis.

get

 Gets details of a single Analysis.

list

 Lists Analyses in a given project and location.

patch

 Updates the parameters of a single Analysis.