Reference documentation and code samples for the Recommender V1 Client class RecommendationStateInfo.
Information for state. Contains state and metadata.
Generated from protobuf message google.cloud.recommender.v1.RecommendationStateInfo
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ state |
int
The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. |
↳ state_metadata |
array|Google\Protobuf\Internal\MapField
A map of metadata for the state, provided by user or automations systems. |
getState
The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateMetadata
A map of metadata for the state, provided by user or automations systems.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setStateMetadata
A map of metadata for the state, provided by user or automations systems.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |