Recommender V1 Client - Class State (2.0.2)

Version latest

• 2.0.2 (latest)
• 2.0.1
• 1.11.5
• 1.10.0
• 1.9.1
• 1.8.2
• 1.7.8

Reference documentation and code samples for the Recommender V1 Client class State.

Represents Recommendation State.

Protobuf type google.cloud.recommender.v1.RecommendationStateInfo.State

Namespace

Google \ Cloud \ Recommender \ V1 \ RecommendationStateInfo

Methods

static::name

Parameter
Name	Description
value	mixed

static::value

Parameter
Name	Description
name	mixed

Constants

STATE_UNSPECIFIED

Value: 0

Default state. Don't use directly.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

ACTIVE

Value: 1

Recommendation is active and can be applied. Recommendations content can be updated by Google.

ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.

Generated from protobuf enum ACTIVE = 1;

CLAIMED

Value: 6

Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google.

CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.

Generated from protobuf enum CLAIMED = 6;

SUCCEEDED

Value: 3

Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google.

SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.

Generated from protobuf enum SUCCEEDED = 3;

FAILED

Value: 4

Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google.

FAILED recommendations can be marked as SUCCEEDED, or FAILED.

Generated from protobuf enum FAILED = 4;

DISMISSED

Value: 5

Recommendation is in dismissed state. Recommendation content can be updated by Google.

DISMISSED recommendations can be marked as ACTIVE.

Generated from protobuf enum DISMISSED = 5;