Class: Google::Cloud::Recommender::V1::Insight

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

Overview

An insight along with the information used to derive the insight. The insight may have associated recommendations as well.

Defined Under Namespace

Modules: Category, Severity Classes: RecommendationReference

Instance Attribute Summary collapse

Instance Attribute Details

#associated_recommendations ⇒ ::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>

Returns Recommendations derived from this insight.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#category ⇒ ::Google::Cloud::Recommender::V1::Insight::Category

Returns Category being targeted by the insight.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#content ⇒ ::Google::Protobuf::Struct

Returns A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000".

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#description ⇒ ::String

Returns Free-form human readable summary in English. The maximum length is 500 characters.

Returns:

  • (::String) —

    Free-form human readable summary in English. The maximum length is 500 characters.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#etag ⇒ ::String

Returns Fingerprint of the Insight. Provides optimistic locking when updating states.

Returns:

  • (::String) —

    Fingerprint of the Insight. Provides optimistic locking when updating states.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#insight_subtype ⇒ ::String

Returns Insight subtype. Insight content schema will be stable for a given subtype.

Returns:

  • (::String) —

    Insight subtype. Insight content schema will be stable for a given subtype.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#last_refresh_time ⇒ ::Google::Protobuf::Timestamp

Returns Timestamp of the latest data used to generate the insight.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#name ⇒ ::String

Returns Name of the insight.

Returns:

  • (::String) —

    Name of the insight.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#observation_period ⇒ ::Google::Protobuf::Duration

Returns Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period).

Returns:

  • (::Google::Protobuf::Duration) —

    Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period).



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#severity ⇒ ::Google::Cloud::Recommender::V1::Insight::Severity

Returns Insight's severity.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#state_info ⇒ ::Google::Cloud::Recommender::V1::InsightStateInfo

Returns Information state and metadata.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end

#target_resources ⇒ ::Array<::String>

Returns Fully qualified resource names that this insight is targeting.

Returns:

  • (::Array<::String>) —

    Fully qualified resource names that this insight is targeting.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/recommender/v1/insight.rb', line 67

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

  # Reference to an associated recommendation.
  # @!attribute [rw] recommendation
  #   @return [::String]
  #     Recommendation resource name, e.g.
  #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
  class RecommendationReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Insight category.
  module Category
    # Unspecified category.
    CATEGORY_UNSPECIFIED = 0

    # The insight is related to cost.
    COST = 1

    # The insight is related to security.
    SECURITY = 2

    # The insight is related to performance.
    PERFORMANCE = 3

    # This insight is related to manageability.
    MANAGEABILITY = 4

    # The insight is related to sustainability.
    SUSTAINABILITY = 5

    # This insight is related to reliability.
    RELIABILITY = 6
  end

  # Insight severity levels.
  module Severity
    # Insight has unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Insight has low severity.
    LOW = 1

    # Insight has medium severity.
    MEDIUM = 2

    # Insight has high severity.
    HIGH = 3

    # Insight has critical severity.
    CRITICAL = 4
  end
end