- 2.52.0 (latest)
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
public final class InputConfig extends GeneratedMessageV3 implements InputConfigOrBuilder
The desired input location and metadata.
Protobuf type google.cloud.documentai.v1beta2.InputConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InputConfigImplements
InputConfigOrBuilderStatic Fields
CONTENTS_FIELD_NUMBER
public static final int CONTENTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
GCS_SOURCE_FIELD_NUMBER
public static final int GCS_SOURCE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MIME_TYPE_FIELD_NUMBER
public static final int MIME_TYPE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static InputConfig getDefaultInstance()
Returns | |
---|---|
Type | Description |
InputConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static InputConfig.Builder newBuilder()
Returns | |
---|---|
Type | Description |
InputConfig.Builder |
newBuilder(InputConfig prototype)
public static InputConfig.Builder newBuilder(InputConfig prototype)
Parameter | |
---|---|
Name | Description |
prototype |
InputConfig |
Returns | |
---|---|
Type | Description |
InputConfig.Builder |
parseDelimitedFrom(InputStream input)
public static InputConfig parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static InputConfig parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static InputConfig parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static InputConfig parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static InputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static InputConfig parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static InputConfig parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InputConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<InputConfig> parser()
Returns | |
---|---|
Type | Description |
Parser<InputConfig> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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 | |
---|---|
Type | Description |
ByteString |
The contents. |
getDefaultInstanceForType()
public InputConfig getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString |
The bytes for mimeType. |
getParserForType()
public Parser<InputConfig> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<InputConfig> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getSourceCase()
public InputConfig.SourceCase getSourceCase()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean |
Whether the gcsSource field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public InputConfig.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
InputConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
InputConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public InputConfig.Builder toBuilder()
Returns | |
---|---|
Type | Description |
InputConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |