public final class UpdateCollectionRequest extends GeneratedMessageV3 implements UpdateCollectionRequestOrBuilder
Message for updating a Collection
Protobuf type google.cloud.vectorsearch.v1beta.UpdateCollectionRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COLLECTION_FIELD_NUMBER
public static final int COLLECTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static UpdateCollectionRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static UpdateCollectionRequest.Builder newBuilder()
newBuilder(UpdateCollectionRequest prototype)
public static UpdateCollectionRequest.Builder newBuilder(UpdateCollectionRequest prototype)
public static UpdateCollectionRequest parseDelimitedFrom(InputStream input)
public static UpdateCollectionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static UpdateCollectionRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static UpdateCollectionRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(CodedInputStream input)
public static UpdateCollectionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(InputStream input)
public static UpdateCollectionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static UpdateCollectionRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<UpdateCollectionRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCollection()
public Collection getCollection()
Required. The resource being updated
.google.cloud.vectorsearch.v1beta.Collection collection = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Collection |
The collection.
|
getCollectionOrBuilder()
public CollectionOrBuilder getCollectionOrBuilder()
Required. The resource being updated
.google.cloud.vectorsearch.v1beta.Collection collection = 2 [(.google.api.field_behavior) = REQUIRED];
getDefaultInstanceForType()
public UpdateCollectionRequest getDefaultInstanceForType()
getParserForType()
public Parser<UpdateCollectionRequest> getParserForType()
Overrides
getRequestId()
public 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 |
String |
The requestId.
|
getRequestIdBytes()
public 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 |
ByteString |
The bytes for requestId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUpdateMask()
public 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
modified or deleted.
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 |
FieldMask |
The updateMask.
|
getUpdateMaskOrBuilder()
public 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
modified or deleted.
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];
hasCollection()
public boolean hasCollection()
Required. The resource being updated
.google.cloud.vectorsearch.v1beta.Collection collection = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the collection field is set.
|
hasUpdateMask()
public 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
modified or deleted.
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 |
boolean |
Whether the updateMask field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public UpdateCollectionRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateCollectionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public UpdateCollectionRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
