# Interface UpdateCollectionRequestOrBuilder (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 UpdateCollectionRequestOrBuilder extends MessageOrBuilder

## Implements

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

## Methods

### getCollection()

    public abstract Collection getCollection()

Required. The resource being updated

`
.google.cloud.vectorsearch.v1beta.Collection collection = 2 [(.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.Collection` | The collection. |

### getCollectionOrBuilder()

    public abstract CollectionOrBuilder getCollectionOrBuilder()

Required. The resource being updated

`
.google.cloud.vectorsearch.v1beta.Collection collection = 2 [(.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.CollectionOrBuilder` |   |

### 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. Field mask is used to specify the fields to be overwritten in the
Collection 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 will be
overwritten.

The following fields support update: `display_name`, `description`,
`labels`, `data_schema`, `vector_schema`.
For `data_schema` and `vector_schema`, fields can only be added, not
deleted, but `vertex_embedding_config` in `vector_schema` can be added or
removed.
Partial updates for `data_schema` and `vector_schema` are also supported
by using sub-field paths in `update_mask`, e.g.
`data_schema.properties.foo` or `vector_schema.my_vector_field`.

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

`.google.protobuf.FieldMask update_mask = 1 [(.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. Field mask is used to specify the fields to be overwritten in the
Collection 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 will be
overwritten.

The following fields support update: `display_name`, `description`,
`labels`, `data_schema`, `vector_schema`.
For `data_schema` and `vector_schema`, fields can only be added, not
deleted, but `vertex_embedding_config` in `vector_schema` can be added or
removed.
Partial updates for `data_schema` and `vector_schema` are also supported
by using sub-field paths in `update_mask`, e.g.
`data_schema.properties.foo` or `vector_schema.my_vector_field`.

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

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

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

### hasCollection()

    public abstract boolean hasCollection()

Required. The resource being updated

`
.google.cloud.vectorsearch.v1beta.Collection collection = 2 [(.google.api.field_behavior) = REQUIRED];
`

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

### hasUpdateMask()

    public abstract boolean hasUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the
Collection 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 will be
overwritten.

The following fields support update: `display_name`, `description`,
`labels`, `data_schema`, `vector_schema`.
For `data_schema` and `vector_schema`, fields can only be added, not
deleted, but `vertex_embedding_config` in `vector_schema` can be added or
removed.
Partial updates for `data_schema` and `vector_schema` are also supported
by using sub-field paths in `update_mask`, e.g.
`data_schema.properties.foo` or `vector_schema.my_vector_field`.

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

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

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