Insight

google.cloud.recommender.v1. Insight

Represents an Insight.

Constructor

new Insight(propertiesopt)

Constructs a new Insight.

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

Properties to set
Implements:
  • IInsight

Classes

RecommendationReference

Members

associatedRecommendations

Insight associatedRecommendations.

category

Insight category.

content

Insight content.

description

Insight description.

etag

Insight etag.

insightSubtype

Insight insightSubtype.

lastRefreshTime

Insight lastRefreshTime.

name

Insight name.

observationPeriod

Insight observationPeriod.

severity

Insight severity.

stateInfo

Insight stateInfo.

targetResources

Insight targetResources.

Category

Category enum.

Properties:
Name Type Description
CATEGORY_UNSPECIFIED number

CATEGORY_UNSPECIFIED value
COST number

COST value
SECURITY number

SECURITY value
PERFORMANCE number

PERFORMANCE value
MANAGEABILITY number

MANAGEABILITY value
SUSTAINABILITY number

SUSTAINABILITY value
RELIABILITY number

RELIABILITY value

Severity

Severity enum.

Properties:
Name Type Description
SEVERITY_UNSPECIFIED number

SEVERITY_UNSPECIFIED value
LOW number

LOW value
MEDIUM number

MEDIUM value
HIGH number

HIGH value
CRITICAL number

CRITICAL value

Methods

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

Converts this Insight to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Insight instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.cloud.recommender.v1.Insight

Insight instance

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

Decodes an Insight 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.Insight

Insight
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.Insight}

Decodes an Insight 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.Insight

Insight
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 Insight message. Does not implicitly verify messages.

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

Insight 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 Insight message, length delimited. Does not implicitly verify messages.

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

Insight 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.Insight}

Creates an Insight 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.Insight

Insight

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Insight

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 an Insight message. Also converts values to other types if specified.

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

Insight
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an Insight 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