Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::DeployedIndex (v0.22.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::DeployedIndex.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#automatic_resources

def automatic_resources() -> ::Google::Cloud::AIPlatform::V1::AutomaticResources
Returns
  • (::Google::Cloud::AIPlatform::V1::AutomaticResources) — 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.

#automatic_resources=

def automatic_resources=(value) -> ::Google::Cloud::AIPlatform::V1::AutomaticResources
Parameter
  • value (::Google::Cloud::AIPlatform::V1::AutomaticResources) — 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.
Returns
  • (::Google::Cloud::AIPlatform::V1::AutomaticResources) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#dedicated_resources

def dedicated_resources() -> ::Google::Cloud::AIPlatform::V1::DedicatedResources
Returns
  • (::Google::Cloud::AIPlatform::V1::DedicatedResources) — 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.

#dedicated_resources=

def dedicated_resources=(value) -> ::Google::Cloud::AIPlatform::V1::DedicatedResources
Parameter
  • value (::Google::Cloud::AIPlatform::V1::DedicatedResources) — 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.

Returns
  • (::Google::Cloud::AIPlatform::V1::DedicatedResources) — 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.

#deployed_index_auth_config

def deployed_index_auth_config() -> ::Google::Cloud::AIPlatform::V1::DeployedIndexAuthConfig
Returns

#deployed_index_auth_config=

def deployed_index_auth_config=(value) -> ::Google::Cloud::AIPlatform::V1::DeployedIndexAuthConfig
Parameter
Returns

#deployment_group

def deployment_group() -> ::String
Returns
  • (::String) — 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').

#deployment_group=

def deployment_group=(value) -> ::String
Parameter
  • value (::String) — 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').

Returns
  • (::String) — 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').

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
Returns
  • (::String) — The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

#enable_access_logging

def enable_access_logging() -> ::Boolean
Returns
  • (::Boolean) — 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.

#enable_access_logging=

def enable_access_logging=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#id

def id() -> ::String
Returns
  • (::String) — 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.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#index

def index() -> ::String
Returns
  • (::String) — Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

#index=

def index=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.
Returns
  • (::String) — Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

#index_sync_time

def index_sync_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.ListOperations] [Operations][Operation] [working][Operation.name] 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.

#private_endpoints

def private_endpoints() -> ::Google::Cloud::AIPlatform::V1::IndexPrivateEndpoints
Returns

#reserved_ip_ranges

def reserved_ip_ranges() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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'.

#reserved_ip_ranges=

def reserved_ip_ranges=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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'.

Returns
  • (::Array<::String>) — 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'.