Represents an Example.
Package
@google-cloud/datalabelingConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datalabeling.v1beta1.IExample);Constructs a new Example.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExample
Properties to set |
Properties
annotations
public annotations: google.cloud.datalabeling.v1beta1.IAnnotation[];Example annotations.
imagePayload
public imagePayload?: (google.cloud.datalabeling.v1beta1.IImagePayload|null);Example imagePayload.
name
public name: string;Example name.
payload
public payload?: ("imagePayload"|"textPayload"|"videoPayload");Example payload.
textPayload
public textPayload?: (google.cloud.datalabeling.v1beta1.ITextPayload|null);Example textPayload.
videoPayload
public videoPayload?: (google.cloud.datalabeling.v1beta1.IVideoPayload|null);Example videoPayload.
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.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExample
Properties to set |
| Returns | |
|---|---|
| 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.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| 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.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| 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.
| Parameters | |
|---|---|
| Name | Description |
message |
IExample
Example message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| 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.
| Parameters | |
|---|---|
| Name | Description |
message |
IExample
Example message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| 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.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.cloud.datalabeling.v1beta1.Example | Example |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Example
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Example to JSON.
| Returns | |
|---|---|
| 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.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.datalabeling.v1beta1.Example
Example |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Example message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|