Represents an Example.
Package
@google-cloud/datalabeling!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.datalabeling.v1beta1.IExample);Constructs a new Example.
| Type | Name | Description |
|---|---|---|
| IExample | properties |
Properties to set |
Properties
annotations
public annotations: google.cloud.datalabeling.v1beta1.IAnnotation[];Example annotations.
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.IAnnotation[] |
imagePayload
public imagePayload?: (google.cloud.datalabeling.v1beta1.IImagePayload|null);Example imagePayload.
| Type | Description |
|---|---|
| (google.cloud.datalabeling.v1beta1.IImagePayload|null) |
name
public name: string;Example name.
| Type | Description |
|---|---|
| string |
payload
public payload?: ("imagePayload"|"textPayload"|"videoPayload");Example payload.
| Type | Description |
|---|---|
| ("imagePayload"|"textPayload"|"videoPayload") |
textPayload
public textPayload?: (google.cloud.datalabeling.v1beta1.ITextPayload|null);Example textPayload.
| Type | Description |
|---|---|
| (google.cloud.datalabeling.v1beta1.ITextPayload|null) |
videoPayload
public videoPayload?: (google.cloud.datalabeling.v1beta1.IVideoPayload|null);Example videoPayload.
| Type | Description |
|---|---|
| (google.cloud.datalabeling.v1beta1.IVideoPayload|null) |
Methods
create(properties)
public static create(properties?: google.cloud.datalabeling.v1beta1.IExample): google.cloud.datalabeling.v1beta1.Example;Creates a new Example instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| IExample | properties |
Properties to set |
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Example | Example instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datalabeling.v1beta1.Example;Decodes an Example message from the specified reader or buffer.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Example | Example |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datalabeling.v1beta1.Example;Decodes an Example message from the specified reader or buffer, length delimited.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Example | Example |
encode(message, writer)
public static encode(message: google.cloud.datalabeling.v1beta1.IExample, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Example message. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IExample | message |
Example message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.datalabeling.v1beta1.IExample, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Example message, length delimited. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IExample | message |
Example message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.datalabeling.v1beta1.Example;Creates an Example message from a plain object. Also converts values to their respective internal types.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.cloud.datalabeling.v1beta1.Example | Example |
toJSON()
public toJSON(): { [k: string]: any };Converts this Example to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datalabeling.v1beta1.Example, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Example message. Also converts values to other types if specified.
| Type | Name | Description |
|---|---|---|
| google.cloud.datalabeling.v1beta1.Example | message |
Example |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Example message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|