Class protos.google.cloud.datalabeling.v1beta1.InputConfig

Represents an InputConfig.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

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

Constructs a new InputConfig.

Parameter
TypeNameDescription
IInputConfigproperties

Properties to set

Properties

annotationType

public annotationType: (google.cloud.datalabeling.v1beta1.AnnotationType|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationType);

InputConfig annotationType.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.AnnotationType|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationType)

bigquerySource

public bigquerySource?: (google.cloud.datalabeling.v1beta1.IBigQuerySource|null);

InputConfig bigquerySource.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.IBigQuerySource|null)

classificationMetadata

public classificationMetadata?: (google.cloud.datalabeling.v1beta1.IClassificationMetadata|null);

InputConfig classificationMetadata.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.IClassificationMetadata|null)

dataType

public dataType: (google.cloud.datalabeling.v1beta1.DataType|keyof typeof google.cloud.datalabeling.v1beta1.DataType);

InputConfig dataType.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.DataType|keyof typeof google.cloud.datalabeling.v1beta1.DataType)

dataTypeMetadata

public dataTypeMetadata?: "textMetadata";

InputConfig dataTypeMetadata.

Property Value
TypeDescription
"textMetadata"

gcsSource

public gcsSource?: (google.cloud.datalabeling.v1beta1.IGcsSource|null);

InputConfig gcsSource.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.IGcsSource|null)

source

public source?: ("gcsSource"|"bigquerySource");

InputConfig source.

Property Value
TypeDescription
("gcsSource"|"bigquerySource")

textMetadata

public textMetadata?: (google.cloud.datalabeling.v1beta1.ITextMetadata|null);

InputConfig textMetadata.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.ITextMetadata|null)

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IInputConfig): google.cloud.datalabeling.v1beta1.InputConfig;

Creates a new InputConfig instance using the specified properties.

Parameter
TypeNameDescription
IInputConfigproperties

Properties to set

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.InputConfig

InputConfig instance

decode(reader, length)

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

Decodes an InputConfig message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.InputConfig

InputConfig

decodeDelimited(reader)

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

Decodes an InputConfig message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.InputConfig

InputConfig

encode(message, writer)

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

Encodes the specified InputConfig message. Does not implicitly messages.

Parameters
TypeNameDescription
IInputConfigmessage

InputConfig message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
IInputConfigmessage

InputConfig message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datalabeling.v1beta1.InputConfig;

Creates an InputConfig message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.InputConfig

InputConfig

toJSON()

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

Converts this InputConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.datalabeling.v1beta1.InputConfigmessage

InputConfig

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an InputConfig message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not