Class Index (0.4.0) 

public final class Index extends GeneratedMessageV3 implements IndexOrBuilder

An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.

Protobuf type google.cloud.visionai.v1.Index

Inheritance

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

Implements

IndexOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DEPLOYED_INDEXES_FIELD_NUMBER

public static final int DEPLOYED_INDEXES_FIELD_NUMBER
Field Value
Type Description
int

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

ENTIRE_CORPUS_FIELD_NUMBER

public static final int ENTIRE_CORPUS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Index getDefaultInstance()
Returns
Type Description
Index

getDescriptor()

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

newBuilder()

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

newBuilder(Index prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAssetFilterCase()

public Index.AssetFilterCase getAssetFilterCase()
Returns
Type Description
Index.AssetFilterCase

getCreateTime()

public Timestamp getCreateTime()

Output only. The create timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The create timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Index getDefaultInstanceForType()
Returns
Type Description
Index

getDeployedIndexes(int index)

public DeployedIndexReference getDeployedIndexes(int index)

Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DeployedIndexReference

getDeployedIndexesCount()

public int getDeployedIndexesCount()

Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getDeployedIndexesList()

public List<DeployedIndexReference> getDeployedIndexesList()

Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<DeployedIndexReference>

getDeployedIndexesOrBuilder(int index)

public DeployedIndexReferenceOrBuilder getDeployedIndexesOrBuilder(int index)

Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DeployedIndexReferenceOrBuilder

getDeployedIndexesOrBuilderList()

public List<? extends DeployedIndexReferenceOrBuilder> getDeployedIndexesOrBuilderList()

Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.DeployedIndexReferenceOrBuilder>

getDescription()

public String getDescription()

Optional. Optional description of the index.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Optional description of the index.

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

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Optional. Optional user-specified display name of the index.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Optional user-specified display name of the index.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEntireCorpus()

public boolean getEntireCorpus()

Include all assets under the corpus.

bool entire_corpus = 9;

Returns
Type Description
boolean

The entireCorpus.

getName()

public String getName()

Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

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 Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Index.State getState()

Output only. State of the index.

.google.cloud.visionai.v1.Index.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the index.

.google.cloud.visionai.v1.Index.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The update timestamp.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The update timestamp.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The create timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEntireCorpus()

public boolean hasEntireCorpus()

Include all assets under the corpus.

bool entire_corpus = 9;

Returns
Type Description
boolean

Whether the entireCorpus field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The update timestamp.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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