com.google.cloud.aiplatform.v1

Class DeployedIndex

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.DeployedIndex

All Implemented Interfaces:

DeployedIndexOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DeployedIndex
extends com.google.protobuf.GeneratedMessageV3
implements DeployedIndexOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.DeployedIndex

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeployedIndex.Builder A deployment of an Index.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTOMATIC_RESOURCES_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	DEDICATED_RESOURCES_FIELD_NUMBER
static int	DEPLOYED_INDEX_AUTH_CONFIG_FIELD_NUMBER
static int	DEPLOYMENT_GROUP_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	ENABLE_ACCESS_LOGGING_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	INDEX_FIELD_NUMBER
static int	INDEX_SYNC_TIME_FIELD_NUMBER
static int	PRIVATE_ENDPOINTS_FIELD_NUMBER
static int	PSC_AUTOMATION_CONFIGS_FIELD_NUMBER
static int	RESERVED_IP_RANGES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AutomaticResources	getAutomaticResources() Optional.
AutomaticResourcesOrBuilder	getAutomaticResourcesOrBuilder() Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
DedicatedResources	getDedicatedResources() Optional.
DedicatedResourcesOrBuilder	getDedicatedResourcesOrBuilder() Optional.
static DeployedIndex	getDefaultInstance()
DeployedIndex	getDefaultInstanceForType()
DeployedIndexAuthConfig	getDeployedIndexAuthConfig() Optional.
DeployedIndexAuthConfigOrBuilder	getDeployedIndexAuthConfigOrBuilder() Optional.
String	getDeploymentGroup() Optional.
com.google.protobuf.ByteString	getDeploymentGroupBytes() Optional.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() The display name of the DeployedIndex.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name of the DeployedIndex.
boolean	getEnableAccessLogging() Optional.
String	getId() Required.
com.google.protobuf.ByteString	getIdBytes() Required.
String	getIndex() Required.
com.google.protobuf.ByteString	getIndexBytes() Required.
com.google.protobuf.Timestamp	getIndexSyncTime() Output only.
com.google.protobuf.TimestampOrBuilder	getIndexSyncTimeOrBuilder() Output only.
com.google.protobuf.Parser<DeployedIndex>	getParserForType()
IndexPrivateEndpoints	getPrivateEndpoints() Output only.
IndexPrivateEndpointsOrBuilder	getPrivateEndpointsOrBuilder() Output only.
PSCAutomationConfig	getPscAutomationConfigs(int index) Optional.
int	getPscAutomationConfigsCount() Optional.
List<PSCAutomationConfig>	getPscAutomationConfigsList() Optional.
PSCAutomationConfigOrBuilder	getPscAutomationConfigsOrBuilder(int index) Optional.
List<? extends PSCAutomationConfigOrBuilder>	getPscAutomationConfigsOrBuilderList() Optional.
String	getReservedIpRanges(int index) Optional.
com.google.protobuf.ByteString	getReservedIpRangesBytes(int index) Optional.
int	getReservedIpRangesCount() Optional.
com.google.protobuf.ProtocolStringList	getReservedIpRangesList() Optional.
int	getSerializedSize()
boolean	hasAutomaticResources() Optional.
boolean	hasCreateTime() Output only.
boolean	hasDedicatedResources() Optional.
boolean	hasDeployedIndexAuthConfig() Optional.
int	hashCode()
boolean	hasIndexSyncTime() Output only.
boolean	hasPrivateEndpoints() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DeployedIndex.Builder	newBuilder()
static DeployedIndex.Builder	newBuilder(DeployedIndex prototype)
DeployedIndex.Builder	newBuilderForType()
protected DeployedIndex.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DeployedIndex	parseDelimitedFrom(InputStream input)
static DeployedIndex	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployedIndex	parseFrom(byte[] data)
static DeployedIndex	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployedIndex	parseFrom(ByteBuffer data)
static DeployedIndex	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployedIndex	parseFrom(com.google.protobuf.ByteString data)
static DeployedIndex	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployedIndex	parseFrom(com.google.protobuf.CodedInputStream input)
static DeployedIndex	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployedIndex	parseFrom(InputStream input)
static DeployedIndex	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DeployedIndex>	parser()
DeployedIndex.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

PRIVATE_ENDPOINTS_FIELD_NUMBER

public static final int PRIVATE_ENDPOINTS_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_SYNC_TIME_FIELD_NUMBER

public static final int INDEX_SYNC_TIME_FIELD_NUMBER

See Also:

Constant Field Values

AUTOMATIC_RESOURCES_FIELD_NUMBER

public static final int AUTOMATIC_RESOURCES_FIELD_NUMBER

See Also:

Constant Field Values

DEDICATED_RESOURCES_FIELD_NUMBER

public static final int DEDICATED_RESOURCES_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_ACCESS_LOGGING_FIELD_NUMBER

public static final int ENABLE_ACCESS_LOGGING_FIELD_NUMBER

See Also:

Constant Field Values

DEPLOYED_INDEX_AUTH_CONFIG_FIELD_NUMBER

public static final int DEPLOYED_INDEX_AUTH_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

RESERVED_IP_RANGES_FIELD_NUMBER

public static final int RESERVED_IP_RANGES_FIELD_NUMBER

See Also:

Constant Field Values

DEPLOYMENT_GROUP_FIELD_NUMBER

public static final int DEPLOYMENT_GROUP_FIELD_NUMBER

See Also:

Constant Field Values

PSC_AUTOMATION_CONFIGS_FIELD_NUMBER

public static final int PSC_AUTOMATION_CONFIGS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getId

public String getId()

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

Specified by:

getId in interface DeployedIndexOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

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

Specified by:

getIdBytes in interface DeployedIndexOrBuilder

Returns:

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) = { ... }

Specified by:

getIndex in interface DeployedIndexOrBuilder

Returns:

The index.

getIndexBytes

public com.google.protobuf.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) = { ... }

Specified by:

getIndexBytes in interface DeployedIndexOrBuilder

Returns:

The bytes for index.

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;

Specified by:

getDisplayName in interface DeployedIndexOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 3;

Specified by:

getDisplayNameBytes in interface DeployedIndexOrBuilder

Returns:

The bytes for displayName.

hasCreateTime

public boolean hasCreateTime()

 Output only. Timestamp when the DeployedIndex was created.
 

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

Specified by:

hasCreateTime in interface DeployedIndexOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when the DeployedIndex was created.
 

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

Specified by:

getCreateTime in interface DeployedIndexOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when the DeployedIndex was created.
 

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

Specified by:

getCreateTimeOrBuilder in interface DeployedIndexOrBuilder

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][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured.
 

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

Specified by:

hasPrivateEndpoints in interface DeployedIndexOrBuilder

Returns:

Whether the privateEndpoints field is set.

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][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured.
 

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

Specified by:

getPrivateEndpoints in interface DeployedIndexOrBuilder

Returns:

The privateEndpoints.

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][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured.
 

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

Specified by:

getPrivateEndpointsOrBuilder in interface DeployedIndexOrBuilder

hasIndexSyncTime

public boolean hasIndexSyncTime()

 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 these changes.
 If this timestamp's value is at least the
 [Index.update_time][google.cloud.aiplatform.v1.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 it does not), one must
 [list][google.longrunning.Operations.ListOperations] the operations that
 are running on the original Index. Only the successfully completed
 Operations with
 [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];

Specified by:

hasIndexSyncTime in interface DeployedIndexOrBuilder

Returns:

Whether the indexSyncTime field is set.

getIndexSyncTime

public com.google.protobuf.Timestamp getIndexSyncTime()

 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 these changes.
 If this timestamp's value is at least the
 [Index.update_time][google.cloud.aiplatform.v1.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 it does not), one must
 [list][google.longrunning.Operations.ListOperations] the operations that
 are running on the original Index. Only the successfully completed
 Operations with
 [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];

Specified by:

getIndexSyncTime in interface DeployedIndexOrBuilder

Returns:

The indexSyncTime.

getIndexSyncTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getIndexSyncTimeOrBuilder()

 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 these changes.
 If this timestamp's value is at least the
 [Index.update_time][google.cloud.aiplatform.v1.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 it does not), one must
 [list][google.longrunning.Operations.ListOperations] the operations that
 are running on the original Index. Only the successfully completed
 Operations with
 [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];

Specified by:

getIndexSyncTimeOrBuilder in interface DeployedIndexOrBuilder

hasAutomaticResources

public boolean hasAutomaticResources()

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

Specified by:

hasAutomaticResources in interface DeployedIndexOrBuilder

Returns:

Whether the automaticResources field is set.

getAutomaticResources

public AutomaticResources getAutomaticResources()

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

Specified by:

getAutomaticResources in interface DeployedIndexOrBuilder

Returns:

The automaticResources.

getAutomaticResourcesOrBuilder

public AutomaticResourcesOrBuilder getAutomaticResourcesOrBuilder()

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

Specified by:

getAutomaticResourcesOrBuilder in interface DeployedIndexOrBuilder

hasDedicatedResources

public boolean hasDedicatedResources()

 Optional. A description of resources that are dedicated to the
 DeployedIndex, and that need a higher degree of manual configuration. The
 field min_replica_count must be set to a value strictly greater than 0, or
 else validation will fail. 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 for SMALL shard:
 e2-standard-2 and all machine types available for MEDIUM and LARGE shard.

 Available machine types for MEDIUM shard:
 e2-standard-16 and all machine types available for LARGE shard.

 Available machine types for LARGE shard:
 e2-highmem-16, n2d-standard-32.

 n1-standard-16 and n1-standard-32 are still available, but we recommend
 e2-standard-16 and e2-highmem-16 for cost efficiency.
 

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

Specified by:

hasDedicatedResources in interface DeployedIndexOrBuilder

Returns:

Whether the dedicatedResources field is set.

getDedicatedResources

public DedicatedResources getDedicatedResources()

 Optional. A description of resources that are dedicated to the
 DeployedIndex, and that need a higher degree of manual configuration. The
 field min_replica_count must be set to a value strictly greater than 0, or
 else validation will fail. 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 for SMALL shard:
 e2-standard-2 and all machine types available for MEDIUM and LARGE shard.

 Available machine types for MEDIUM shard:
 e2-standard-16 and all machine types available for LARGE shard.

 Available machine types for LARGE shard:
 e2-highmem-16, n2d-standard-32.

 n1-standard-16 and n1-standard-32 are still available, but we recommend
 e2-standard-16 and e2-highmem-16 for cost efficiency.
 

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

Specified by:

getDedicatedResources in interface DeployedIndexOrBuilder

Returns:

The dedicatedResources.

getDedicatedResourcesOrBuilder

public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

 Optional. A description of resources that are dedicated to the
 DeployedIndex, and that need a higher degree of manual configuration. The
 field min_replica_count must be set to a value strictly greater than 0, or
 else validation will fail. 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 for SMALL shard:
 e2-standard-2 and all machine types available for MEDIUM and LARGE shard.

 Available machine types for MEDIUM shard:
 e2-standard-16 and all machine types available for LARGE shard.

 Available machine types for LARGE shard:
 e2-highmem-16, n2d-standard-32.

 n1-standard-16 and n1-standard-32 are still available, but we recommend
 e2-standard-16 and e2-highmem-16 for cost efficiency.
 

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

Specified by:

getDedicatedResourcesOrBuilder in interface DeployedIndexOrBuilder

getEnableAccessLogging

public boolean getEnableAccessLogging()

 Optional. If true, private endpoint's access logs are sent to Cloud
 Logging.

 These logs are like standard server access logs, containing
 information like timestamp and latency for each MatchRequest.

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

Specified by:

getEnableAccessLogging in interface DeployedIndexOrBuilder

Returns:

The enableAccessLogging.

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

Specified by:

hasDeployedIndexAuthConfig in interface DeployedIndexOrBuilder

Returns:

Whether the deployedIndexAuthConfig field is set.

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

Specified by:

getDeployedIndexAuthConfig in interface DeployedIndexOrBuilder

Returns:

The deployedIndexAuthConfig.

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

Specified by:

getDeployedIndexAuthConfigOrBuilder in interface DeployedIndexOrBuilder

getReservedIpRangesList

public com.google.protobuf.ProtocolStringList getReservedIpRangesList()

 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 should be the name of the address
 (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
 Example: ['vertex-ai-ip-range'].

 For more information about subnets and network IP ranges, please see
 https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
 

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

Specified by:

getReservedIpRangesList in interface DeployedIndexOrBuilder

Returns:

A list containing the reservedIpRanges.

getReservedIpRangesCount

public int getReservedIpRangesCount()

 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 should be the name of the address
 (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
 Example: ['vertex-ai-ip-range'].

 For more information about subnets and network IP ranges, please see
 https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
 

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

Specified by:

getReservedIpRangesCount in interface DeployedIndexOrBuilder

Returns:

The count of reservedIpRanges.

getReservedIpRanges

public String getReservedIpRanges(int index)

 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 should be the name of the address
 (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
 Example: ['vertex-ai-ip-range'].

 For more information about subnets and network IP ranges, please see
 https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
 

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

Specified by:

getReservedIpRanges in interface DeployedIndexOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The reservedIpRanges at the given index.

getReservedIpRangesBytes

public com.google.protobuf.ByteString getReservedIpRangesBytes(int index)

 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 should be the name of the address
 (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
 Example: ['vertex-ai-ip-range'].

 For more information about subnets and network IP ranges, please see
 https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
 

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

Specified by:

getReservedIpRangesBytes in interface DeployedIndexOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the reservedIpRanges at the given index.

getDeploymentGroup

public String getDeploymentGroup()

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

Specified by:

getDeploymentGroup in interface DeployedIndexOrBuilder

Returns:

The deploymentGroup.

getDeploymentGroupBytes

public com.google.protobuf.ByteString getDeploymentGroupBytes()

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

Specified by:

getDeploymentGroupBytes in interface DeployedIndexOrBuilder

Returns:

The bytes for deploymentGroup.

getPscAutomationConfigsList

public List<PSCAutomationConfig> getPscAutomationConfigsList()

 Optional. If set for PSC deployed index, PSC connection will be
 automatically created after deployment is done and the endpoint information
 is populated in private_endpoints.psc_automated_endpoints.
 

repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPscAutomationConfigsList in interface DeployedIndexOrBuilder

getPscAutomationConfigsOrBuilderList

public List<? extends PSCAutomationConfigOrBuilder> getPscAutomationConfigsOrBuilderList()

 Optional. If set for PSC deployed index, PSC connection will be
 automatically created after deployment is done and the endpoint information
 is populated in private_endpoints.psc_automated_endpoints.
 

repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPscAutomationConfigsOrBuilderList in interface DeployedIndexOrBuilder

getPscAutomationConfigsCount

public int getPscAutomationConfigsCount()

 Optional. If set for PSC deployed index, PSC connection will be
 automatically created after deployment is done and the endpoint information
 is populated in private_endpoints.psc_automated_endpoints.
 

repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPscAutomationConfigsCount in interface DeployedIndexOrBuilder

getPscAutomationConfigs

public PSCAutomationConfig getPscAutomationConfigs(int index)

 Optional. If set for PSC deployed index, PSC connection will be
 automatically created after deployment is done and the endpoint information
 is populated in private_endpoints.psc_automated_endpoints.
 

repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPscAutomationConfigs in interface DeployedIndexOrBuilder

getPscAutomationConfigsOrBuilder

public PSCAutomationConfigOrBuilder getPscAutomationConfigsOrBuilder(int index)

 Optional. If set for PSC deployed index, PSC connection will be
 automatically created after deployment is done and the endpoint information
 is populated in private_endpoints.psc_automated_endpoints.
 

repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPscAutomationConfigsOrBuilder in interface DeployedIndexOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DeployedIndex parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployedIndex parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployedIndex parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployedIndex parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployedIndex parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployedIndex parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployedIndex parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static DeployedIndex parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static DeployedIndex parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static DeployedIndex parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static DeployedIndex parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static DeployedIndex parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public DeployedIndex.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DeployedIndex.Builder newBuilder()

newBuilder

public static DeployedIndex.Builder newBuilder(DeployedIndex prototype)

toBuilder

public DeployedIndex.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DeployedIndex.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DeployedIndex getDefaultInstance()

parser

public static com.google.protobuf.Parser<DeployedIndex> parser()

getParserForType

public com.google.protobuf.Parser<DeployedIndex> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DeployedIndex getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder