Class InputConfig (2.35.0)

public final class InputConfig extends GeneratedMessageV3 implements InputConfigOrBuilder

The desired input location and metadata.

Protobuf type google.cloud.documentai.v1beta2.InputConfig

Static Fields

CONTENTS_FIELD_NUMBER

public static final int CONTENTS_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InputConfig getDefaultInstance()
Returns
TypeDescription
InputConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static InputConfig.Builder newBuilder()
Returns
TypeDescription
InputConfig.Builder

newBuilder(InputConfig prototype)

public static InputConfig.Builder newBuilder(InputConfig prototype)
Parameter
NameDescription
prototypeInputConfig
Returns
TypeDescription
InputConfig.Builder

parseDelimitedFrom(InputStream input)

public static InputConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InputConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InputConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InputConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InputConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InputConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InputConfig> parser()
Returns
TypeDescription
Parser<InputConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContents()

public ByteString getContents()

Content in bytes, represented as a stream of bytes. Note: As with all bytes fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64.

This field only works for synchronous ProcessDocument method.

bytes contents = 3;

Returns
TypeDescription
ByteString

The contents.

getDefaultInstanceForType()

public InputConfig getDefaultInstanceForType()
Returns
TypeDescription
InputConfig

getGcsSource()

public GcsSource getGcsSource()

The Google Cloud Storage location to read the input from. This must be a single file.

.google.cloud.documentai.v1beta2.GcsSource gcs_source = 1;

Returns
TypeDescription
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Google Cloud Storage location to read the input from. This must be a single file.

.google.cloud.documentai.v1beta2.GcsSource gcs_source = 1;

Returns
TypeDescription
GcsSourceOrBuilder

getMimeType()

public String getMimeType()

Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.

string mime_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.

string mime_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for mimeType.

getParserForType()

public Parser<InputConfig> getParserForType()
Returns
TypeDescription
Parser<InputConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public InputConfig.SourceCase getSourceCase()
Returns
TypeDescription
InputConfig.SourceCase

hasContents()

public boolean hasContents()

Content in bytes, represented as a stream of bytes. Note: As with all bytes fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64.

This field only works for synchronous ProcessDocument method.

bytes contents = 3;

Returns
TypeDescription
boolean

Whether the contents field is set.

hasGcsSource()

public boolean hasGcsSource()

The Google Cloud Storage location to read the input from. This must be a single file.

.google.cloud.documentai.v1beta2.GcsSource gcs_source = 1;

Returns
TypeDescription
boolean

Whether the gcsSource field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InputConfig.Builder newBuilderForType()
Returns
TypeDescription
InputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InputConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InputConfig.Builder toBuilder()
Returns
TypeDescription
InputConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException