Represents a TrainProcessorVersionRequest.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1.ITrainProcessorVersionRequest);
Constructs a new TrainProcessorVersionRequest.
Parameter | |
---|---|
Name | Description |
properties |
ITrainProcessorVersionRequest
Properties to set |
Properties
baseProcessorVersion
public baseProcessorVersion: string;
TrainProcessorVersionRequest baseProcessorVersion.
customDocumentExtractionOptions
public customDocumentExtractionOptions?: (google.cloud.documentai.v1.TrainProcessorVersionRequest.ICustomDocumentExtractionOptions|null);
TrainProcessorVersionRequest customDocumentExtractionOptions.
documentSchema
public documentSchema?: (google.cloud.documentai.v1.IDocumentSchema|null);
TrainProcessorVersionRequest documentSchema.
foundationModelTuningOptions
public foundationModelTuningOptions?: (google.cloud.documentai.v1.TrainProcessorVersionRequest.IFoundationModelTuningOptions|null);
TrainProcessorVersionRequest foundationModelTuningOptions.
inputData
public inputData?: (google.cloud.documentai.v1.TrainProcessorVersionRequest.IInputData|null);
TrainProcessorVersionRequest inputData.
parent
public parent: string;
TrainProcessorVersionRequest parent.
processorFlags
public processorFlags?: ("customDocumentExtractionOptions"|"foundationModelTuningOptions");
TrainProcessorVersionRequest processorFlags.
processorVersion
public processorVersion?: (google.cloud.documentai.v1.IProcessorVersion|null);
TrainProcessorVersionRequest processorVersion.
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1.ITrainProcessorVersionRequest): google.cloud.documentai.v1.TrainProcessorVersionRequest;
Creates a new TrainProcessorVersionRequest instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ITrainProcessorVersionRequest
Properties to set |
Returns | |
---|---|
Type | Description |
TrainProcessorVersionRequest |
TrainProcessorVersionRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1.TrainProcessorVersionRequest;
Decodes a TrainProcessorVersionRequest message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
TrainProcessorVersionRequest |
TrainProcessorVersionRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.TrainProcessorVersionRequest;
Decodes a TrainProcessorVersionRequest message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
TrainProcessorVersionRequest |
TrainProcessorVersionRequest |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1.ITrainProcessorVersionRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TrainProcessorVersionRequest message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITrainProcessorVersionRequest
TrainProcessorVersionRequest 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.documentai.v1.ITrainProcessorVersionRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TrainProcessorVersionRequest message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITrainProcessorVersionRequest
TrainProcessorVersionRequest 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.documentai.v1.TrainProcessorVersionRequest;
Creates a TrainProcessorVersionRequest 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 |
TrainProcessorVersionRequest |
TrainProcessorVersionRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for TrainProcessorVersionRequest
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 TrainProcessorVersionRequest to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.documentai.v1.TrainProcessorVersionRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a TrainProcessorVersionRequest message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
TrainProcessorVersionRequest
TrainProcessorVersionRequest |
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 TrainProcessorVersionRequest message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|