Represents an AnnotationSpec.
Package
@google-cloud/datalabeling!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.datalabeling.v1beta1.IAnnotationSpec);
Constructs a new AnnotationSpec.
Type | Name | Description |
---|---|---|
IAnnotationSpec | properties |
Properties to set |
Properties
description
public description: string;
AnnotationSpec description.
Type | Description |
---|---|
string |
displayName
public displayName: string;
AnnotationSpec displayName.
Type | Description |
---|---|
string |
Methods
create(properties)
public static create(properties?: google.cloud.datalabeling.v1beta1.IAnnotationSpec): google.cloud.datalabeling.v1beta1.AnnotationSpec;
Creates a new AnnotationSpec instance using the specified properties.
Type | Name | Description |
---|---|---|
IAnnotationSpec | properties |
Properties to set |
Type | Description |
---|---|
google.cloud.datalabeling.v1beta1.AnnotationSpec | AnnotationSpec instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datalabeling.v1beta1.AnnotationSpec;
Decodes an AnnotationSpec 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.AnnotationSpec | AnnotationSpec |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datalabeling.v1beta1.AnnotationSpec;
Decodes an AnnotationSpec 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.AnnotationSpec | AnnotationSpec |
encode(message, writer)
public static encode(message: google.cloud.datalabeling.v1beta1.IAnnotationSpec, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AnnotationSpec message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IAnnotationSpec | message |
AnnotationSpec 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.IAnnotationSpec, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AnnotationSpec message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IAnnotationSpec | message |
AnnotationSpec 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.AnnotationSpec;
Creates an AnnotationSpec 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.AnnotationSpec | AnnotationSpec |
toJSON()
public toJSON(): { [k: string]: any };
Converts this AnnotationSpec to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datalabeling.v1beta1.AnnotationSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an AnnotationSpec message. Also converts values to other types if specified.
Type | Name | Description |
---|---|---|
google.cloud.datalabeling.v1beta1.AnnotationSpec | message |
AnnotationSpec |
$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 AnnotationSpec message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|