Class: Google::Cloud::Recommender::V1::InsightStateInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommender/v1/insight.rb

Overview

Information related to insight state.

Defined Under Namespace

Modules: State Classes: StateMetadataEntry

Instance Attribute Summary collapse

Instance Attribute Details

#state ⇒ ::Google::Cloud::Recommender::V1::InsightStateInfo::State

Returns Insight state.

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 104

class InsightStateInfo
  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 insight state.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Insight is active. Content for ACTIVE insights can be updated by Google.
    # ACTIVE insights can be marked DISMISSED OR ACCEPTED.
    ACTIVE = 1

    # Some action has been taken based on this insight. Insights become
    # accepted when a recommendation derived from the insight has been marked
    # CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked
    # ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED
    # insights can only be marked ACCEPTED (which may update state metadata).
    ACCEPTED = 2

    # Insight is dismissed. Content for DISMISSED insights can be updated by
    # Google. DISMISSED insights can be marked as ACTIVE.
    DISMISSED = 3
  end
end

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

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

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 104

class InsightStateInfo
  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 insight state.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Insight is active. Content for ACTIVE insights can be updated by Google.
    # ACTIVE insights can be marked DISMISSED OR ACCEPTED.
    ACTIVE = 1

    # Some action has been taken based on this insight. Insights become
    # accepted when a recommendation derived from the insight has been marked
    # CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked
    # ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED
    # insights can only be marked ACCEPTED (which may update state metadata).
    ACCEPTED = 2

    # Insight is dismissed. Content for DISMISSED insights can be updated by
    # Google. DISMISSED insights can be marked as ACTIVE.
    DISMISSED = 3
  end
end