Interface DeployedIndexOrBuilder (3.31.0)

public interface DeployedIndexOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutomaticResources()

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

Returns
Type	Description
`AutomaticResources`	The automaticResources.

getAutomaticResourcesOrBuilder()

public abstract AutomaticResourcesOrBuilder getAutomaticResourcesOrBuilder()

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

Returns
Type	Description
`AutomaticResourcesOrBuilder`

getCreateTime()

public abstract 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.

getCreateTimeOrBuilder()

public abstract 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 abstract DedicatedResources getDedicatedResources()

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

Returns
Type	Description
`DedicatedResources`	The dedicatedResources.

getDedicatedResourcesOrBuilder()

public abstract DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

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

Returns
Type	Description
`DedicatedResourcesOrBuilder`

getDeployedIndexAuthConfig()

public abstract 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.

getDeployedIndexAuthConfigOrBuilder()

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

Returns
Type	Description
`String`	The deploymentGroup.

getDeploymentGroupBytes()

public abstract 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.

Note: we only support up to 5 deployment groups(not including 'default').

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

Returns
Type	Description
`ByteString`	The bytes for deploymentGroup.

getDisplayName()

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

Returns
Type	Description
`boolean`	The enableAccessLogging.

getId()

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

Returns
Type	Description
`String`	The id.

getIdBytes()

public abstract ByteString getIdBytes()

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

Returns
Type	Description
`ByteString`	The bytes for id.

getIndex()

public abstract 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 abstract 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 abstract 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 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 the operations that are running on the original Index. Only the successfully completed Operations with 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
`Timestamp`	The indexSyncTime.

getIndexSyncTimeOrBuilder()

public abstract TimestampOrBuilder getIndexSyncTimeOrBuilder()

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

Returns
Type	Description
`TimestampOrBuilder`

getPrivateEndpoints()

public abstract 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.

getPrivateEndpointsOrBuilder()

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

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

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

Returns
Type	Description
`int`	The count of reservedIpRanges.

getReservedIpRangesList()

public abstract List<String> 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];

Returns
Type	Description
`List<String>`	A list containing the reservedIpRanges.

hasAutomaticResources()

public abstract 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 abstract 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 abstract boolean hasDedicatedResources()

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

Returns
Type	Description
`boolean`	Whether the dedicatedResources field is set.

hasDeployedIndexAuthConfig()

public abstract 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 abstract 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 abstract 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.