Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class ControlledMode.
The options for receiver under the controlled mode.
Generated from protobuf message google.cloud.visionai.v1.ControlledMode
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ starting_logical_offset |
string
This can be set to the following logical starting points: "begin": This will read from the earliest available message. "most-recent": This will read from the latest available message. "end": This will read only future messages. "stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally. |
↳ fallback_starting_offset |
string
This is the logical starting point to fallback upon should the specified starting offset be unavailable. This can be one of the following values: "begin": This will read from the earliest available message. "end": This will read only future messages. |
getStartingLogicalOffset
This can be set to the following logical starting points: "begin": This will read from the earliest available message.
"most-recent": This will read from the latest available message. "end": This will read only future messages. "stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasStartingLogicalOffset
setStartingLogicalOffset
This can be set to the following logical starting points: "begin": This will read from the earliest available message.
"most-recent": This will read from the latest available message. "end": This will read only future messages. "stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFallbackStartingOffset
This is the logical starting point to fallback upon should the specified starting offset be unavailable.
This can be one of the following values: "begin": This will read from the earliest available message. "end": This will read only future messages.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFallbackStartingOffset
This is the logical starting point to fallback upon should the specified starting offset be unavailable.
This can be one of the following values: "begin": This will read from the earliest available message. "end": This will read only future messages.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartingOffset
| Returns | |
|---|---|
| Type | Description |
string |
|