Class ImageSource (3.41.0)

public final class ImageSource extends GeneratedMessageV3 implements ImageSourceOrBuilder

External image source (Google Cloud Storage or web URL image location).

Protobuf type google.cloud.vision.v1.ImageSource

Static Fields

GCS_IMAGE_URI_FIELD_NUMBER

public static final int GCS_IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImageSource getDefaultInstance()
Returns
Type Description
ImageSource

getDescriptor()

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

newBuilder()

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

newBuilder(ImageSource prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ImageSource getDefaultInstanceForType()
Returns
Type Description
ImageSource

getGcsImageUri()

public String getGcsImageUri()

Use image_uri instead.

The Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

string gcs_image_uri = 1;

Returns
Type Description
String

The gcsImageUri.

getGcsImageUriBytes()

public ByteString getGcsImageUriBytes()

Use image_uri instead.

The Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

string gcs_image_uri = 1;

Returns
Type Description
ByteString

The bytes for gcsImageUri.

getImageUri()

public String getImageUri()

The URI of the source image. Can be either:

  1. A Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

  2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications.

    When both gcs_image_uri and image_uri are specified, image_uri takes precedence.

string image_uri = 2;

Returns
Type Description
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

The URI of the source image. Can be either:

  1. A Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

  2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications.

    When both gcs_image_uri and image_uri are specified, image_uri takes precedence.

string image_uri = 2;

Returns
Type Description
ByteString

The bytes for imageUri.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 ImageSource.Builder newBuilderForType()
Returns
Type Description
ImageSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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