Class DeployedIndex.Builder (3.3.0)

public static final class DeployedIndex.Builder extends GeneratedMessageV3.Builder<DeployedIndex.Builder> implements DeployedIndexOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.DeployedIndex

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

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

Parameter
NameDescription
valuesIterable<String>

The reservedIpRanges to add.

Returns
TypeDescription
DeployedIndex.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployedIndex.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

Parameter
NameDescription
valueString

The reservedIpRanges to add.

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

Parameter
NameDescription
valueByteString

The bytes of the reservedIpRanges to add.

Returns
TypeDescription
DeployedIndex.Builder

This builder for chaining.

build()

public DeployedIndex build()
Returns
TypeDescription
DeployedIndex

buildPartial()

public DeployedIndex buildPartial()
Returns
TypeDescription
DeployedIndex

clear()

public DeployedIndex.Builder clear()
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

Returns
TypeDescription
DeployedIndex.Builder

clearDedicatedResources()

public DeployedIndex.Builder clearDedicatedResources()

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DeployedIndex.Builder

clearDeployedIndexAuthConfig()

public DeployedIndex.Builder clearDeployedIndexAuthConfig()

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

Returns
TypeDescription
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;

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

Returns
TypeDescription
DeployedIndex.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DeployedIndex.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

Returns
TypeDescription
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) = { ... }

Returns
TypeDescription
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.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
TypeDescription
DeployedIndex.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployedIndex.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
TypeDescription
DeployedIndex.Builder

This builder for chaining.

clone()

public DeployedIndex.Builder clone()
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

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

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

Returns
TypeDescription
TimestampOrBuilder

getDedicatedResources()

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DedicatedResources

The dedicatedResources.

getDedicatedResourcesBuilder()

public DedicatedResources.Builder getDedicatedResourcesBuilder()

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DedicatedResources.Builder

getDedicatedResourcesOrBuilder()

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DedicatedResourcesOrBuilder

getDefaultInstanceForType()

public DeployedIndex getDefaultInstanceForType()
Returns
TypeDescription
DeployedIndex

getDeployedIndexAuthConfig()

public 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
TypeDescription
DeployedIndexAuthConfig

The deployedIndexAuthConfig.

getDeployedIndexAuthConfigBuilder()

public DeployedIndexAuthConfig.Builder getDeployedIndexAuthConfigBuilder()

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
TypeDescription
DeployedIndexAuthConfig.Builder

getDeployedIndexAuthConfigOrBuilder()

public DeployedIndexAuthConfigOrBuilder getDeployedIndexAuthConfigOrBuilder()

Optional. If set, the authentication is enabled for the private endpoint.

.google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

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

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

Returns
TypeDescription
ByteString

The bytes for deploymentGroup.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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;

Returns
TypeDescription
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;

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

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

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

Returns
TypeDescription
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) = { ... }

Returns
TypeDescription
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) = { ... }

Returns
TypeDescription
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.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
TypeDescription
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.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
TypeDescription
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.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
TypeDescription
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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Parameter
NameDescription
indexint

The index of the element to return.

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

Parameter
NameDescription
indexint

The index of the value to return.

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

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

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDedicatedResources()

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the dedicatedResources field is set.

hasDeployedIndexAuthConfig()

public 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
TypeDescription
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.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
TypeDescription
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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the privateEndpoints field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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

Parameter
NameDescription
valueAutomaticResources
Returns
TypeDescription
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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DeployedIndex.Builder

mergeDedicatedResources(DedicatedResources value)

public DeployedIndex.Builder mergeDedicatedResources(DedicatedResources value)

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDedicatedResources
Returns
TypeDescription
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.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDeployedIndexAuthConfig
Returns
TypeDescription
DeployedIndex.Builder

mergeFrom(DeployedIndex other)

public DeployedIndex.Builder mergeFrom(DeployedIndex other)
Parameter
NameDescription
otherDeployedIndex
Returns
TypeDescription
DeployedIndex.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeployedIndex.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployedIndex.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DeployedIndex.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueIndexPrivateEndpoints
Returns
TypeDescription
DeployedIndex.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployedIndex.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

Parameter
NameDescription
valueAutomaticResources
Returns
TypeDescription
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 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];

Parameter
NameDescription
builderForValueAutomaticResources.Builder
Returns
TypeDescription
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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
DeployedIndex.Builder

setDedicatedResources(DedicatedResources value)

public DeployedIndex.Builder setDedicatedResources(DedicatedResources value)

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDedicatedResources
Returns
TypeDescription
DeployedIndex.Builder

setDedicatedResources(DedicatedResources.Builder builderForValue)

public DeployedIndex.Builder setDedicatedResources(DedicatedResources.Builder builderForValue)

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.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueDedicatedResources.Builder
Returns
TypeDescription
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.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDeployedIndexAuthConfig
Returns
TypeDescription
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.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueDeployedIndexAuthConfig.Builder
Returns
TypeDescription
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];

Parameter
NameDescription
valueString

The deploymentGroup to set.

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

Parameter
NameDescription
valueByteString

The bytes for deploymentGroup to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

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

Parameter
NameDescription
valueboolean

The enableAccessLogging to set.

Returns
TypeDescription
DeployedIndex.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DeployedIndex.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

Parameter
NameDescription
valueString

The id to set.

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

Parameter
NameDescription
valueByteString

The bytes for id to set.

Returns
TypeDescription
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) = { ... }

Parameter
NameDescription
valueString

The index to set.

Returns
TypeDescription
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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for index to set.

Returns
TypeDescription
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.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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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.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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueIndexPrivateEndpoints
Returns
TypeDescription
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.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueIndexPrivateEndpoints.Builder
Returns
TypeDescription
DeployedIndex.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeployedIndex.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DeployedIndex.Builder
Overrides

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

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The reservedIpRanges to set.

Returns
TypeDescription
DeployedIndex.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployedIndex.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeployedIndex.Builder
Overrides