Class: Google::Cloud::Recommender::V1::RecommendationStateInfo

Inherits:

Object

Object
Google::Cloud::Recommender::V1::RecommendationStateInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/recommender/v1/recommendation.rb

Overview

Information for state. Contains state and metadata.

Defined Under Namespace

Modules: State Classes: StateMetadataEntry

Instance Attribute Summary collapse

#state ⇒ ::Google::Cloud::Recommender::V1::RecommendationStateInfo::State
The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
#state_metadata ⇒ ::Google::Protobuf::Map{::String => ::String}
A map of metadata for the state, provided by user or automations systems.

Instance Attribute Details

#state ⇒ `::Google::Cloud::Recommender::V1::RecommendationStateInfo::State`

Returns The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.

Returns:

(::Google::Cloud::Recommender::V1::RecommendationStateInfo::State) —
The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.

# File 'proto_docs/google/cloud/recommender/v1/recommendation.rb', line 378

class RecommendationStateInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class StateMetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents Recommendation State.
  module State
    # Default state. Don't use directly.
    STATE_UNSPECIFIED = 0

    # Recommendation is active and can be applied. Recommendations content can
    # be updated by Google.
    #
    # ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.
    ACTIVE = 1

    # 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.
    CLAIMED = 6

    # Recommendation is in succeeded state. Recommendations content is
    # immutable and cannot be updated by Google.
    #
    # SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.
    SUCCEEDED = 3

    # Recommendation is in failed state. Recommendations content is immutable
    # and cannot be updated by Google.
    #
    # FAILED recommendations can be marked as SUCCEEDED, or FAILED.
    FAILED = 4

    # Recommendation is in dismissed state. Recommendation content can be
    # updated by Google.
    #
    # DISMISSED recommendations can be marked as ACTIVE.
    DISMISSED = 5
  end
end

#state_metadata ⇒ `::Google::Protobuf::Map{::String => ::String}`

Returns A map of metadata for the state, provided by user or automations systems.