Class Collection (0.10.0)

public final class Collection extends GeneratedMessageV3 implements CollectionOrBuilder

A collection is a resource in a corpus. It serves as a container of references to original resources.

Protobuf type google.cloud.visionai.v1.Collection

Implements

CollectionOrBuilder

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Collection getDefaultInstance()
Returns
Type Description
Collection

getDescriptor()

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

newBuilder()

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

newBuilder(Collection prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Collection getDefaultInstanceForType()
Returns
Type Description
Collection

getDescription()

public String getDescription()

Optional. Description of the collection. Can be up to 25000 characters long.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the collection. Can be up to 25000 characters long.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Optional. The collection name for displaying. The name can be up to 256 characters long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The collection name for displaying. The name can be up to 256 characters long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Collection> getParserForType()
Returns
Type Description
Parser<Collection>
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 Collection.Builder newBuilderForType()
Returns
Type Description
Collection.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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