Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig (3.2.2)

Represents a HumanAnnotationConfig.

Package

@google-cloud/datalabeling

Constructors

(constructor)(properties)

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

Constructs a new HumanAnnotationConfig.

Parameter
Name	Description
`properties`	`IHumanAnnotationConfig` Properties to set

Properties

annotatedDatasetDescription

public annotatedDatasetDescription: string;

HumanAnnotationConfig annotatedDatasetDescription.

annotatedDatasetDisplayName

public annotatedDatasetDisplayName: string;

HumanAnnotationConfig annotatedDatasetDisplayName.

contributorEmails

public contributorEmails: string[];

HumanAnnotationConfig contributorEmails.

instruction

public instruction: string;

HumanAnnotationConfig instruction.

labelGroup

public labelGroup: string;

HumanAnnotationConfig labelGroup.

languageCode

public languageCode: string;

HumanAnnotationConfig languageCode.

questionDuration

public questionDuration?: (google.protobuf.IDuration|null);

HumanAnnotationConfig questionDuration.

replicaCount

public replicaCount: number;

HumanAnnotationConfig replicaCount.

userEmailAddress

public userEmailAddress: string;

HumanAnnotationConfig userEmailAddress.

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IHumanAnnotationConfig): google.cloud.datalabeling.v1beta1.HumanAnnotationConfig;

Creates a new HumanAnnotationConfig instance using the specified properties.

Parameter
Name	Description
`properties`	`IHumanAnnotationConfig` Properties to set

Returns
Type	Description
`google.cloud.datalabeling.v1beta1.HumanAnnotationConfig`	HumanAnnotationConfig instance

decode(reader, length)

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

Decodes a HumanAnnotationConfig 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.HumanAnnotationConfig`	HumanAnnotationConfig

decodeDelimited(reader)

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

Decodes a HumanAnnotationConfig 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.HumanAnnotationConfig`	HumanAnnotationConfig

encode(message, writer)

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

Encodes the specified HumanAnnotationConfig message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IHumanAnnotationConfig` HumanAnnotationConfig 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.IHumanAnnotationConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IHumanAnnotationConfig` HumanAnnotationConfig 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.HumanAnnotationConfig;

Creates a HumanAnnotationConfig 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.HumanAnnotationConfig`	HumanAnnotationConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for HumanAnnotationConfig

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 HumanAnnotationConfig to JSON.

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.cloud.datalabeling.v1beta1.HumanAnnotationConfig` HumanAnnotationConfig
`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 a HumanAnnotationConfig message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not