Class AnnotateImageRequest (3.34.0)

public final class AnnotateImageRequest extends GeneratedMessageV3 implements AnnotateImageRequestOrBuilder

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.

Protobuf type google.cloud.vision.v1.AnnotateImageRequest

Static Fields

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_CONTEXT_FIELD_NUMBER

public static final int IMAGE_CONTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_FIELD_NUMBER

public static final int IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnnotateImageRequest getDefaultInstance()
Returns
TypeDescription
AnnotateImageRequest

getDescriptor()

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

newBuilder()

public static AnnotateImageRequest.Builder newBuilder()
Returns
TypeDescription
AnnotateImageRequest.Builder

newBuilder(AnnotateImageRequest prototype)

public static AnnotateImageRequest.Builder newBuilder(AnnotateImageRequest prototype)
Parameter
NameDescription
prototypeAnnotateImageRequest
Returns
TypeDescription
AnnotateImageRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateImageRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AnnotateImageRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateImageRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateImageRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AnnotateImageRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AnnotateImageRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AnnotateImageRequest> parser()
Returns
TypeDescription
Parser<AnnotateImageRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AnnotateImageRequest getDefaultInstanceForType()
Returns
TypeDescription
AnnotateImageRequest

getFeatures(int index)

public Feature getFeatures(int index)

Requested features.

repeated .google.cloud.vision.v1.Feature features = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Feature

getFeaturesCount()

public int getFeaturesCount()

Requested features.

repeated .google.cloud.vision.v1.Feature features = 2;

Returns
TypeDescription
int

getFeaturesList()

public List<Feature> getFeaturesList()

Requested features.

repeated .google.cloud.vision.v1.Feature features = 2;

Returns
TypeDescription
List<Feature>

getFeaturesOrBuilder(int index)

public FeatureOrBuilder getFeaturesOrBuilder(int index)

Requested features.

repeated .google.cloud.vision.v1.Feature features = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
FeatureOrBuilder

getFeaturesOrBuilderList()

public List<? extends FeatureOrBuilder> getFeaturesOrBuilderList()

Requested features.

repeated .google.cloud.vision.v1.Feature features = 2;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1.FeatureOrBuilder>

getImage()

public Image getImage()

The image to be processed.

.google.cloud.vision.v1.Image image = 1;

Returns
TypeDescription
Image

The image.

getImageContext()

public ImageContext getImageContext()

Additional context that may accompany the image.

.google.cloud.vision.v1.ImageContext image_context = 3;

Returns
TypeDescription
ImageContext

The imageContext.

getImageContextOrBuilder()

public ImageContextOrBuilder getImageContextOrBuilder()

Additional context that may accompany the image.

.google.cloud.vision.v1.ImageContext image_context = 3;

Returns
TypeDescription
ImageContextOrBuilder

getImageOrBuilder()

public ImageOrBuilder getImageOrBuilder()

The image to be processed.

.google.cloud.vision.v1.Image image = 1;

Returns
TypeDescription
ImageOrBuilder

getParserForType()

public Parser<AnnotateImageRequest> getParserForType()
Returns
TypeDescription
Parser<AnnotateImageRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasImage()

public boolean hasImage()

The image to be processed.

.google.cloud.vision.v1.Image image = 1;

Returns
TypeDescription
boolean

Whether the image field is set.

hasImageContext()

public boolean hasImageContext()

Additional context that may accompany the image.

.google.cloud.vision.v1.ImageContext image_context = 3;

Returns
TypeDescription
boolean

Whether the imageContext field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AnnotateImageRequest.Builder newBuilderForType()
Returns
TypeDescription
AnnotateImageRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateImageRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AnnotateImageRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AnnotateImageRequest.Builder toBuilder()
Returns
TypeDescription
AnnotateImageRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException