Class CreateCollectionRequest (0.9.0)

public final class CreateCollectionRequest extends GeneratedMessageV3 implements CreateCollectionRequestOrBuilder

Request message for CreateCollection.

Protobuf type google.cloud.visionai.v1.CreateCollectionRequest

Static Fields

COLLECTION_FIELD_NUMBER

public static final int COLLECTION_FIELD_NUMBER
Field Value
Type Description
int

COLLECTION_ID_FIELD_NUMBER

public static final int COLLECTION_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateCollectionRequest getDefaultInstance()
Returns
Type Description
CreateCollectionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateCollectionRequest.Builder newBuilder()
Returns
Type Description
CreateCollectionRequest.Builder

newBuilder(CreateCollectionRequest prototype)

public static CreateCollectionRequest.Builder newBuilder(CreateCollectionRequest prototype)
Parameter
Name Description
prototype CreateCollectionRequest
Returns
Type Description
CreateCollectionRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateCollectionRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCollectionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateCollectionRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateCollectionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateCollectionRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateCollectionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateCollectionRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCollectionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateCollectionRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCollectionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateCollectionRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateCollectionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCollectionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateCollectionRequest> parser()
Returns
Type Description
Parser<CreateCollectionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCollection()

public Collection getCollection()

Required. The collection resource to be created.

.google.cloud.visionai.v1.Collection collection = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Collection

The collection.

getCollectionId()

public String getCollectionId()

Optional. The ID to use for the collection, which will become the final component of the resource name if user choose to specify. Otherwise, collection id will be generated by system.

This value should be up to 55 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

optional string collection_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The collectionId.

getCollectionIdBytes()

public ByteString getCollectionIdBytes()

Optional. The ID to use for the collection, which will become the final component of the resource name if user choose to specify. Otherwise, collection id will be generated by system.

This value should be up to 55 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

optional string collection_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for collectionId.

getCollectionOrBuilder()

public CollectionOrBuilder getCollectionOrBuilder()

Required. The collection resource to be created.

.google.cloud.visionai.v1.Collection collection = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CollectionOrBuilder

getDefaultInstanceForType()

public CreateCollectionRequest getDefaultInstanceForType()
Returns
Type Description
CreateCollectionRequest

getParent()

public String getParent()

Required. The parent resource where this collection will be created. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource where this collection will be created. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateCollectionRequest> getParserForType()
Returns
Type Description
Parser<CreateCollectionRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCollection()

public boolean hasCollection()

Required. The collection resource to be created.

.google.cloud.visionai.v1.Collection collection = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the collection field is set.

hasCollectionId()

public boolean hasCollectionId()

Optional. The ID to use for the collection, which will become the final component of the resource name if user choose to specify. Otherwise, collection id will be generated by system.

This value should be up to 55 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

optional string collection_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the collectionId field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateCollectionRequest.Builder newBuilderForType()
Returns
Type Description
CreateCollectionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateCollectionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateCollectionRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateCollectionRequest.Builder toBuilder()
Returns
Type Description
CreateCollectionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException