Recommender V1 API - Class Google::Cloud::Recommender::V1::Insight (v0.15.0)

Reference documentation and code samples for the Recommender V1 API class Google::Cloud::Recommender::V1::Insight.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#associated_recommendations

def associated_recommendations() -> ::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>
Returns

#associated_recommendations=

def associated_recommendations=(value) -> ::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>
Parameter
Returns

#category

def category() -> ::Google::Cloud::Recommender::V1::Insight::Category
Returns

#category=

def category=(value) -> ::Google::Cloud::Recommender::V1::Insight::Category
Parameter
Returns

#content

def content() -> ::Google::Protobuf::Struct
Returns

#content=

def content=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000"
Returns

#description

def description() -> ::String
Returns
  • (::String) — Free-form human readable summary in English. The maximum length is 500 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — 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.

#etag

def etag() -> ::String
Returns
  • (::String) — Fingerprint of the Insight. Provides optimistic locking when updating states.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Fingerprint of the Insight. Provides optimistic locking when updating states.
Returns
  • (::String) — Fingerprint of the Insight. Provides optimistic locking when updating states.

#insight_subtype

def insight_subtype() -> ::String
Returns
  • (::String) — Insight subtype. Insight content schema will be stable for a given subtype.

#insight_subtype=

def insight_subtype=(value) -> ::String
Parameter
  • value (::String) — 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.

#last_refresh_time

def last_refresh_time() -> ::Google::Protobuf::Timestamp
Returns

#last_refresh_time=

def last_refresh_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Name of the insight.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Name of the insight.
Returns
  • (::String) — Name of the insight.

#observation_period

def observation_period() -> ::Google::Protobuf::Duration
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).

#observation_period=

def observation_period=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::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).
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).

#severity

def severity() -> ::Google::Cloud::Recommender::V1::Insight::Severity
Returns

#severity=

def severity=(value) -> ::Google::Cloud::Recommender::V1::Insight::Severity
Parameter
Returns

#state_info

def state_info() -> ::Google::Cloud::Recommender::V1::InsightStateInfo
Returns

#state_info=

def state_info=(value) -> ::Google::Cloud::Recommender::V1::InsightStateInfo
Parameter
Returns

#target_resources

def target_resources() -> ::Array<::String>
Returns
  • (::Array<::String>) — Fully qualified resource names that this insight is targeting.

#target_resources=

def target_resources=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Fully qualified resource names that this insight is targeting.
Returns
  • (::Array<::String>) — Fully qualified resource names that this insight is targeting.