Class protos.google.cloud.discoveryengine.v1beta.DocumentInfo (0.6.0)

Represents a DocumentInfo.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1beta.IDocumentInfo);

Constructs a new DocumentInfo.

Parameter
NameDescription
properties IDocumentInfo

Properties to set

Properties

_quantity

public _quantity?: "quantity";

DocumentInfo _quantity.

documentDescriptor

public documentDescriptor?: ("id"|"name");

DocumentInfo documentDescriptor.

id

public id?: (string|null);

DocumentInfo id.

name

public name?: (string|null);

DocumentInfo name.

promotionIds

public promotionIds: string[];

DocumentInfo promotionIds.

quantity

public quantity?: (number|null);

DocumentInfo quantity.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.IDocumentInfo): google.cloud.discoveryengine.v1beta.DocumentInfo;

Creates a new DocumentInfo instance using the specified properties.

Parameter
NameDescription
properties IDocumentInfo

Properties to set

Returns
TypeDescription
google.cloud.discoveryengine.v1beta.DocumentInfo

DocumentInfo instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.DocumentInfo;

Decodes a DocumentInfo message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.discoveryengine.v1beta.DocumentInfo

DocumentInfo

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.DocumentInfo;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.discoveryengine.v1beta.DocumentInfo

DocumentInfo

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1beta.IDocumentInfo, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DocumentInfo message. Does not implicitly messages.

Parameters
NameDescription
message IDocumentInfo

DocumentInfo 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.discoveryengine.v1beta.IDocumentInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDocumentInfo

DocumentInfo 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.discoveryengine.v1beta.DocumentInfo;

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

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

Plain object

Returns
TypeDescription
google.cloud.discoveryengine.v1beta.DocumentInfo

DocumentInfo

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DocumentInfo

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 DocumentInfo to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.discoveryengine.v1beta.DocumentInfo

DocumentInfo

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 DocumentInfo 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