Class Collection.Builder (0.5.0)

public static final class Collection.Builder extends GeneratedMessageV3.Builder<Collection.Builder> implements CollectionOrBuilder

A collection is a resource in a corpus. It serves as a container of references to original resources.

Protobuf type google.cloud.visionai.v1.Collection

Implements

CollectionOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Collection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Collection.Builder
Overrides

build()

public Collection build()
Returns
Type Description
Collection

buildPartial()

public Collection buildPartial()
Returns
Type Description
Collection

clear()

public Collection.Builder clear()
Returns
Type Description
Collection.Builder
Overrides

clearDescription()

public Collection.Builder clearDescription()

Optional. Description of the collection. Can be up to 25000 characters long.

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

Returns
Type Description
Collection.Builder

This builder for chaining.

clearDisplayName()

public Collection.Builder clearDisplayName()

Optional. The collection name for displaying. The name can be up to 256 characters long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Collection.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Collection.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Collection.Builder
Overrides

clearName()

public Collection.Builder clearName()

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Collection.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Collection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Collection.Builder
Overrides

clone()

public Collection.Builder clone()
Returns
Type Description
Collection.Builder
Overrides

getDefaultInstanceForType()

public Collection getDefaultInstanceForType()
Returns
Type Description
Collection

getDescription()

public String getDescription()

Optional. Description of the collection. Can be up to 25000 characters long.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the collection. Can be up to 25000 characters long.

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

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. The collection name for displaying. The name can be up to 256 characters long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The collection name for displaying. The name can be up to 256 characters long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Collection other)

public Collection.Builder mergeFrom(Collection other)
Parameter
Name Description
other Collection
Returns
Type Description
Collection.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Collection.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Collection.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Collection.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Collection.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Collection.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Collection.Builder
Overrides

setDescription(String value)

public Collection.Builder setDescription(String value)

Optional. Description of the collection. Can be up to 25000 characters long.

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Collection.Builder setDescriptionBytes(ByteString value)

Optional. Description of the collection. Can be up to 25000 characters long.

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setDisplayName(String value)

public Collection.Builder setDisplayName(String value)

Optional. The collection name for displaying. The name can be up to 256 characters long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Collection.Builder setDisplayNameBytes(ByteString value)

Optional. The collection name for displaying. The name can be up to 256 characters long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Collection.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Collection.Builder
Overrides

setName(String value)

public Collection.Builder setName(String value)

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Collection.Builder setNameBytes(ByteString value)

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Collection.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Collection.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Collection.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Collection.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Collection.Builder
Overrides