Represents a Recommendation.
Package
@google-cloud/recommenderConstructors
(constructor)(properties)
constructor(properties?: google.cloud.recommender.v1.IRecommendation);Constructs a new Recommendation.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRecommendation
Properties to set |
Properties
additionalImpact
public additionalImpact: google.cloud.recommender.v1.IImpact[];Recommendation additionalImpact.
associatedInsights
public associatedInsights: google.cloud.recommender.v1.Recommendation.IInsightReference[];Recommendation associatedInsights.
content
public content?: (google.cloud.recommender.v1.IRecommendationContent|null);Recommendation content.
description
public description: string;Recommendation description.
etag
public etag: string;Recommendation etag.
lastRefreshTime
public lastRefreshTime?: (google.protobuf.ITimestamp|null);Recommendation lastRefreshTime.
name
public name: string;Recommendation name.
primaryImpact
public primaryImpact?: (google.cloud.recommender.v1.IImpact|null);Recommendation primaryImpact.
priority
public priority: (google.cloud.recommender.v1.Recommendation.Priority|keyof typeof google.cloud.recommender.v1.Recommendation.Priority);Recommendation priority.
recommenderSubtype
public recommenderSubtype: string;Recommendation recommenderSubtype.
stateInfo
public stateInfo?: (google.cloud.recommender.v1.IRecommendationStateInfo|null);Recommendation stateInfo.
xorGroupId
public xorGroupId: string;Recommendation xorGroupId.
Methods
create(properties)
public static create(properties?: google.cloud.recommender.v1.IRecommendation): google.cloud.recommender.v1.Recommendation;Creates a new Recommendation instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRecommendation
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender.v1.Recommendation | Recommendation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.recommender.v1.Recommendation;Decodes a Recommendation message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender.v1.Recommendation | Recommendation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.recommender.v1.Recommendation;Decodes a Recommendation message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender.v1.Recommendation | Recommendation |
encode(message, writer)
public static encode(message: google.cloud.recommender.v1.IRecommendation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Recommendation message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRecommendation
Recommendation message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.recommender.v1.IRecommendation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Recommendation message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRecommendation
Recommendation message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.recommender.v1.Recommendation;Creates a Recommendation message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender.v1.Recommendation | Recommendation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Recommendation
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Recommendation to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.recommender.v1.Recommendation, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Recommendation message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.recommender.v1.Recommendation
Recommendation |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Recommendation message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|