Class InputConfig.Builder (2.31.0)

public static final class InputConfig.Builder extends GeneratedMessageV3.Builder<InputConfig.Builder> implements InputConfigOrBuilder

The desired input location and metadata.

Protobuf type google.cloud.documentai.v1beta2.InputConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InputConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
InputConfig.Builder
Overrides

build()

public InputConfig build()
Returns
TypeDescription
InputConfig

buildPartial()

public InputConfig buildPartial()
Returns
TypeDescription
InputConfig

clear()

public InputConfig.Builder clear()
Returns
TypeDescription
InputConfig.Builder
Overrides

clearContents()

public InputConfig.Builder clearContents()

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
InputConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InputConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
InputConfig.Builder
Overrides

clearGcsSource()

public InputConfig.Builder clearGcsSource()

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
InputConfig.Builder

clearMimeType()

public InputConfig.Builder clearMimeType()

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
InputConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InputConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
InputConfig.Builder
Overrides

clearSource()

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

clone()

public InputConfig.Builder clone()
Returns
TypeDescription
InputConfig.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getGcsSourceBuilder()

public GcsSource.Builder getGcsSourceBuilder()

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.Builder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(InputConfig other)

public InputConfig.Builder mergeFrom(InputConfig other)
Parameter
NameDescription
otherInputConfig
Returns
TypeDescription
InputConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InputConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public InputConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
InputConfig.Builder
Overrides

mergeGcsSource(GcsSource value)

public InputConfig.Builder mergeGcsSource(GcsSource value)

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

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

Parameter
NameDescription
valueGcsSource
Returns
TypeDescription
InputConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InputConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
InputConfig.Builder
Overrides

setContents(ByteString value)

public InputConfig.Builder setContents(ByteString value)

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;

Parameter
NameDescription
valueByteString

The contents to set.

Returns
TypeDescription
InputConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InputConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
InputConfig.Builder
Overrides

setGcsSource(GcsSource value)

public InputConfig.Builder setGcsSource(GcsSource value)

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

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

Parameter
NameDescription
valueGcsSource
Returns
TypeDescription
InputConfig.Builder

setGcsSource(GcsSource.Builder builderForValue)

public InputConfig.Builder setGcsSource(GcsSource.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueGcsSource.Builder
Returns
TypeDescription
InputConfig.Builder

setMimeType(String value)

public InputConfig.Builder setMimeType(String value)

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];

Parameter
NameDescription
valueString

The mimeType to set.

Returns
TypeDescription
InputConfig.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public InputConfig.Builder setMimeTypeBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for mimeType to set.

Returns
TypeDescription
InputConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public InputConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
InputConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final InputConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
InputConfig.Builder
Overrides