# Interface UpdateIndexRequestOrBuilder (0.15.0)

0.15.0 (latest) 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

    public interface UpdateIndexRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getIndex()

    public abstract Index getIndex()

Required. The resource being updated.

`
.google.cloud.vectorsearch.v1beta.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.Index` | The index. |

### getIndexOrBuilder()

    public abstract IndexOrBuilder getIndexOrBuilder()

Required. The resource being updated.

`
.google.cloud.vectorsearch.v1beta.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.IndexOrBuilder` |   |

### getRequestId()

    public abstract String getRequestId()

Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).

`
string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The requestId. |

### getRequestIdBytes()

    public abstract ByteString getRequestIdBytes()

Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).

`
string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for requestId. |

### getUpdateMask()

    public abstract FieldMask getUpdateMask()

Optional. Specifies the fields to be overwritten in the Index resource by
the update. The fields specified in the update_mask are relative to the
resource, not the full request. A field will be overwritten if it is in the
mask. If the user does not provide a mask then all fields present in the
request with non-empty values will be overwritten.

The following fields support update:

- `display_name`
- `description`
- `labels`
- `dedicated_infrastructure.autoscaling_spec.min_replica_count`
- `dedicated_infrastructure.autoscaling_spec.max_replica_count`

  If `*` is provided in the `update_mask`, full replacement of mutable fields
  will be performed.

`.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask.html` | The updateMask. |

### getUpdateMaskOrBuilder()

    public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Specifies the fields to be overwritten in the Index resource by
the update. The fields specified in the update_mask are relative to the
resource, not the full request. A field will be overwritten if it is in the
mask. If the user does not provide a mask then all fields present in the
request with non-empty values will be overwritten.

The following fields support update:

- `display_name`
- `description`
- `labels`
- `dedicated_infrastructure.autoscaling_spec.min_replica_count`
- `dedicated_infrastructure.autoscaling_spec.max_replica_count`

  If `*` is provided in the `update_mask`, full replacement of mutable fields
  will be performed.

`.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMaskOrBuilder.html` |   |

### hasIndex()

    public abstract boolean hasIndex()

Required. The resource being updated.

`
.google.cloud.vectorsearch.v1beta.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the index field is set. |

### hasUpdateMask()

    public abstract boolean hasUpdateMask()

Optional. Specifies the fields to be overwritten in the Index resource by
the update. The fields specified in the update_mask are relative to the
resource, not the full request. A field will be overwritten if it is in the
mask. If the user does not provide a mask then all fields present in the
request with non-empty values will be overwritten.

The following fields support update:

- `display_name`
- `description`
- `labels`
- `dedicated_infrastructure.autoscaling_spec.min_replica_count`
- `dedicated_infrastructure.autoscaling_spec.max_replica_count`

  If `*` is provided in the `update_mask`, full replacement of mutable fields
  will be performed.

`.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the updateMask field is set. |