Class RecommendationStateInfo (2.13.0)

Version 2.13.0

• 2.17.0 (latest)
• 2.16.1
• 2.15.5
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.2
• 2.10.1
• 2.9.0
• 2.8.3
• 2.7.4
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.3
• 1.0.0
• 0.3.0
• 0.2.0
• 0.1.0

RecommendationStateInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information for state. Contains state and metadata.

Attributes
Name	Description
state	google.cloud.recommender_v1.types.RecommendationStateInfo.State The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
state_metadata	MutableMapping[str, str] A map of metadata for the state, provided by user or automations systems.

Classes

State

State(value)

Represents Recommendation State.

Values: STATE_UNSPECIFIED (0): Default state. Don't use directly. ACTIVE (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.
CLAIMED (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.
SUCCEEDED (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.
FAILED (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.
DISMISSED (5):
    Recommendation is in dismissed state.
    Recommendation content can be updated by Google.

    DISMISSED recommendations can be marked as
    ACTIVE.

StateMetadataEntry

StateMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.