Google Cloud Vision Ai V1 Client - Class Analysis (0.1.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class Analysis.

Message describing the Analysis object.

Generated from protobuf message google.cloud.visionai.v1.Analysis

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The name of resource.

↳ create_time Google\Protobuf\Timestamp

Output only. The create timestamp.

↳ update_time Google\Protobuf\Timestamp

Output only. The update timestamp.

↳ labels array|Google\Protobuf\Internal\MapField

Labels as key value pairs.

↳ analysis_definition AnalysisDefinition

The definition of the analysis.

↳ input_streams_mapping array|Google\Protobuf\Internal\MapField

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].

↳ output_streams_mapping array|Google\Protobuf\Internal\MapField

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].

↳ disable_event_watch bool

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.

getName

The name of resource.

Returns
Type Description
string

setName

The name of resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The create timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The create timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The update timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Labels as key value pairs.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels as key value pairs.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAnalysisDefinition

The definition of the analysis.

Returns
Type Description
AnalysisDefinition|null

hasAnalysisDefinition

clearAnalysisDefinition

setAnalysisDefinition

The definition of the analysis.

Parameter
Name Description
var AnalysisDefinition
Returns
Type Description
$this

getInputStreamsMapping

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].

Returns
Type Description
Google\Protobuf\Internal\MapField

setInputStreamsMapping

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].

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getOutputStreamsMapping

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].

Returns
Type Description
Google\Protobuf\Internal\MapField

setOutputStreamsMapping

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].

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDisableEventWatch

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.

Returns
Type Description
bool

setDisableEventWatch

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.

Parameter
Name Description
var bool
Returns
Type Description
$this