Package com.google.cloud.aiplatform.v1

Interface DeployedIndexOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DeployedIndex, DeployedIndex.Builder
    public interface DeployedIndexOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getId

        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:
        The id.

      • getIdBytes

        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];
        Returns:
        The bytes for id.

      • getIndex

        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:
        The index.

      • getIndexBytes

        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) = { ... }
        Returns:
        The bytes for index.

      • getDisplayName

        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:
        The displayName.

      • getDisplayNameBytes

        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;
        Returns:
        The bytes for displayName.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Timestamp when the DeployedIndex was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasPrivateEndpoints

        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];
        Returns:
        Whether the privateEndpoints field is set.

      • getPrivateEndpoints

        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];
        Returns:
        The privateEndpoints.

      • getPrivateEndpointsOrBuilder

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

      • hasIndexSyncTime

        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];
        Returns:
        Whether the indexSyncTime field is set.

      • getIndexSyncTime

        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];
        Returns:
        The indexSyncTime.

      • getIndexSyncTimeOrBuilder

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

      • hasAutomaticResources

        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];
        Returns:
        Whether the automaticResources field is set.

      • getAutomaticResources

        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:
        The automaticResources.

      • getAutomaticResourcesOrBuilder

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

      • hasDedicatedResources

        boolean hasDedicatedResources()
         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:
        Whether the dedicatedResources field is set.

      • getDedicatedResources

        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:
        The dedicatedResources.

      • getDedicatedResourcesOrBuilder

        DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()
         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];

      • getEnableAccessLogging

        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:
        The enableAccessLogging.

      • hasDeployedIndexAuthConfig

        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:
        Whether the deployedIndexAuthConfig field is set.

      • getDeployedIndexAuthConfig

        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:
        The deployedIndexAuthConfig.

      • getDeployedIndexAuthConfigOrBuilder

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

      • getReservedIpRangesList

        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'.
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the reservedIpRanges.

      • getReservedIpRangesCount

        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'.
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of reservedIpRanges.

      • getReservedIpRanges

        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'.
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The reservedIpRanges at the given index.

      • getReservedIpRangesBytes

        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'.
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the reservedIpRanges at the given index.

      • getDeploymentGroup

        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:
        The deploymentGroup.

      • getDeploymentGroupBytes

        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];
        Returns:
        The bytes for deploymentGroup.