public final class Insight extends GeneratedMessageV3 implements InsightOrBuilder
An insight along with the information used to derive the insight. The insight
may have associated recomendations as well.
Protobuf type google.cloud.recommender.v1.Insight
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ASSOCIATED_RECOMMENDATIONS_FIELD_NUMBER
public static final int ASSOCIATED_RECOMMENDATIONS_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
CATEGORY_FIELD_NUMBER
public static final int CATEGORY_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
INSIGHT_SUBTYPE_FIELD_NUMBER
public static final int INSIGHT_SUBTYPE_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
LAST_REFRESH_TIME_FIELD_NUMBER
public static final int LAST_REFRESH_TIME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
OBSERVATION_PERIOD_FIELD_NUMBER
public static final int OBSERVATION_PERIOD_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
SEVERITY_FIELD_NUMBER
public static final int SEVERITY_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
STATE_INFO_FIELD_NUMBER
public static final int STATE_INFO_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
TARGET_RESOURCES_FIELD_NUMBER
public static final int TARGET_RESOURCES_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Insight getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Insight.Builder newBuilder()
newBuilder(Insight prototype)
public static Insight.Builder newBuilder(Insight prototype)
Parameter |
---|
Name | Description |
prototype | Insight
|
public static Insight parseDelimitedFrom(InputStream input)
public static Insight parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Insight parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Insight parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Insight parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Insight parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Insight parseFrom(CodedInputStream input)
public static Insight parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Insight parseFrom(InputStream input)
public static Insight parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Insight parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Insight parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Insight> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
getAssociatedRecommendations(int index)
public Insight.RecommendationReference getAssociatedRecommendations(int index)
Recommendations derived from this insight.
repeated .google.cloud.recommender.v1.Insight.RecommendationReference associated_recommendations = 8;
Parameter |
---|
Name | Description |
index | int
|
getAssociatedRecommendationsCount()
public int getAssociatedRecommendationsCount()
Recommendations derived from this insight.
repeated .google.cloud.recommender.v1.Insight.RecommendationReference associated_recommendations = 8;
Returns |
---|
Type | Description |
int | |
getAssociatedRecommendationsList()
public List<Insight.RecommendationReference> getAssociatedRecommendationsList()
Recommendations derived from this insight.
repeated .google.cloud.recommender.v1.Insight.RecommendationReference associated_recommendations = 8;
getAssociatedRecommendationsOrBuilder(int index)
public Insight.RecommendationReferenceOrBuilder getAssociatedRecommendationsOrBuilder(int index)
Recommendations derived from this insight.
repeated .google.cloud.recommender.v1.Insight.RecommendationReference associated_recommendations = 8;
Parameter |
---|
Name | Description |
index | int
|
getAssociatedRecommendationsOrBuilderList()
public List<? extends Insight.RecommendationReferenceOrBuilder> getAssociatedRecommendationsOrBuilderList()
Recommendations derived from this insight.
repeated .google.cloud.recommender.v1.Insight.RecommendationReference associated_recommendations = 8;
Returns |
---|
Type | Description |
List<? extends com.google.cloud.recommender.v1.Insight.RecommendationReferenceOrBuilder> | |
getCategory()
public Insight.Category getCategory()
Category being targeted by the insight.
.google.cloud.recommender.v1.Insight.Category category = 7;
getCategoryValue()
public int getCategoryValue()
Category being targeted by the insight.
.google.cloud.recommender.v1.Insight.Category category = 7;
Returns |
---|
Type | Description |
int | The enum numeric value on the wire for category.
|
getContent()
public Struct getContent()
A struct of custom fields to explain the insight.
Example: "grantedPermissionsCount": "1000"
.google.protobuf.Struct content = 3;
Returns |
---|
Type | Description |
Struct | The content.
|
getContentOrBuilder()
public StructOrBuilder getContentOrBuilder()
A struct of custom fields to explain the insight.
Example: "grantedPermissionsCount": "1000"
.google.protobuf.Struct content = 3;
getDefaultInstanceForType()
public Insight getDefaultInstanceForType()
getDescription()
public String getDescription()
Free-form human readable summary in English. The maximum length is 500
characters.
string description = 2;
Returns |
---|
Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Free-form human readable summary in English. The maximum length is 500
characters.
string description = 2;
Returns |
---|
Type | Description |
ByteString | The bytes for description.
|
getEtag()
Fingerprint of the Insight. Provides optimistic locking when updating
states.
string etag = 11;
Returns |
---|
Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Fingerprint of the Insight. Provides optimistic locking when updating
states.
string etag = 11;
Returns |
---|
Type | Description |
ByteString | The bytes for etag.
|
getInsightSubtype()
public String getInsightSubtype()
Insight subtype. Insight content schema will be stable for a given subtype.
string insight_subtype = 10;
Returns |
---|
Type | Description |
String | The insightSubtype.
|
getInsightSubtypeBytes()
public ByteString getInsightSubtypeBytes()
Insight subtype. Insight content schema will be stable for a given subtype.
string insight_subtype = 10;
Returns |
---|
Type | Description |
ByteString | The bytes for insightSubtype.
|
getLastRefreshTime()
public Timestamp getLastRefreshTime()
Timestamp of the latest data used to generate the insight.
.google.protobuf.Timestamp last_refresh_time = 4;
Returns |
---|
Type | Description |
Timestamp | The lastRefreshTime.
|
getLastRefreshTimeOrBuilder()
public TimestampOrBuilder getLastRefreshTimeOrBuilder()
Timestamp of the latest data used to generate the insight.
.google.protobuf.Timestamp last_refresh_time = 4;
getName()
Name of the insight.
string name = 1;
Returns |
---|
Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Name of the insight.
string name = 1;
Returns |
---|
Type | Description |
ByteString | The bytes for name.
|
getObservationPeriod()
public Duration 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).
.google.protobuf.Duration observation_period = 5;
Returns |
---|
Type | Description |
Duration | The observationPeriod.
|
getObservationPeriodOrBuilder()
public DurationOrBuilder getObservationPeriodOrBuilder()
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).
.google.protobuf.Duration observation_period = 5;
getParserForType()
public Parser<Insight> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
---|
Type | Description |
int | |
Overrides
getSeverity()
public Insight.Severity getSeverity()
Insight's severity.
.google.cloud.recommender.v1.Insight.Severity severity = 15;
getSeverityValue()
public int getSeverityValue()
Insight's severity.
.google.cloud.recommender.v1.Insight.Severity severity = 15;
Returns |
---|
Type | Description |
int | The enum numeric value on the wire for severity.
|
getStateInfo()
public InsightStateInfo getStateInfo()
Information state and metadata.
.google.cloud.recommender.v1.InsightStateInfo state_info = 6;
getStateInfoOrBuilder()
public InsightStateInfoOrBuilder getStateInfoOrBuilder()
Information state and metadata.
.google.cloud.recommender.v1.InsightStateInfo state_info = 6;
getTargetResources(int index)
public String getTargetResources(int index)
Fully qualified resource names that this insight is targeting.
repeated string target_resources = 9;
Parameter |
---|
Name | Description |
index | int
The index of the element to return.
|
Returns |
---|
Type | Description |
String | The targetResources at the given index.
|
getTargetResourcesBytes(int index)
public ByteString getTargetResourcesBytes(int index)
Fully qualified resource names that this insight is targeting.
repeated string target_resources = 9;
Parameter |
---|
Name | Description |
index | int
The index of the value to return.
|
Returns |
---|
Type | Description |
ByteString | The bytes of the targetResources at the given index.
|
getTargetResourcesCount()
public int getTargetResourcesCount()
Fully qualified resource names that this insight is targeting.
repeated string target_resources = 9;
Returns |
---|
Type | Description |
int | The count of targetResources.
|
getTargetResourcesList()
public ProtocolStringList getTargetResourcesList()
Fully qualified resource names that this insight is targeting.
repeated string target_resources = 9;
hasContent()
public boolean hasContent()
A struct of custom fields to explain the insight.
Example: "grantedPermissionsCount": "1000"
.google.protobuf.Struct content = 3;
Returns |
---|
Type | Description |
boolean | Whether the content field is set.
|
hasLastRefreshTime()
public boolean hasLastRefreshTime()
Timestamp of the latest data used to generate the insight.
.google.protobuf.Timestamp last_refresh_time = 4;
Returns |
---|
Type | Description |
boolean | Whether the lastRefreshTime field is set.
|
hasObservationPeriod()
public boolean hasObservationPeriod()
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).
.google.protobuf.Duration observation_period = 5;
Returns |
---|
Type | Description |
boolean | Whether the observationPeriod field is set.
|
hasStateInfo()
public boolean hasStateInfo()
Information state and metadata.
.google.cloud.recommender.v1.InsightStateInfo state_info = 6;
Returns |
---|
Type | Description |
boolean | Whether the stateInfo field is set.
|
hashCode()
Returns |
---|
Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Insight.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Insight.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Insight.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides