Class protos.google.cloud.datalabeling.v1beta1.LabelImageRequest

Represents a LabelImageRequest.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

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

Constructs a new LabelImageRequest.

Parameter

Type	Name	Description
google.cloud.datalabeling.v1beta1.ILabelImageRequest	properties	Properties to set

Properties

basicConfig

public basicConfig?: (google.cloud.datalabeling.v1beta1.IHumanAnnotationConfig|null);

LabelImageRequest basicConfig.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IHumanAnnotationConfig\|null)

boundingPolyConfig

public boundingPolyConfig?: (google.cloud.datalabeling.v1beta1.IBoundingPolyConfig|null);

LabelImageRequest boundingPolyConfig.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IBoundingPolyConfig\|null)

feature

public feature: (google.cloud.datalabeling.v1beta1.LabelImageRequest.Feature|keyof typeof google.cloud.datalabeling.v1beta1.LabelImageRequest.Feature);

LabelImageRequest feature.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.LabelImageRequest.Feature\|keyof typeof google.cloud.datalabeling.v1beta1.LabelImageRequest.Feature)

imageClassificationConfig

public imageClassificationConfig?: (google.cloud.datalabeling.v1beta1.IImageClassificationConfig|null);

LabelImageRequest imageClassificationConfig.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IImageClassificationConfig\|null)

parent

public parent: string;

LabelImageRequest parent.

Property Value

Type	Description
string

polylineConfig

public polylineConfig?: (google.cloud.datalabeling.v1beta1.IPolylineConfig|null);

LabelImageRequest polylineConfig.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IPolylineConfig\|null)

requestConfig

public requestConfig?: ("imageClassificationConfig"|"boundingPolyConfig"|"polylineConfig"|"segmentationConfig");

LabelImageRequest requestConfig.

Property Value

Type	Description
("imageClassificationConfig"\|"boundingPolyConfig"\|"polylineConfig"\|"segmentationConfig")

segmentationConfig

public segmentationConfig?: (google.cloud.datalabeling.v1beta1.ISegmentationConfig|null);

LabelImageRequest segmentationConfig.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ISegmentationConfig\|null)

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.ILabelImageRequest): google.cloud.datalabeling.v1beta1.LabelImageRequest;

Creates a new LabelImageRequest instance using the specified properties.

Parameter

Type	Name	Description
google.cloud.datalabeling.v1beta1.ILabelImageRequest	properties	Properties to set

Returns

Type	Description
google.cloud.datalabeling.v1beta1.LabelImageRequest	LabelImageRequest instance

decode(reader, length)

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

Decodes a LabelImageRequest 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.LabelImageRequest	LabelImageRequest

decodeDelimited(reader)

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

Decodes a LabelImageRequest 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.LabelImageRequest	LabelImageRequest

encode(message, writer)

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

Encodes the specified LabelImageRequest message. Does not implicitly messages.

Parameters

Type	Name	Description
google.cloud.datalabeling.v1beta1.ILabelImageRequest	message	LabelImageRequest 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.ILabelImageRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
google.cloud.datalabeling.v1beta1.ILabelImageRequest	message	LabelImageRequest 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.LabelImageRequest;

Creates a LabelImageRequest 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.LabelImageRequest	LabelImageRequest

toJSON()

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

Converts this LabelImageRequest to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.cloud.datalabeling.v1beta1.LabelImageRequest	message	LabelImageRequest
$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 LabelImageRequest 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