Google Cloud Vision Ai V1 Client - Class Process (0.3.0)

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

Message describing the Process object.

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

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.

↳ analysis
string

Required. Reference to an existing Analysis resource.

↳ attribute_overrides
string[]

Optional. Attribute overrides of the Analyzers. Format for each single override item: "{analyzer_name}:{attribute_key}={value}"

↳ run_status
RunStatus

Optional. Status of the Process.

↳ run_mode
int

Optional. Run mode of the Process.

↳ event_id
string

Optional. Event ID of the input/output streams. This is useful when you have a StreamSource/StreamSink operator in the Analysis, and you want to manually specify the Event to read from/write to.

↳ batch_id
string

Optional. Optional: Batch ID of the Process.

↳ retry_count
int

Optional. Optional: The number of retries for a process in submission mode the system should try before declaring failure. By default, no retry will be performed.

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. The create timestamp.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The update timestamp.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update timestamp.

Parameter
Name
Description
Returns
Type
Description
$this

getAnalysis

Required. Reference to an existing Analysis resource.

Returns
Type
Description
string

setAnalysis

Required. Reference to an existing Analysis resource.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAttributeOverrides

Optional. Attribute overrides of the Analyzers.

Format for each single override item: "{analyzer_name}:{attribute_key}={value}"

Returns
Type
Description

setAttributeOverrides

Optional. Attribute overrides of the Analyzers.

Format for each single override item: "{analyzer_name}:{attribute_key}={value}"

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getRunStatus

Optional. Status of the Process.

Returns
Type
Description
RunStatus |null

hasRunStatus

clearRunStatus

setRunStatus

Optional. Status of the Process.

Parameter
Name
Description
var
Returns
Type
Description
$this

getRunMode

Optional. Run mode of the Process.

Returns
Type
Description
int
Enum of type RunMode .

setRunMode

Optional. Run mode of the Process.

Parameter
Name
Description
var
int

Enum of type RunMode .

Returns
Type
Description
$this

getEventId

Optional. Event ID of the input/output streams.

This is useful when you have a StreamSource/StreamSink operator in the Analysis, and you want to manually specify the Event to read from/write to.

Returns
Type
Description
string

setEventId

Optional. Event ID of the input/output streams.

This is useful when you have a StreamSource/StreamSink operator in the Analysis, and you want to manually specify the Event to read from/write to.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getBatchId

Optional. Optional: Batch ID of the Process.

Returns
Type
Description
string

setBatchId

Optional. Optional: Batch ID of the Process.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRetryCount

Optional. Optional: The number of retries for a process in submission mode the system should try before declaring failure. By default, no retry will be performed.

Returns
Type
Description
int

setRetryCount

Optional. Optional: The number of retries for a process in submission mode the system should try before declaring failure. By default, no retry will be performed.

Parameter
Name
Description
var
int
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: