public final class UpdateCollectionRequest extends GeneratedMessageV3 implements UpdateCollectionRequestOrBuilder
Request message for UpdateCollectionRequest.
Protobuf type google.cloud.visionai.v1.UpdateCollectionRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UpdateCollectionRequestImplements
UpdateCollectionRequestOrBuilderStatic Fields
COLLECTION_FIELD_NUMBER
public static final int COLLECTION_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()
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static UpdateCollectionRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest.Builder |
newBuilder(UpdateCollectionRequest prototype)
public static UpdateCollectionRequest.Builder newBuilder(UpdateCollectionRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype |
UpdateCollectionRequest |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest.Builder |
parseDelimitedFrom(InputStream input)
public static UpdateCollectionRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static UpdateCollectionRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static UpdateCollectionRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static UpdateCollectionRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static UpdateCollectionRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static UpdateCollectionRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateCollectionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<UpdateCollectionRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<UpdateCollectionRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getCollection()
public Collection getCollection()
Required. The collection to update.
The collection's name
field is used to identify the collection to be
updated. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
.google.cloud.visionai.v1.Collection collection = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Collection |
The collection. |
getCollectionOrBuilder()
public CollectionOrBuilder getCollectionOrBuilder()
Required. The collection to update.
The collection's name
field is used to identify the collection to be
updated. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
.google.cloud.visionai.v1.Collection collection = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
CollectionOrBuilder |
getDefaultInstanceForType()
public UpdateCollectionRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest |
getParserForType()
public Parser<UpdateCollectionRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<UpdateCollectionRequest> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUpdateMask()
public FieldMask getUpdateMask()
The list of fields to be updated.
- Unset
update_mask
or setupdate_mask
to be a single "*" only will update all updatable fields with the value provided incollection
. - To update
display_name
value to empty string, set it in thecollection
to empty string, and setupdate_mask
with "display_name". Same applies to other updatable string fields in thecollection
.
.google.protobuf.FieldMask update_mask = 2;
Returns | |
---|---|
Type | Description |
FieldMask |
The updateMask. |
getUpdateMaskOrBuilder()
public FieldMaskOrBuilder getUpdateMaskOrBuilder()
The list of fields to be updated.
- Unset
update_mask
or setupdate_mask
to be a single "*" only will update all updatable fields with the value provided incollection
. - To update
display_name
value to empty string, set it in thecollection
to empty string, and setupdate_mask
with "display_name". Same applies to other updatable string fields in thecollection
.
.google.protobuf.FieldMask update_mask = 2;
Returns | |
---|---|
Type | Description |
FieldMaskOrBuilder |
hasCollection()
public boolean hasCollection()
Required. The collection to update.
The collection's name
field is used to identify the collection to be
updated. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
.google.cloud.visionai.v1.Collection collection = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the collection field is set. |
hasUpdateMask()
public boolean hasUpdateMask()
The list of fields to be updated.
- Unset
update_mask
or setupdate_mask
to be a single "*" only will update all updatable fields with the value provided incollection
. - To update
display_name
value to empty string, set it in thecollection
to empty string, and setupdate_mask
with "display_name". Same applies to other updatable string fields in thecollection
.
.google.protobuf.FieldMask update_mask = 2;
Returns | |
---|---|
Type | Description |
boolean |
Whether the updateMask field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public UpdateCollectionRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateCollectionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public UpdateCollectionRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
UpdateCollectionRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |