Class DeployedIndex.Builder

  • All Implemented Interfaces:
    DeployedIndexOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    DeployedIndex

    public static final class DeployedIndex.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
    implements DeployedIndexOrBuilder
     A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
     
    Protobuf type google.cloud.aiplatform.v1beta1.DeployedIndex
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • clear

        public DeployedIndex.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • getDefaultInstanceForType

        public DeployedIndex getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public DeployedIndex build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public DeployedIndex buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public DeployedIndex.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • setField

        public DeployedIndex.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • clearField

        public DeployedIndex.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • clearOneof

        public DeployedIndex.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • setRepeatedField

        public DeployedIndex.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • addRepeatedField

        public DeployedIndex.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • mergeFrom

        public DeployedIndex.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployedIndex.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • mergeFrom

        public DeployedIndex.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployedIndex.Builder>
        Throws:
        IOException
      • 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];
        Specified by:
        getId in interface DeployedIndexOrBuilder
        Returns:
        The id.
      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Required. The user specified ID of the DeployedIndex.
         The ID can be up to 128 characters long and must start with a letter and
         only contain letters, numbers, and underscores.
         The ID must be unique within the project it is created in.
         
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getIdBytes in interface DeployedIndexOrBuilder
        Returns:
        The bytes for id.
      • setId

        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];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.
      • 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:
        This builder for chaining.
      • setIdBytes

        public DeployedIndex.Builder setIdBytes​(com.google.protobuf.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];
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.
      • 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) = { ... }
        Specified by:
        getIndex in interface DeployedIndexOrBuilder
        Returns:
        The index.
      • getIndexBytes

        public com.google.protobuf.ByteString getIndexBytes()
         Required. The name of the Index this is the deployment of.
         We may refer to this Index as the DeployedIndex's "original" Index.
         
        string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getIndexBytes in interface DeployedIndexOrBuilder
        Returns:
        The bytes for index.
      • setIndex

        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) = { ... }
        Parameters:
        value - The index to set.
        Returns:
        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:
        This builder for chaining.
      • setIndexBytes

        public DeployedIndex.Builder setIndexBytes​(com.google.protobuf.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) = { ... }
        Parameters:
        value - The bytes for index to set.
        Returns:
        This builder for chaining.
      • 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;
        Specified by:
        getDisplayName in interface DeployedIndexOrBuilder
        Returns:
        The displayName.
      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The display name of the DeployedIndex. If not provided upon creation,
         the Index's display_name is used.
         
        string display_name = 3;
        Specified by:
        getDisplayNameBytes in interface DeployedIndexOrBuilder
        Returns:
        The bytes for displayName.
      • setDisplayName

        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;
        Parameters:
        value - The displayName to set.
        Returns:
        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:
        This builder for chaining.
      • setDisplayNameBytes

        public DeployedIndex.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         The display name of the DeployedIndex. If not provided upon creation,
         the Index's display_name is used.
         
        string display_name = 3;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when the DeployedIndex was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface DeployedIndexOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when the DeployedIndex was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DeployedIndexOrBuilder
        Returns:
        The createTime.
      • setCreateTime

        public DeployedIndex.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when the DeployedIndex was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setCreateTime

        public DeployedIndex.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Timestamp when the DeployedIndex was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeCreateTime

        public DeployedIndex.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when the DeployedIndex was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • 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];
      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. Timestamp when the DeployedIndex was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when the DeployedIndex was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DeployedIndexOrBuilder
      • 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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasPrivateEndpoints in interface DeployedIndexOrBuilder
        Returns:
        Whether the privateEndpoints field is set.
      • 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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrivateEndpoints in interface DeployedIndexOrBuilder
        Returns:
        The privateEndpoints.
      • setPrivateEndpoints

        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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setPrivateEndpoints

        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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergePrivateEndpoints

        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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • 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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • 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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • 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][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
         configured.
         
        .google.cloud.aiplatform.v1beta1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrivateEndpointsOrBuilder in interface DeployedIndexOrBuilder
      • 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 these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
        Specified by:
        hasIndexSyncTime in interface DeployedIndexOrBuilder
        Returns:
        Whether the indexSyncTime field is set.
      • getIndexSyncTime

        public com.google.protobuf.Timestamp getIndexSyncTime()
         Output only. The DeployedIndex may depend on various data on its original
         Index. Additionally when certain changes to the original Index are being
         done (e.g. when what the Index contains is being changed) the DeployedIndex
         may be asynchronously updated in the background to reflect these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
        Specified by:
        getIndexSyncTime in interface DeployedIndexOrBuilder
        Returns:
        The indexSyncTime.
      • setIndexSyncTime

        public DeployedIndex.Builder setIndexSyncTime​(com.google.protobuf.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 these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
      • setIndexSyncTime

        public DeployedIndex.Builder setIndexSyncTime​(com.google.protobuf.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 these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
      • mergeIndexSyncTime

        public DeployedIndex.Builder mergeIndexSyncTime​(com.google.protobuf.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 these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
      • 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 these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
      • getIndexSyncTimeBuilder

        public com.google.protobuf.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 these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
      • getIndexSyncTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getIndexSyncTimeOrBuilder()
         Output only. The DeployedIndex may depend on various data on its original
         Index. Additionally when certain changes to the original Index are being
         done (e.g. when what the Index contains is being changed) the DeployedIndex
         may be asynchronously updated in the background to reflect these changes.
         If this timestamp's value is at least the
         [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
         the original Index, it means that this DeployedIndex and the original Index
         are in sync. If this timestamp is older, then to see which updates this
         DeployedIndex already contains (and which it does not), one must
         [list][google.longrunning.Operations.ListOperations] the operations that
         are running on the original Index. Only the successfully completed
         Operations with
         [update_time][google.cloud.aiplatform.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];
        Specified by:
        getIndexSyncTimeOrBuilder in interface DeployedIndexOrBuilder
      • 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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasAutomaticResources in interface DeployedIndexOrBuilder
        Returns:
        Whether the automaticResources field is set.
      • 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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAutomaticResources in interface DeployedIndexOrBuilder
        Returns:
        The automaticResources.
      • setAutomaticResources

        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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
      • setAutomaticResources

        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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
      • mergeAutomaticResources

        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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
      • 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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
      • 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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
      • 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.v1beta1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAutomaticResourcesOrBuilder in interface DeployedIndexOrBuilder
      • 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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasDedicatedResources in interface DeployedIndexOrBuilder
        Returns:
        Whether the dedicatedResources field is set.
      • 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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDedicatedResources in interface DeployedIndexOrBuilder
        Returns:
        The dedicatedResources.
      • setDedicatedResources

        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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
      • setDedicatedResources

        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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
      • mergeDedicatedResources

        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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
      • 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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
      • 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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
      • 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 for SMALL shard:
         e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
        
         Available machine types for MEDIUM shard:
         e2-standard-16 and all machine types available for LARGE shard.
        
         Available machine types for LARGE shard:
         e2-highmem-16, n2d-standard-32.
        
         n1-standard-16 and n1-standard-32 are still available, but we recommend
         e2-standard-16 and e2-highmem-16 for cost efficiency.
         
        .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDedicatedResourcesOrBuilder in interface DeployedIndexOrBuilder
      • getEnableAccessLogging

        public boolean getEnableAccessLogging()
         Optional. If true, private endpoint's access logs are sent to Cloud
         Logging.
        
         These logs are like standard server access logs, containing
         information like timestamp and latency for each MatchRequest.
        
         Note that logs may incur a cost, especially if the deployed
         index receives a high queries per second rate (QPS).
         Estimate your costs before enabling this option.
         
        bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableAccessLogging in interface DeployedIndexOrBuilder
        Returns:
        The enableAccessLogging.
      • setEnableAccessLogging

        public DeployedIndex.Builder setEnableAccessLogging​(boolean value)
         Optional. If true, private endpoint's access logs are sent to Cloud
         Logging.
        
         These logs are like standard server access logs, containing
         information like timestamp and latency for each MatchRequest.
        
         Note that logs may incur a cost, especially if the deployed
         index receives a high queries per second rate (QPS).
         Estimate your costs before enabling this option.
         
        bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The enableAccessLogging to set.
        Returns:
        This builder for chaining.
      • clearEnableAccessLogging

        public DeployedIndex.Builder clearEnableAccessLogging()
         Optional. If true, private endpoint's access logs are sent to Cloud
         Logging.
        
         These logs are like standard server access logs, containing
         information like timestamp and latency for each MatchRequest.
        
         Note that logs may incur a cost, especially if the deployed
         index receives a high queries per second rate (QPS).
         Estimate your costs before enabling this option.
         
        bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • 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];
        Specified by:
        hasDeployedIndexAuthConfig in interface DeployedIndexOrBuilder
        Returns:
        Whether the deployedIndexAuthConfig field is set.
      • 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];
        Specified by:
        getDeployedIndexAuthConfig in interface DeployedIndexOrBuilder
        Returns:
        The deployedIndexAuthConfig.
      • setDeployedIndexAuthConfig

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

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

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

        public com.google.protobuf.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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRangesList in interface DeployedIndexOrBuilder
        Returns:
        A list containing the reservedIpRanges.
      • 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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRangesCount in interface DeployedIndexOrBuilder
        Returns:
        The count of reservedIpRanges.
      • getReservedIpRanges

        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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRanges in interface DeployedIndexOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The reservedIpRanges at the given index.
      • getReservedIpRangesBytes

        public com.google.protobuf.ByteString getReservedIpRangesBytes​(int index)
         Optional. A list of reserved ip ranges under the VPC network that can be
         used for this DeployedIndex.
        
         If set, we will deploy the index within the provided ip ranges. Otherwise,
         the index might be deployed to any ip ranges under the provided VPC
         network.
        
         The value should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRangesBytes in interface DeployedIndexOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the reservedIpRanges at the given index.
      • setReservedIpRanges

        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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index to set the value at.
        value - The reservedIpRanges to set.
        Returns:
        This builder for chaining.
      • addReservedIpRanges

        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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The reservedIpRanges to add.
        Returns:
        This builder for chaining.
      • addAllReservedIpRanges

        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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        values - The reservedIpRanges to add.
        Returns:
        This builder for chaining.
      • 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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • addReservedIpRangesBytes

        public DeployedIndex.Builder addReservedIpRangesBytes​(com.google.protobuf.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 should be the name of the address
         (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
         Example: 'vertex-ai-ip-range'.
         
        repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes of the reservedIpRanges to add.
        Returns:
        This builder for chaining.
      • 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];
        Specified by:
        getDeploymentGroup in interface DeployedIndexOrBuilder
        Returns:
        The deploymentGroup.
      • getDeploymentGroupBytes

        public com.google.protobuf.ByteString getDeploymentGroupBytes()
         Optional. The deployment group can be no longer than 64 characters (eg:
         'test', 'prod'). If not set, we will use the 'default' deployment group.
        
         Creating `deployment_groups` with `reserved_ip_ranges` is a recommended
         practice when the peered network has multiple peering ranges. This creates
         your deployments from predictable IP spaces for easier traffic
         administration. Also, one deployment_group (except 'default') can only be
         used with the same reserved_ip_ranges which means if the deployment_group
         has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or
         [d, e] is disallowed.
        
         Note: we only support up to 5 deployment groups(not including 'default').
         
        string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDeploymentGroupBytes in interface DeployedIndexOrBuilder
        Returns:
        The bytes for deploymentGroup.
      • setDeploymentGroup

        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];
        Parameters:
        value - The deploymentGroup to set.
        Returns:
        This builder for chaining.
      • 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:
        This builder for chaining.
      • setDeploymentGroupBytes

        public DeployedIndex.Builder setDeploymentGroupBytes​(com.google.protobuf.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];
        Parameters:
        value - The bytes for deploymentGroup to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final DeployedIndex.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>
      • mergeUnknownFields

        public final DeployedIndex.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DeployedIndex.Builder>