Class protos.google.cloud.automl.v1beta1.ExamplePayload

Represents an ExamplePayload.

Package

@google-cloud/automl

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.automl.v1beta1.IExamplePayload);

Constructs a new ExamplePayload.

Parameter
NameDescription
properties IExamplePayload

Properties to set

Properties

document

public document?: (google.cloud.automl.v1beta1.IDocument|null);

ExamplePayload document.

image

public image?: (google.cloud.automl.v1beta1.IImage|null);

ExamplePayload image.

payload

public payload?: ("image"|"textSnippet"|"document"|"row");

ExamplePayload payload.

row

public row?: (google.cloud.automl.v1beta1.IRow|null);

ExamplePayload row.

textSnippet

public textSnippet?: (google.cloud.automl.v1beta1.ITextSnippet|null);

ExamplePayload textSnippet.

Methods

create(properties)

public static create(properties?: google.cloud.automl.v1beta1.IExamplePayload): google.cloud.automl.v1beta1.ExamplePayload;

Creates a new ExamplePayload instance using the specified properties.

Parameter
NameDescription
properties IExamplePayload

Properties to set

Returns
TypeDescription
google.cloud.automl.v1beta1.ExamplePayload

ExamplePayload instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.automl.v1beta1.ExamplePayload;

Decodes an ExamplePayload 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.automl.v1beta1.ExamplePayload

ExamplePayload

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.automl.v1beta1.ExamplePayload;

Decodes an ExamplePayload 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.automl.v1beta1.ExamplePayload

ExamplePayload

encode(message, writer)

public static encode(message: google.cloud.automl.v1beta1.IExamplePayload, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ExamplePayload message. Does not implicitly messages.

Parameters
NameDescription
message IExamplePayload

ExamplePayload 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.automl.v1beta1.IExamplePayload, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IExamplePayload

ExamplePayload 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.automl.v1beta1.ExamplePayload;

Creates an ExamplePayload 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.automl.v1beta1.ExamplePayload

ExamplePayload

toJSON()

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

Converts this ExamplePayload to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.automl.v1beta1.ExamplePayload

ExamplePayload

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

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