Recommendation

google.cloud.recommender.v1. Recommendation

Represents a Recommendation.

Constructor

new Recommendation(propertiesopt)

Constructs a new Recommendation.

Parameters:
Name Type Attributes Description
properties google.cloud.recommender.v1.IRecommendation <optional>

Properties to set

Implements:
  • IRecommendation

Classes

InsightReference

Members

additionalImpact

Recommendation additionalImpact.

associatedInsights

Recommendation associatedInsights.

content

Recommendation content.

description

Recommendation description.

etag

Recommendation etag.

lastRefreshTime

Recommendation lastRefreshTime.

name

Recommendation name.

primaryImpact

Recommendation primaryImpact.

priority

Recommendation priority.

recommenderSubtype

Recommendation recommenderSubtype.

stateInfo

Recommendation stateInfo.

xorGroupId

Recommendation xorGroupId.

Priority

Priority enum.

Properties:
Name Type Description
PRIORITY_UNSPECIFIED number

PRIORITY_UNSPECIFIED value

P4 number

P4 value

P3 number

P3 value

P2 number

P2 value

P1 number

P1 value

Methods

toJSON() → {Object.<string, *>}

Converts this Recommendation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.recommender.v1.Recommendation}

Creates a new Recommendation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.recommender.v1.IRecommendation <optional>

Properties to set

Returns:
Type Description
google.cloud.recommender.v1.Recommendation

Recommendation instance

(static) decode(reader, lengthopt) → {google.cloud.recommender.v1.Recommendation}

Decodes a Recommendation message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.recommender.v1.Recommendation

Recommendation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.recommender.v1.Recommendation}

Decodes a Recommendation message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.recommender.v1.Recommendation

Recommendation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Recommendation message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.recommender.v1.IRecommendation

Recommendation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Recommendation message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.recommender.v1.IRecommendation

Recommendation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.recommender.v1.Recommendation}

Creates a Recommendation message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.recommender.v1.Recommendation

Recommendation

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Recommendation

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Recommendation message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.recommender.v1.Recommendation

Recommendation

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Recommendation message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not