Class protos.google.cloud.datalabeling.v1beta1.AnnotationSpecSet

Represents an AnnotationSpecSet.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

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

Constructs a new AnnotationSpecSet.

Parameter
Type Name Description
IAnnotationSpecSet properties

Properties to set

Properties

annotationSpecs

public annotationSpecs: google.cloud.datalabeling.v1beta1.IAnnotationSpec[];

AnnotationSpecSet annotationSpecs.

Property Value
Type Description
google.cloud.datalabeling.v1beta1.IAnnotationSpec[]

blockingResources

public blockingResources: string[];

AnnotationSpecSet blockingResources.

Property Value
Type Description
string[]

description

public description: string;

AnnotationSpecSet description.

Property Value
Type Description
string

displayName

public displayName: string;

AnnotationSpecSet displayName.

Property Value
Type Description
string

name

public name: string;

AnnotationSpecSet name.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IAnnotationSpecSet): google.cloud.datalabeling.v1beta1.AnnotationSpecSet;

Creates a new AnnotationSpecSet instance using the specified properties.

Parameter
Type Name Description
IAnnotationSpecSet properties

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

AnnotationSpecSet instance

decode(reader, length)

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

Decodes an AnnotationSpecSet 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.AnnotationSpecSet

AnnotationSpecSet

decodeDelimited(reader)

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

Decodes an AnnotationSpecSet 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.AnnotationSpecSet

AnnotationSpecSet

encode(message, writer)

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

Encodes the specified AnnotationSpecSet message. Does not implicitly messages.

Parameters
Type Name Description
IAnnotationSpecSet message

AnnotationSpecSet 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.IAnnotationSpecSet, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
IAnnotationSpecSet message

AnnotationSpecSet 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.AnnotationSpecSet;

Creates an AnnotationSpecSet 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.AnnotationSpecSet

AnnotationSpecSet

toJSON()

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

Converts this AnnotationSpecSet to JSON.

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

JSON object

toObject(message, options)

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

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

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

AnnotationSpecSet
$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 an AnnotationSpecSet 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