AnnotatedDataset

google.cloud.datalabeling.v1beta1. AnnotatedDataset

Represents an AnnotatedDataset.

Constructor

new AnnotatedDataset(propertiesopt)

Constructs a new AnnotatedDataset.

Parameters:
Name Type Attributes Description
properties google.cloud.datalabeling.v1beta1.IAnnotatedDataset <optional>

Properties to set

Implements:
  • IAnnotatedDataset

Members

annotationSource

AnnotatedDataset annotationSource.

annotationType

AnnotatedDataset annotationType.

blockingResources

AnnotatedDataset blockingResources.

completedExampleCount

AnnotatedDataset completedExampleCount.

createTime

AnnotatedDataset createTime.

description

AnnotatedDataset description.

displayName

AnnotatedDataset displayName.

exampleCount

AnnotatedDataset exampleCount.

labelStats

AnnotatedDataset labelStats.

metadata

AnnotatedDataset metadata.

name

AnnotatedDataset name.

Methods

toJSON() → {Object.<string, *>}

Converts this AnnotatedDataset to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.datalabeling.v1beta1.AnnotatedDataset}

Creates a new AnnotatedDataset instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.datalabeling.v1beta1.IAnnotatedDataset <optional>

Properties to set

Returns:
Type Description
google.cloud.datalabeling.v1beta1.AnnotatedDataset

AnnotatedDataset instance

(static) decode(reader, lengthopt) → {google.cloud.datalabeling.v1beta1.AnnotatedDataset}

Decodes an AnnotatedDataset message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.datalabeling.v1beta1.AnnotatedDataset

AnnotatedDataset

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.datalabeling.v1beta1.AnnotatedDataset}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.datalabeling.v1beta1.AnnotatedDataset

AnnotatedDataset

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified AnnotatedDataset message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.datalabeling.v1beta1.IAnnotatedDataset

AnnotatedDataset message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.datalabeling.v1beta1.IAnnotatedDataset

AnnotatedDataset message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.datalabeling.v1beta1.AnnotatedDataset}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.datalabeling.v1beta1.AnnotatedDataset

AnnotatedDataset

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AnnotatedDataset

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.datalabeling.v1beta1.AnnotatedDataset

AnnotatedDataset

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an AnnotatedDataset message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not