Class protos.google.cloud.datalabeling.v1beta1.DataItem

Represents a DataItem.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datalabeling.v1beta1.IDataItem);

Constructs a new DataItem.

Parameter
Type Name Description
IDataItem properties

Properties to set

Properties

imagePayload

public imagePayload?: (google.cloud.datalabeling.v1beta1.IImagePayload|null);

DataItem imagePayload.

Property Value
Type Description
(google.cloud.datalabeling.v1beta1.IImagePayload|null)

name

public name: string;

DataItem name.

Property Value
Type Description
string

payload

public payload?: ("imagePayload"|"textPayload"|"videoPayload");

DataItem payload.

Property Value
Type Description
("imagePayload"|"textPayload"|"videoPayload")

textPayload

public textPayload?: (google.cloud.datalabeling.v1beta1.ITextPayload|null);

DataItem textPayload.

Property Value
Type Description
(google.cloud.datalabeling.v1beta1.ITextPayload|null)

videoPayload

public videoPayload?: (google.cloud.datalabeling.v1beta1.IVideoPayload|null);

DataItem videoPayload.

Property Value
Type Description
(google.cloud.datalabeling.v1beta1.IVideoPayload|null)

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IDataItem): google.cloud.datalabeling.v1beta1.DataItem;

Creates a new DataItem instance using the specified properties.

Parameter
Type Name Description
IDataItem properties

Properties to set
Returns
Type Description
google.cloud.datalabeling.v1beta1.DataItem

DataItem instance

decode(reader, length)

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

Decodes a DataItem message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
google.cloud.datalabeling.v1beta1.DataItem

DataItem

decodeDelimited(reader)

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

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

Parameter
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
google.cloud.datalabeling.v1beta1.DataItem

DataItem

encode(message, writer)

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

Encodes the specified DataItem message. Does not implicitly messages.

Parameters
Type Name Description
IDataItem message

DataItem message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datalabeling.v1beta1.IDataItem, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
IDataItem message

DataItem message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datalabeling.v1beta1.DataItem;

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

Parameter
Type Name Description
{ [k: string]: any } object

Plain object
Returns
Type Description
google.cloud.datalabeling.v1beta1.DataItem

DataItem

toJSON()

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

Converts this DataItem to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.cloud.datalabeling.v1beta1.DataItem message

DataItem
$protobuf.IConversionOptions options

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a DataItem message.

Parameter
Type Name Description
{ [k: string]: any } message

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not