Class DocumentInputConfig (2.53.0) 

public final class DocumentInputConfig extends GeneratedMessageV3 implements DocumentInputConfigOrBuilder

A document translation request input config.

Protobuf type google.cloud.translation.v3beta1.DocumentInputConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentInputConfig

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_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 DocumentInputConfig getDefaultInstance()
Returns
Type Description
DocumentInputConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DocumentInputConfig.Builder newBuilder()
Returns
Type Description
DocumentInputConfig.Builder

newBuilder(DocumentInputConfig prototype)

public static DocumentInputConfig.Builder newBuilder(DocumentInputConfig prototype)
Parameter
Name Description
prototype DocumentInputConfig
Returns
Type Description
DocumentInputConfig.Builder

parseDelimitedFrom(InputStream input)

public static DocumentInputConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentInputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentInputConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentInputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentInputConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentInputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentInputConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentInputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentInputConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentInputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentInputConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentInputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentInputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentInputConfig> parser()
Returns
Type Description
Parser<DocumentInputConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContent()

public ByteString getContent()

Document's content represented as a stream of bytes.

bytes content = 1;

Returns
Type Description
ByteString

The content.

getDefaultInstanceForType()

public DocumentInputConfig getDefaultInstanceForType()
Returns
Type Description
DocumentInputConfig

getGcsSource()

public GcsSource getGcsSource()

Google Cloud Storage location. This must be a single file. For example: gs://example_bucket/example_file.pdf

.google.cloud.translation.v3beta1.GcsSource gcs_source = 2;

Returns
Type Description
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

Google Cloud Storage location. This must be a single file. For example: gs://example_bucket/example_file.pdf

.google.cloud.translation.v3beta1.GcsSource gcs_source = 2;

Returns
Type Description
GcsSourceOrBuilder

getMimeType()

public String getMimeType()

Specifies the input document's mime_type.

If not specified it will be determined using the file extension for gcs_source provided files. For a file provided through bytes content the mime_type must be provided. Currently supported mime types are:

  • application/pdf
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.openxmlformats-officedocument.presentationml.presentation
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string mime_type = 4;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Specifies the input document's mime_type.

If not specified it will be determined using the file extension for gcs_source provided files. For a file provided through bytes content the mime_type must be provided. Currently supported mime types are:

  • application/pdf
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.openxmlformats-officedocument.presentationml.presentation
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string mime_type = 4;

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

public Parser<DocumentInputConfig> getParserForType()
Returns
Type Description
Parser<DocumentInputConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public DocumentInputConfig.SourceCase getSourceCase()
Returns
Type Description
DocumentInputConfig.SourceCase

hasContent()

public boolean hasContent()

Document's content represented as a stream of bytes.

bytes content = 1;

Returns
Type Description
boolean

Whether the content field is set.

hasGcsSource()

public boolean hasGcsSource()

Google Cloud Storage location. This must be a single file. For example: gs://example_bucket/example_file.pdf

.google.cloud.translation.v3beta1.GcsSource gcs_source = 2;

Returns
Type Description
boolean

Whether the gcsSource field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentInputConfig.Builder newBuilderForType()
Returns
Type Description
DocumentInputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentInputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentInputConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentInputConfig.Builder toBuilder()
Returns
Type Description
DocumentInputConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException