Class DeployedIndex.Builder (3.3.0)

public static final class DeployedIndex.Builder extends GeneratedMessageV3.Builder<DeployedIndex.Builder> implements DeployedIndexOrBuilder

A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.

Protobuf type google.cloud.aiplatform.v1.DeployedIndex

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DeployedIndex.Builder

Implements

DeployedIndexOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllReservedIpRanges(Iterable<String> values)

public DeployedIndex.Builder addAllReservedIpRanges(Iterable<String> values)

Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value sohuld be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: 'vertex-ai-ip-range'.

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
values	`Iterable<String>` The reservedIpRanges to add.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployedIndex.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addReservedIpRanges(String value)

public DeployedIndex.Builder addReservedIpRanges(String value)

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`String` The reservedIpRanges to add.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

addReservedIpRangesBytes(ByteString value)

public DeployedIndex.Builder addReservedIpRangesBytes(ByteString value)

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`ByteString` The bytes of the reservedIpRanges to add.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

build()

public DeployedIndex build()

Returns

Type	Description
DeployedIndex

buildPartial()

public DeployedIndex buildPartial()

Returns

Type	Description
DeployedIndex

clear()

public DeployedIndex.Builder clear()

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAutomaticResources()

public DeployedIndex.Builder clearAutomaticResources()

Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndex.Builder

clearCreateTime()

public DeployedIndex.Builder clearCreateTime()

Output only. Timestamp when the DeployedIndex was created.

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

Returns

Type	Description
DeployedIndex.Builder

clearDedicatedResources()

public DeployedIndex.Builder clearDedicatedResources()

Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types: n1-standard-16 n1-standard-32

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndex.Builder

clearDeployedIndexAuthConfig()

public DeployedIndex.Builder clearDeployedIndexAuthConfig()

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndex.Builder

clearDeploymentGroup()

public DeployedIndex.Builder clearDeploymentGroup()

Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating deployment_groups with reserved_ip_ranges is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').

string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

clearDisplayName()

public DeployedIndex.Builder clearDisplayName()

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

string display_name = 3;

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

clearEnableAccessLogging()

public DeployedIndex.Builder clearEnableAccessLogging()

Optional. If true, private endpoint's access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that Stackdriver logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.

bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DeployedIndex.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearId()

public DeployedIndex.Builder clearId()

Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

clearIndex()

public DeployedIndex.Builder clearIndex()

Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

clearIndexSyncTime()

public DeployedIndex.Builder clearIndexSyncTime()

Output only. The DeployedIndex may depend on various data on its original Index. Additionally when certain changes to the original Index are being done (e.g. when what the Index contains is being changed) the DeployedIndex may be asynchronously updated in the background to reflect this changes. If this timestamp's value is at least the Index.update_time of the original Index, it means that this DeployedIndex and the original Index are in sync. If this timestamp is older, then to see which updates this DeployedIndex already contains (and which not), one must list Operations working on the original Index. Only the successfully completed Operations with [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] equal or before this sync time are contained in this DeployedIndex.

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

Returns

Type	Description
DeployedIndex.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployedIndex.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPrivateEndpoints()

public DeployedIndex.Builder clearPrivateEndpoints()

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
DeployedIndex.Builder

clearReservedIpRanges()

public DeployedIndex.Builder clearReservedIpRanges()

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

clone()

public DeployedIndex.Builder clone()

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAutomaticResources()

public AutomaticResources getAutomaticResources()

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
AutomaticResources	The automaticResources.

getAutomaticResourcesBuilder()

public AutomaticResources.Builder getAutomaticResourcesBuilder()

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
AutomaticResources.Builder

getAutomaticResourcesOrBuilder()

public AutomaticResourcesOrBuilder getAutomaticResourcesOrBuilder()

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
AutomaticResourcesOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the DeployedIndex was created.

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

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the DeployedIndex was created.

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

Returns

Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the DeployedIndex was created.

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

Returns

Type	Description
TimestampOrBuilder

getDedicatedResources()

public DedicatedResources getDedicatedResources()

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DedicatedResources	The dedicatedResources.

getDedicatedResourcesBuilder()

public DedicatedResources.Builder getDedicatedResourcesBuilder()

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DedicatedResources.Builder

getDedicatedResourcesOrBuilder()

public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DedicatedResourcesOrBuilder

getDefaultInstanceForType()

public DeployedIndex getDefaultInstanceForType()

Returns

Type	Description
DeployedIndex

getDeployedIndexAuthConfig()

public DeployedIndexAuthConfig getDeployedIndexAuthConfig()

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndexAuthConfig	The deployedIndexAuthConfig.

getDeployedIndexAuthConfigBuilder()

public DeployedIndexAuthConfig.Builder getDeployedIndexAuthConfigBuilder()

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndexAuthConfig.Builder

getDeployedIndexAuthConfigOrBuilder()

public DeployedIndexAuthConfigOrBuilder getDeployedIndexAuthConfigOrBuilder()

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DeployedIndexAuthConfigOrBuilder

getDeploymentGroup()

public String getDeploymentGroup()

string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The deploymentGroup.

getDeploymentGroupBytes()

public ByteString getDeploymentGroupBytes()

string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for deploymentGroup.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

string display_name = 3;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

string display_name = 3;

Returns

Type	Description
ByteString	The bytes for displayName.

getEnableAccessLogging()

public boolean getEnableAccessLogging()

bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	The enableAccessLogging.

getId()

public String getId()

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The id.

getIdBytes()

public ByteString getIdBytes()

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for id.

getIndex()

public String getIndex()

Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The index.

getIndexBytes()

public ByteString getIndexBytes()

Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for index.

getIndexSyncTime()

public Timestamp getIndexSyncTime()

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

Returns

Type	Description
Timestamp	The indexSyncTime.

getIndexSyncTimeBuilder()

public Timestamp.Builder getIndexSyncTimeBuilder()

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

Returns

Type	Description
Builder

getIndexSyncTimeOrBuilder()

public TimestampOrBuilder getIndexSyncTimeOrBuilder()

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

Returns

Type	Description
TimestampOrBuilder

getPrivateEndpoints()

public IndexPrivateEndpoints getPrivateEndpoints()

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
IndexPrivateEndpoints	The privateEndpoints.

getPrivateEndpointsBuilder()

public IndexPrivateEndpoints.Builder getPrivateEndpointsBuilder()

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
IndexPrivateEndpoints.Builder

getPrivateEndpointsOrBuilder()

public IndexPrivateEndpointsOrBuilder getPrivateEndpointsOrBuilder()

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
IndexPrivateEndpointsOrBuilder

getReservedIpRanges(int index)

public String getReservedIpRanges(int index)

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The reservedIpRanges at the given index.

getReservedIpRangesBytes(int index)

public ByteString getReservedIpRangesBytes(int index)

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the reservedIpRanges at the given index.

getReservedIpRangesCount()

public int getReservedIpRangesCount()

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The count of reservedIpRanges.

getReservedIpRangesList()

public ProtocolStringList getReservedIpRangesList()

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ProtocolStringList	A list containing the reservedIpRanges.

hasAutomaticResources()

public boolean hasAutomaticResources()

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the automaticResources field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the DeployedIndex was created.

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

Returns

Type	Description
boolean	Whether the createTime field is set.

hasDedicatedResources()

public boolean hasDedicatedResources()

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the dedicatedResources field is set.

hasDeployedIndexAuthConfig()

public boolean hasDeployedIndexAuthConfig()

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the deployedIndexAuthConfig field is set.

hasIndexSyncTime()

public boolean hasIndexSyncTime()

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

Returns

Type	Description
boolean	Whether the indexSyncTime field is set.

hasPrivateEndpoints()

public boolean hasPrivateEndpoints()

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the privateEndpoints field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAutomaticResources(AutomaticResources value)

public DeployedIndex.Builder mergeAutomaticResources(AutomaticResources value)

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`AutomaticResources`

Returns

Type	Description
DeployedIndex.Builder

mergeCreateTime(Timestamp value)

public DeployedIndex.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the DeployedIndex was created.

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

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
DeployedIndex.Builder

mergeDedicatedResources(DedicatedResources value)

public DeployedIndex.Builder mergeDedicatedResources(DedicatedResources value)

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`DedicatedResources`

Returns

Type	Description
DeployedIndex.Builder

mergeDeployedIndexAuthConfig(DeployedIndexAuthConfig value)

public DeployedIndex.Builder mergeDeployedIndexAuthConfig(DeployedIndexAuthConfig value)

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`DeployedIndexAuthConfig`

Returns

Type	Description
DeployedIndex.Builder

mergeFrom(DeployedIndex other)

public DeployedIndex.Builder mergeFrom(DeployedIndex other)

Parameter

Name	Description
other	`DeployedIndex`

Returns

Type	Description
DeployedIndex.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeployedIndex.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
DeployedIndex.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public DeployedIndex.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
DeployedIndex.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeIndexSyncTime(Timestamp value)

public DeployedIndex.Builder mergeIndexSyncTime(Timestamp value)

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

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
DeployedIndex.Builder

mergePrivateEndpoints(IndexPrivateEndpoints value)

public DeployedIndex.Builder mergePrivateEndpoints(IndexPrivateEndpoints value)

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`IndexPrivateEndpoints`

Returns

Type	Description
DeployedIndex.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployedIndex.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAutomaticResources(AutomaticResources value)

public DeployedIndex.Builder setAutomaticResources(AutomaticResources value)

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`AutomaticResources`

Returns

Type	Description
DeployedIndex.Builder

setAutomaticResources(AutomaticResources.Builder builderForValue)

public DeployedIndex.Builder setAutomaticResources(AutomaticResources.Builder builderForValue)

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	`AutomaticResources.Builder`

Returns

Type	Description
DeployedIndex.Builder

setCreateTime(Timestamp value)

public DeployedIndex.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the DeployedIndex was created.

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

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
DeployedIndex.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DeployedIndex.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the DeployedIndex was created.

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

Parameter

Name	Description
builderForValue	`Builder`

Returns

Type	Description
DeployedIndex.Builder

setDedicatedResources(DedicatedResources value)

public DeployedIndex.Builder setDedicatedResources(DedicatedResources value)

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`DedicatedResources`

Returns

Type	Description
DeployedIndex.Builder

setDedicatedResources(DedicatedResources.Builder builderForValue)

public DeployedIndex.Builder setDedicatedResources(DedicatedResources.Builder builderForValue)

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	`DedicatedResources.Builder`

Returns

Type	Description
DeployedIndex.Builder

setDeployedIndexAuthConfig(DeployedIndexAuthConfig value)

public DeployedIndex.Builder setDeployedIndexAuthConfig(DeployedIndexAuthConfig value)

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`DeployedIndexAuthConfig`

Returns

Type	Description
DeployedIndex.Builder

setDeployedIndexAuthConfig(DeployedIndexAuthConfig.Builder builderForValue)

public DeployedIndex.Builder setDeployedIndexAuthConfig(DeployedIndexAuthConfig.Builder builderForValue)

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	`DeployedIndexAuthConfig.Builder`

Returns

Type	Description
DeployedIndex.Builder

setDeploymentGroup(String value)

public DeployedIndex.Builder setDeploymentGroup(String value)

string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`String` The deploymentGroup to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setDeploymentGroupBytes(ByteString value)

public DeployedIndex.Builder setDeploymentGroupBytes(ByteString value)

string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`ByteString` The bytes for deploymentGroup to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setDisplayName(String value)

public DeployedIndex.Builder setDisplayName(String value)

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

string display_name = 3;

Parameter

Name	Description
value	`String` The displayName to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public DeployedIndex.Builder setDisplayNameBytes(ByteString value)

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

string display_name = 3;

Parameter

Name	Description
value	`ByteString` The bytes for displayName to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setEnableAccessLogging(boolean value)

public DeployedIndex.Builder setEnableAccessLogging(boolean value)

bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`boolean` The enableAccessLogging to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DeployedIndex.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setId(String value)

public DeployedIndex.Builder setId(String value)

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`String` The id to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setIdBytes(ByteString value)

public DeployedIndex.Builder setIdBytes(ByteString value)

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`ByteString` The bytes for id to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setIndex(String value)

public DeployedIndex.Builder setIndex(String value)

Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`String` The index to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setIndexBytes(ByteString value)

public DeployedIndex.Builder setIndexBytes(ByteString value)

Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`ByteString` The bytes for index to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setIndexSyncTime(Timestamp value)

public DeployedIndex.Builder setIndexSyncTime(Timestamp value)

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

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
DeployedIndex.Builder

setIndexSyncTime(Timestamp.Builder builderForValue)

public DeployedIndex.Builder setIndexSyncTime(Timestamp.Builder builderForValue)

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

Parameter

Name	Description
builderForValue	`Builder`

Returns

Type	Description
DeployedIndex.Builder

setPrivateEndpoints(IndexPrivateEndpoints value)

public DeployedIndex.Builder setPrivateEndpoints(IndexPrivateEndpoints value)

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`IndexPrivateEndpoints`

Returns

Type	Description
DeployedIndex.Builder

setPrivateEndpoints(IndexPrivateEndpoints.Builder builderForValue)

public DeployedIndex.Builder setPrivateEndpoints(IndexPrivateEndpoints.Builder builderForValue)

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

.google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	`IndexPrivateEndpoints.Builder`

Returns

Type	Description
DeployedIndex.Builder

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReservedIpRanges(int index, String value)

public DeployedIndex.Builder setReservedIpRanges(int index, String value)

repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The reservedIpRanges to set.

Returns

Type	Description
DeployedIndex.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployedIndex.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
DeployedIndex.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)