Class OutputConfig (3.53.0) 

public final class OutputConfig extends GeneratedMessageV3 implements OutputConfigOrBuilder

The desired output location and metadata.

Protobuf type google.cloud.vision.v1p3beta1.OutputConfig

Inheritance

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

Static Fields

BATCH_SIZE_FIELD_NUMBER

public static final int BATCH_SIZE_FIELD_NUMBER
Field Value
Type Description
int

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OutputConfig getDefaultInstance()
Returns
Type Description
OutputConfig

getDescriptor()

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

newBuilder()

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

newBuilder(OutputConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBatchSize()

public int getBatchSize()

The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20.

For example, for one pdf file with 100 pages, 100 response protos will be generated. If batch_size = 20, then 5 json files each containing 20 response protos will be written under the prefix gcs_destination.uri.

Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

int32 batch_size = 2;

Returns
Type Description
int

The batchSize.

getDefaultInstanceForType()

public OutputConfig getDefaultInstanceForType()
Returns
Type Description
OutputConfig

getGcsDestination()

public GcsDestination getGcsDestination()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestination

The gcsDestination.

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestinationOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasGcsDestination()

public boolean hasGcsDestination()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
boolean

Whether the gcsDestination 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 OutputConfig.Builder newBuilderForType()
Returns
Type Description
OutputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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