public final class DeployedIndex extends GeneratedMessageV3 implements DeployedIndexOrBuilder
A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
Protobuf type google.cloud.aiplatform.v1beta1.DeployedIndex
Static Fields
public static final int AUTOMATIC_RESOURCES_FIELD_NUMBER
Field Value
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DEDICATED_RESOURCES_FIELD_NUMBER
Field Value
public static final int DEPLOYED_INDEX_AUTH_CONFIG_FIELD_NUMBER
Field Value
public static final int DEPLOYMENT_GROUP_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int ENABLE_ACCESS_LOGGING_FIELD_NUMBER
Field Value
public static final int ID_FIELD_NUMBER
Field Value
public static final int INDEX_FIELD_NUMBER
Field Value
public static final int INDEX_SYNC_TIME_FIELD_NUMBER
Field Value
public static final int PRIVATE_ENDPOINTS_FIELD_NUMBER
Field Value
public static final int RESERVED_IP_RANGES_FIELD_NUMBER
Field Value
Static Methods
public static DeployedIndex getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static DeployedIndex.Builder newBuilder()
Returns
public static DeployedIndex.Builder newBuilder(DeployedIndex prototype)
Parameter
Returns
public static DeployedIndex parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DeployedIndex parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeployedIndex parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static DeployedIndex parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeployedIndex parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static DeployedIndex parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeployedIndex parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DeployedIndex parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeployedIndex parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DeployedIndex parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeployedIndex parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static DeployedIndex parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<DeployedIndex> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
public Timestamp getCreateTime()
Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public 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:
n1-standard-16
n1-standard-32
.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
public 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:
n1-standard-16
n1-standard-32
.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
public DeployedIndex getDefaultInstanceForType()
Returns
public DeployedIndexAuthConfig getDeployedIndexAuthConfig()
Optional. If set, the authentication is enabled for the private endpoint.
.google.cloud.aiplatform.v1beta1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];
public DeployedIndexAuthConfigOrBuilder getDeployedIndexAuthConfigOrBuilder()
Optional. If set, the authentication is enabled for the private endpoint.
.google.cloud.aiplatform.v1beta1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];
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];
| Type | Description |
| String | The deploymentGroup.
|
public 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];
| Type | Description |
| ByteString | The bytes for deploymentGroup.
|
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;
| Type | Description |
| String | The displayName.
|
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;
| Type | Description |
| ByteString | The bytes for displayName.
|
public boolean getEnableAccessLogging()
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];
| Type | Description |
| boolean | The enableAccessLogging.
|
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];
public 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];
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) = { ... }
| Type | Description |
| String | The index.
|
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) = { ... }
public 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 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.v1beta1.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];
public 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 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.v1beta1.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];
public Parser<DeployedIndex> getParserForType()
Returns
Overrides
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.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 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];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The reservedIpRanges at the given index.
|
public 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 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];
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the reservedIpRanges at the given index.
|
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 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];
| Type | Description |
| int | The count of reservedIpRanges.
|
public 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 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];
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the automaticResources field is set.
|
public boolean hasCreateTime()
Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public 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:
n1-standard-16
n1-standard-32
.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the dedicatedResources field is set.
|
public boolean hasDeployedIndexAuthConfig()
Optional. If set, the authentication is enabled for the private endpoint.
.google.cloud.aiplatform.v1beta1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the deployedIndexAuthConfig field is set.
|
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 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.v1beta1.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];
| Type | Description |
| boolean | Whether the indexSyncTime field is set.
|
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.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the privateEndpoints field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public DeployedIndex.Builder newBuilderForType()
Returns
protected DeployedIndex.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public DeployedIndex.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
