Class Index.Builder (0.1.0) 

public static final class Index.Builder extends GeneratedMessageV3.Builder<Index.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Index.Builder

Implements

IndexOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllDeployedIndexes(Iterable<? extends DeployedIndexReference> values)

public Index.Builder addAllDeployedIndexes(Iterable<? extends DeployedIndexReference> values)

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
values Iterable<? extends com.google.cloud.visionai.v1.DeployedIndexReference>
Returns
Type Description
Index.Builder

addDeployedIndexes(DeployedIndexReference value)

public Index.Builder addDeployedIndexes(DeployedIndexReference value)

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
value DeployedIndexReference
Returns
Type Description
Index.Builder

addDeployedIndexes(DeployedIndexReference.Builder builderForValue)

public Index.Builder addDeployedIndexes(DeployedIndexReference.Builder builderForValue)

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
builderForValue DeployedIndexReference.Builder
Returns
Type Description
Index.Builder

addDeployedIndexes(int index, DeployedIndexReference value)

public Index.Builder addDeployedIndexes(int index, DeployedIndexReference value)

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];

Parameters
Name Description
index int
value DeployedIndexReference
Returns
Type Description
Index.Builder

addDeployedIndexes(int index, DeployedIndexReference.Builder builderForValue)

public Index.Builder addDeployedIndexes(int index, DeployedIndexReference.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue DeployedIndexReference.Builder
Returns
Type Description
Index.Builder

addDeployedIndexesBuilder()

public DeployedIndexReference.Builder addDeployedIndexesBuilder()

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
DeployedIndexReference.Builder

addDeployedIndexesBuilder(int index)

public DeployedIndexReference.Builder addDeployedIndexesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.Builder
Overrides

build()

public Index build()
Returns
Type Description
Index

buildPartial()

public Index buildPartial()
Returns
Type Description
Index

clear()

public Index.Builder clear()
Returns
Type Description
Index.Builder
Overrides

clearAssetFilter()

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

clearCreateTime()

public Index.Builder clearCreateTime()

Output only. The create timestamp.

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

Returns
Type Description
Index.Builder

clearDeployedIndexes()

public Index.Builder clearDeployedIndexes()

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
Index.Builder

clearDescription()

public Index.Builder clearDescription()

Optional. Optional description of the index.

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

Returns
Type Description
Index.Builder

This builder for chaining.

clearDisplayName()

public Index.Builder clearDisplayName()

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

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

Returns
Type Description
Index.Builder

This builder for chaining.

clearEntireCorpus()

public Index.Builder clearEntireCorpus()

Include all assets under the corpus.

bool entire_corpus = 9;

Returns
Type Description
Index.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Index.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Index.Builder
Overrides

clearName()

public Index.Builder clearName()

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
Index.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Index.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Index.Builder
Overrides

clearState()

public Index.Builder clearState()

Output only. State of the index.

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

Returns
Type Description
Index.Builder

This builder for chaining.

clearUpdateTime()

public Index.Builder clearUpdateTime()

Output only. The update timestamp.

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

Returns
Type Description
Index.Builder

clone()

public Index.Builder clone()
Returns
Type Description
Index.Builder
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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The create timestamp.

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

Returns
Type Description
Builder

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

getDeployedIndexesBuilder(int index)

public DeployedIndexReference.Builder getDeployedIndexesBuilder(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.Builder

getDeployedIndexesBuilderList()

public List<DeployedIndexReference.Builder> getDeployedIndexesBuilderList()

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<Builder>

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The update timestamp.

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

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Index.Builder mergeCreateTime(Timestamp value)

Output only. The create timestamp.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Index.Builder

mergeFrom(Index other)

public Index.Builder mergeFrom(Index other)
Parameter
Name Description
other Index
Returns
Type Description
Index.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Index.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Index.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Index.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Index.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Index.Builder mergeUpdateTime(Timestamp value)

Output only. The update timestamp.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Index.Builder

removeDeployedIndexes(int index)

public Index.Builder removeDeployedIndexes(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
Index.Builder

setCreateTime(Timestamp value)

public Index.Builder setCreateTime(Timestamp value)

Output only. The create timestamp.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Index.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Index.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The create timestamp.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Index.Builder

setDeployedIndexes(int index, DeployedIndexReference value)

public Index.Builder setDeployedIndexes(int index, DeployedIndexReference value)

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];

Parameters
Name Description
index int
value DeployedIndexReference
Returns
Type Description
Index.Builder

setDeployedIndexes(int index, DeployedIndexReference.Builder builderForValue)

public Index.Builder setDeployedIndexes(int index, DeployedIndexReference.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue DeployedIndexReference.Builder
Returns
Type Description
Index.Builder

setDescription(String value)

public Index.Builder setDescription(String value)

Optional. Optional description of the index.

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

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Index.Builder setDescriptionBytes(ByteString value)

Optional. Optional description of the index.

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

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setDisplayName(String value)

public Index.Builder setDisplayName(String value)

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

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Index.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setEntireCorpus(boolean value)

public Index.Builder setEntireCorpus(boolean value)

Include all assets under the corpus.

bool entire_corpus = 9;

Parameter
Name Description
value boolean

The entireCorpus to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.Builder
Overrides

setName(String value)

public Index.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Index.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Index.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Index.Builder
Overrides

setState(Index.State value)

public Index.Builder setState(Index.State value)

Output only. State of the index.

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

Parameter
Name Description
value Index.State

The state to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setStateValue(int value)

public Index.Builder setStateValue(int value)

Output only. State of the index.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Index.Builder
Overrides

setUpdateTime(Timestamp value)

public Index.Builder setUpdateTime(Timestamp value)

Output only. The update timestamp.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Index.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Index.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The update timestamp.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Index.Builder