- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class DeployedIndex.Builder extends GeneratedMessageV3.Builder<DeployedIndex.Builder> implements DeployedIndexOrBuilderA deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
Protobuf type google.cloud.aiplatform.v1beta1.DeployedIndex
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DeployedIndex.BuilderImplements
DeployedIndexOrBuilderMethods
addAllReservedIpRanges(Iterable<String> values)
public DeployedIndex.Builder addAllReservedIpRanges(Iterable<String> values)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 |
| values | Iterable<String>The reservedIpRanges to add. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DeployedIndex.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| DeployedIndex.Builder |
addReservedIpRanges(String value)
public DeployedIndex.Builder addReservedIpRanges(String value)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 |
| value | StringThe reservedIpRanges to add. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
addReservedIpRangesBytes(ByteString value)
public DeployedIndex.Builder addReservedIpRangesBytes(ByteString value)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 |
| value | ByteStringThe bytes of the reservedIpRanges to add. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
build()
public DeployedIndex build()| Type | Description |
| DeployedIndex |
buildPartial()
public DeployedIndex buildPartial()| Type | Description |
| DeployedIndex |
clear()
public DeployedIndex.Builder clear()| Type | Description |
| DeployedIndex.Builder |
clearAutomaticResources()
public DeployedIndex.Builder clearAutomaticResources()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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| DeployedIndex.Builder |
clearCreateTime()
public DeployedIndex.Builder clearCreateTime()Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| DeployedIndex.Builder |
clearDeployedIndexAuthConfig()
public DeployedIndex.Builder clearDeployedIndexAuthConfig()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 |
| DeployedIndex.Builder |
clearDeploymentGroup()
public DeployedIndex.Builder clearDeploymentGroup() 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 |
| DeployedIndex.Builder | This builder for chaining. |
clearDisplayName()
public DeployedIndex.Builder clearDisplayName()The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
string display_name = 3;
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
clearEnableAccessLogging()
public DeployedIndex.Builder clearEnableAccessLogging()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 |
| DeployedIndex.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public DeployedIndex.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| DeployedIndex.Builder |
clearId()
public DeployedIndex.Builder clearId()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];
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
clearIndex()
public DeployedIndex.Builder clearIndex()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 |
| DeployedIndex.Builder | This builder for chaining. |
clearIndexSyncTime()
public DeployedIndex.Builder clearIndexSyncTime()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 |
| DeployedIndex.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public DeployedIndex.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| DeployedIndex.Builder |
clearPrivateEndpoints()
public DeployedIndex.Builder clearPrivateEndpoints()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 |
| DeployedIndex.Builder |
clearReservedIpRanges()
public DeployedIndex.Builder clearReservedIpRanges()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 |
| DeployedIndex.Builder | This builder for chaining. |
clone()
public DeployedIndex.Builder clone()| Type | Description |
| DeployedIndex.Builder |
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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| AutomaticResources | The automaticResources. |
getAutomaticResourcesBuilder()
public AutomaticResources.Builder getAutomaticResourcesBuilder()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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| AutomaticResources.Builder |
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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| AutomaticResourcesOrBuilder |
getCreateTime()
public Timestamp getCreateTime()Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| TimestampOrBuilder |
getDefaultInstanceForType()
public DeployedIndex getDefaultInstanceForType()| Type | Description |
| DeployedIndex |
getDeployedIndexAuthConfig()
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];
| Type | Description |
| DeployedIndexAuthConfig | The deployedIndexAuthConfig. |
getDeployedIndexAuthConfigBuilder()
public DeployedIndexAuthConfig.Builder getDeployedIndexAuthConfigBuilder()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 |
| DeployedIndexAuthConfig.Builder |
getDeployedIndexAuthConfigOrBuilder()
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];
| Type | Description |
| DeployedIndexAuthConfigOrBuilder |
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];
| Type | Description |
| String | The deploymentGroup. |
getDeploymentGroupBytes()
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. |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| Type | Description |
| String | The displayName. |
getDisplayNameBytes()
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. |
getEnableAccessLogging()
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. |
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];
| Type | Description |
| String | The id. |
getIdBytes()
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];
| Type | Description |
| ByteString | 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) = { ... }
| Type | Description |
| String | The index. |
getIndexBytes()
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) = { ... }
| Type | Description |
| ByteString | The bytes for index. |
getIndexSyncTime()
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];
| Type | Description |
| Timestamp | The indexSyncTime. |
getIndexSyncTimeBuilder()
public Timestamp.Builder getIndexSyncTimeBuilder()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 |
| Builder |
getIndexSyncTimeOrBuilder()
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];
| Type | Description |
| TimestampOrBuilder |
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 is configured.
.google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| IndexPrivateEndpoints | The privateEndpoints. |
getPrivateEndpointsBuilder()
public IndexPrivateEndpoints.Builder getPrivateEndpointsBuilder()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 |
| IndexPrivateEndpoints.Builder |
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 is configured.
.google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| IndexPrivateEndpointsOrBuilder |
getReservedIpRanges(int index)
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 | intThe index of the element to return. |
| Type | Description |
| String | The reservedIpRanges at the given index. |
getReservedIpRangesBytes(int 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 | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the reservedIpRanges at the given index. |
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 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. |
getReservedIpRangesList()
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];
| Type | Description |
| ProtocolStringList | A list containing the reservedIpRanges. |
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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the automaticResources field is set. |
hasCreateTime()
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. |
hasDeployedIndexAuthConfig()
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. |
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 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. |
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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeAutomaticResources(AutomaticResources value)
public DeployedIndex.Builder mergeAutomaticResources(AutomaticResources value)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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | AutomaticResources |
| Type | Description |
| DeployedIndex.Builder |
mergeCreateTime(Timestamp value)
public DeployedIndex.Builder mergeCreateTime(Timestamp value)Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| DeployedIndex.Builder |
mergeDeployedIndexAuthConfig(DeployedIndexAuthConfig value)
public DeployedIndex.Builder mergeDeployedIndexAuthConfig(DeployedIndexAuthConfig value)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];
| Name | Description |
| value | DeployedIndexAuthConfig |
| Type | Description |
| DeployedIndex.Builder |
mergeFrom(DeployedIndex other)
public DeployedIndex.Builder mergeFrom(DeployedIndex other)| Name | Description |
| other | DeployedIndex |
| Type | Description |
| DeployedIndex.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DeployedIndex.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| DeployedIndex.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public DeployedIndex.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| DeployedIndex.Builder |
mergeIndexSyncTime(Timestamp value)
public DeployedIndex.Builder mergeIndexSyncTime(Timestamp value)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];
| Name | Description |
| value | Timestamp |
| Type | Description |
| DeployedIndex.Builder |
mergePrivateEndpoints(IndexPrivateEndpoints value)
public DeployedIndex.Builder mergePrivateEndpoints(IndexPrivateEndpoints value)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];
| Name | Description |
| value | IndexPrivateEndpoints |
| Type | Description |
| DeployedIndex.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DeployedIndex.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| DeployedIndex.Builder |
setAutomaticResources(AutomaticResources value)
public DeployedIndex.Builder setAutomaticResources(AutomaticResources value)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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | AutomaticResources |
| Type | Description |
| DeployedIndex.Builder |
setAutomaticResources(AutomaticResources.Builder builderForValue)
public DeployedIndex.Builder setAutomaticResources(AutomaticResources.Builder builderForValue)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 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.
.google.cloud.aiplatform.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| builderForValue | AutomaticResources.Builder |
| Type | Description |
| DeployedIndex.Builder |
setCreateTime(Timestamp value)
public DeployedIndex.Builder setCreateTime(Timestamp value)Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| DeployedIndex.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public DeployedIndex.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp when the DeployedIndex was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| DeployedIndex.Builder |
setDeployedIndexAuthConfig(DeployedIndexAuthConfig value)
public DeployedIndex.Builder setDeployedIndexAuthConfig(DeployedIndexAuthConfig value)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];
| Name | Description |
| value | DeployedIndexAuthConfig |
| Type | Description |
| DeployedIndex.Builder |
setDeployedIndexAuthConfig(DeployedIndexAuthConfig.Builder builderForValue)
public DeployedIndex.Builder setDeployedIndexAuthConfig(DeployedIndexAuthConfig.Builder builderForValue)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];
| Name | Description |
| builderForValue | DeployedIndexAuthConfig.Builder |
| Type | Description |
| DeployedIndex.Builder |
setDeploymentGroup(String value)
public DeployedIndex.Builder setDeploymentGroup(String value) 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];
| Name | Description |
| value | StringThe deploymentGroup to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setDeploymentGroupBytes(ByteString value)
public DeployedIndex.Builder setDeploymentGroupBytes(ByteString value) 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];
| Name | Description |
| value | ByteStringThe bytes for deploymentGroup to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setDisplayName(String value)
public DeployedIndex.Builder setDisplayName(String value)The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
string display_name = 3;
| Name | Description |
| value | StringThe displayName to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public DeployedIndex.Builder setDisplayNameBytes(ByteString value)The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
string display_name = 3;
| Name | Description |
| value | ByteStringThe bytes for displayName to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setEnableAccessLogging(boolean value)
public DeployedIndex.Builder setEnableAccessLogging(boolean value)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];
| Name | Description |
| value | booleanThe enableAccessLogging to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public DeployedIndex.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| DeployedIndex.Builder |
setId(String value)
public DeployedIndex.Builder setId(String value)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];
| Name | Description |
| value | StringThe id to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setIdBytes(ByteString value)
public DeployedIndex.Builder setIdBytes(ByteString value)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];
| Name | Description |
| value | ByteStringThe bytes for id to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setIndex(String value)
public DeployedIndex.Builder setIndex(String value)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) = { ... }
| Name | Description |
| value | StringThe index to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setIndexBytes(ByteString value)
public DeployedIndex.Builder setIndexBytes(ByteString value)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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for index to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setIndexSyncTime(Timestamp value)
public DeployedIndex.Builder setIndexSyncTime(Timestamp value)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];
| Name | Description |
| value | Timestamp |
| Type | Description |
| DeployedIndex.Builder |
setIndexSyncTime(Timestamp.Builder builderForValue)
public DeployedIndex.Builder setIndexSyncTime(Timestamp.Builder builderForValue)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];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| DeployedIndex.Builder |
setPrivateEndpoints(IndexPrivateEndpoints value)
public DeployedIndex.Builder setPrivateEndpoints(IndexPrivateEndpoints value)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];
| Name | Description |
| value | IndexPrivateEndpoints |
| Type | Description |
| DeployedIndex.Builder |
setPrivateEndpoints(IndexPrivateEndpoints.Builder builderForValue)
public DeployedIndex.Builder setPrivateEndpoints(IndexPrivateEndpoints.Builder builderForValue)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];
| Name | Description |
| builderForValue | IndexPrivateEndpoints.Builder |
| Type | Description |
| DeployedIndex.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DeployedIndex.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| DeployedIndex.Builder |
setReservedIpRanges(int index, String value)
public DeployedIndex.Builder setReservedIpRanges(int index, String value)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 | intThe index to set the value at. |
| value | StringThe reservedIpRanges to set. |
| Type | Description |
| DeployedIndex.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DeployedIndex.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| DeployedIndex.Builder |