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
- (::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>) — Recommendations derived from this insight.
#associated_recommendations=
def associated_recommendations=(value) -> ::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>
Parameter
- value (::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>) — Recommendations derived from this insight.
Returns
- (::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>) — Recommendations derived from this insight.
#category
def category() -> ::Google::Cloud::Recommender::V1::Insight::Category
Returns
- (::Google::Cloud::Recommender::V1::Insight::Category) — Category being targeted by the insight.
#category=
def category=(value) -> ::Google::Cloud::Recommender::V1::Insight::Category
Parameter
- value (::Google::Cloud::Recommender::V1::Insight::Category) — Category being targeted by the insight.
Returns
- (::Google::Cloud::Recommender::V1::Insight::Category) — Category being targeted by the insight.
#content
def content() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000"
#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
- (::Google::Protobuf::Struct) — A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000"
#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
- (::Google::Protobuf::Timestamp) — Timestamp of the latest data used to generate the insight.
#last_refresh_time=
def last_refresh_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Timestamp of the latest data used to generate the insight.
Returns
- (::Google::Protobuf::Timestamp) — Timestamp of the latest data used to generate the insight.
#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
- (::Google::Cloud::Recommender::V1::Insight::Severity) — Insight's severity.
#severity=
def severity=(value) -> ::Google::Cloud::Recommender::V1::Insight::Severity
Parameter
- value (::Google::Cloud::Recommender::V1::Insight::Severity) — Insight's severity.
Returns
- (::Google::Cloud::Recommender::V1::Insight::Severity) — Insight's severity.
#state_info
def state_info() -> ::Google::Cloud::Recommender::V1::InsightStateInfo
Returns
- (::Google::Cloud::Recommender::V1::InsightStateInfo) — Information state and metadata.
#state_info=
def state_info=(value) -> ::Google::Cloud::Recommender::V1::InsightStateInfo
Parameter
- value (::Google::Cloud::Recommender::V1::InsightStateInfo) — Information state and metadata.
Returns
- (::Google::Cloud::Recommender::V1::InsightStateInfo) — Information state and metadata.
#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.