Class protos.google.cloud.recommender.v1.RecommendationContent (6.1.1)

Represents a RecommendationContent.

Package

@google-cloud/recommender

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.recommender.v1.IRecommendationContent);

Constructs a new RecommendationContent.

Parameter
NameDescription
properties IRecommendationContent

Properties to set

Properties

operationGroups

public operationGroups: google.cloud.recommender.v1.IOperationGroup[];

RecommendationContent operationGroups.

overview

public overview?: (google.protobuf.IStruct|null);

RecommendationContent overview.

Methods

create(properties)

public static create(properties?: google.cloud.recommender.v1.IRecommendationContent): google.cloud.recommender.v1.RecommendationContent;

Creates a new RecommendationContent instance using the specified properties.

Parameter
NameDescription
properties IRecommendationContent

Properties to set

Returns
TypeDescription
RecommendationContent

RecommendationContent instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.recommender.v1.RecommendationContent;

Decodes a RecommendationContent message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
RecommendationContent

RecommendationContent

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.recommender.v1.RecommendationContent;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
RecommendationContent

RecommendationContent

encode(message, writer)

public static encode(message: google.cloud.recommender.v1.IRecommendationContent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RecommendationContent message. Does not implicitly messages.

Parameters
NameDescription
message IRecommendationContent

RecommendationContent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.recommender.v1.IRecommendationContent, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IRecommendationContent

RecommendationContent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.recommender.v1.RecommendationContent;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
RecommendationContent

RecommendationContent

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for RecommendationContent

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this RecommendationContent to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.recommender.v1.RecommendationContent, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message RecommendationContent

RecommendationContent

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a RecommendationContent message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not