TrainProcessorVersionRequest

google.cloud.documentai.v1beta3. TrainProcessorVersionRequest

Represents a TrainProcessorVersionRequest.

Constructor

new TrainProcessorVersionRequest(propertiesopt)

Constructs a new TrainProcessorVersionRequest.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.ITrainProcessorVersionRequest <optional>

Properties to set

Implements:
  • ITrainProcessorVersionRequest

Classes

CustomDocumentExtractionOptions
FoundationModelTuningOptions
InputData

Members

baseProcessorVersion

TrainProcessorVersionRequest baseProcessorVersion.

customDocumentExtractionOptions

TrainProcessorVersionRequest customDocumentExtractionOptions.

documentSchema

TrainProcessorVersionRequest documentSchema.

foundationModelTuningOptions

TrainProcessorVersionRequest foundationModelTuningOptions.

inputData

TrainProcessorVersionRequest inputData.

parent

TrainProcessorVersionRequest parent.

processorFlags

TrainProcessorVersionRequest processorFlags.

processorVersion

TrainProcessorVersionRequest processorVersion.

Methods

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

Converts this TrainProcessorVersionRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.documentai.v1beta3.TrainProcessorVersionRequest}

Creates a new TrainProcessorVersionRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.ITrainProcessorVersionRequest <optional>

Properties to set

Returns:
Type Description
google.cloud.documentai.v1beta3.TrainProcessorVersionRequest

TrainProcessorVersionRequest instance

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta3.TrainProcessorVersionRequest}

Decodes a TrainProcessorVersionRequest 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.documentai.v1beta3.TrainProcessorVersionRequest

TrainProcessorVersionRequest

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.documentai.v1beta3.TrainProcessorVersionRequest}

Decodes a TrainProcessorVersionRequest 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.documentai.v1beta3.TrainProcessorVersionRequest

TrainProcessorVersionRequest

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 TrainProcessorVersionRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.ITrainProcessorVersionRequest

TrainProcessorVersionRequest 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 TrainProcessorVersionRequest message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.ITrainProcessorVersionRequest

TrainProcessorVersionRequest 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.documentai.v1beta3.TrainProcessorVersionRequest}

Creates a TrainProcessorVersionRequest 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.documentai.v1beta3.TrainProcessorVersionRequest

TrainProcessorVersionRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for TrainProcessorVersionRequest

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 a TrainProcessorVersionRequest message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.TrainProcessorVersionRequest

TrainProcessorVersionRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a TrainProcessorVersionRequest 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