Class InputConfig (3.43.0)

public final class InputConfig extends GeneratedMessageV3 implements InputConfigOrBuilder

The desired input location and metadata.

Protobuf type google.cloud.vision.v1.InputConfig

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 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
Overrides

getContent()

public ByteString getContent()

File content, represented as a stream of bytes. Note: As with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64.

Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.

bytes content = 3;

Returns
Type Description
ByteString

The content.

getDefaultInstanceForType()

public InputConfig getDefaultInstanceForType()
Returns
Type Description
InputConfig

getGcsSource()

public GcsSource getGcsSource()

The Google Cloud Storage location to read the input from.

.google.cloud.vision.v1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Google Cloud Storage location to read the input from.

.google.cloud.vision.v1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSourceOrBuilder

getMimeType()

public String getMimeType()

The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported.

string mime_type = 2;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported.

string mime_type = 2;

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasGcsSource()

public boolean hasGcsSource()

The Google Cloud Storage location to read the input from.

.google.cloud.vision.v1.GcsSource gcs_source = 1;

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 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
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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