Reference documentation and code samples for the Recommender V1 Client class Insight.
An insight along with the information used to derive the insight. The insight may have associated recommendations as well.
Generated from protobuf message google.cloud.recommender.v1.Insight
Namespace
Google \ Cloud \ Recommender \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Name of the insight.
↳ description
string
Free-form human readable summary in English. The maximum length is 500 characters.
↳ target_resources
array
Fully qualified resource names that this insight is targeting.
↳ insight_subtype
string
Insight subtype. Insight content schema will be stable for a given subtype.
↳ content
Google\Protobuf\Struct
A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000"
↳ last_refresh_time
↳ observation_period
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).
↳ state_info
↳ category
int
Category being targeted by the insight.
↳ severity
int
Insight's severity.
↳ etag
string
Fingerprint of the Insight. Provides optimistic locking when updating states.
↳ associated_recommendations
array< Google\Cloud\Recommender\V1\Insight\RecommendationReference
>
Recommendations derived from this insight.
getName
Name of the insight.
string
setName
Name of the insight.
var
string
$this
getDescription
Free-form human readable summary in English. The maximum length is 500 characters.
string
setDescription
Free-form human readable summary in English. The maximum length is 500 characters.
var
string
$this
getTargetResources
Fully qualified resource names that this insight is targeting.
setTargetResources
Fully qualified resource names that this insight is targeting.
var
string[]
$this
getInsightSubtype
Insight subtype. Insight content schema will be stable for a given subtype.
string
setInsightSubtype
Insight subtype. Insight content schema will be stable for a given subtype.
var
string
$this
getContent
A struct of custom fields to explain the insight.
Example: "grantedPermissionsCount": "1000"
hasContent
clearContent
setContent
A struct of custom fields to explain the insight.
Example: "grantedPermissionsCount": "1000"
$this
getLastRefreshTime
Timestamp of the latest data used to generate the insight.
hasLastRefreshTime
clearLastRefreshTime
setLastRefreshTime
Timestamp of the latest data used to generate the insight.
$this
getObservationPeriod
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).
hasObservationPeriod
clearObservationPeriod
setObservationPeriod
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).
$this
getStateInfo
Information state and metadata.
hasStateInfo
clearStateInfo
setStateInfo
Information state and metadata.
$this
getCategory
Category being targeted by the insight.
int
setCategory
Category being targeted by the insight.
var
int
$this
getSeverity
Insight's severity.
int
setSeverity
Insight's severity.
var
int
$this
getEtag
Fingerprint of the Insight. Provides optimistic locking when updating states.
string
setEtag
Fingerprint of the Insight. Provides optimistic locking when updating states.
var
string
$this
getAssociatedRecommendations
Recommendations derived from this insight.
setAssociatedRecommendations
Recommendations derived from this insight.
$this
