Interface CollectionOrBuilder (0.6.0) 

public interface CollectionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsVectorSchema(String key)

public abstract boolean containsVectorSchema(String key)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.

map<string, .google.cloud.vectorsearch.v1beta.VectorField> vector_schema = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataSchema()

public abstract Struct getDataSchema()

Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The dataSchema.

getDataSchemaOrBuilder()

public abstract StructOrBuilder getDataSchemaOrBuilder()

Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getDescription()

public abstract String getDescription()

Optional. User-specified description of the collection

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. User-specified description of the collection

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

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Optional. User-specified display name of the collection

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. User-specified display name of the collection

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

Returns
Type Description
ByteString

The bytes for displayName.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

Identifier. name of resource

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. name of resource

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

Returns
Type Description
ByteString

The bytes for name.

getSchema() (deprecated)

public abstract Struct getSchema()

Deprecated. google.cloud.vectorsearch.v1beta.Collection.schema is deprecated. See google/cloud/vectorsearch/v1beta/vectorsearch_service.proto;l=203

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The schema.

getSchemaOrBuilder() (deprecated)

public abstract StructOrBuilder getSchemaOrBuilder()

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVectorSchema() (deprecated)

public abstract Map<String,VectorField> getVectorSchema()

Use #getVectorSchemaMap() instead.

Returns
Type Description
Map<String,VectorField>

getVectorSchemaCount()

public abstract int getVectorSchemaCount()

Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.

map<string, .google.cloud.vectorsearch.v1beta.VectorField> vector_schema = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVectorSchemaMap()

public abstract Map<String,VectorField> getVectorSchemaMap()

Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.

map<string, .google.cloud.vectorsearch.v1beta.VectorField> vector_schema = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,VectorField>

getVectorSchemaOrDefault(String key, VectorField defaultValue)

public abstract VectorField getVectorSchemaOrDefault(String key, VectorField defaultValue)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.

map<string, .google.cloud.vectorsearch.v1beta.VectorField> vector_schema = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue VectorField
Returns
Type Description
VectorField

getVectorSchemaOrThrow(String key)

public abstract VectorField getVectorSchemaOrThrow(String key)

Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.

map<string, .google.cloud.vectorsearch.v1beta.VectorField> vector_schema = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
VectorField

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataSchema()

public abstract boolean hasDataSchema()

Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens.

.google.protobuf.Struct data_schema = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataSchema field is set.

hasSchema() (deprecated)

public abstract boolean hasSchema()

Deprecated. google.cloud.vectorsearch.v1beta.Collection.schema is deprecated. See google/cloud/vectorsearch/v1beta/vectorsearch_service.proto;l=203

Optional. Deprecated: JSON Schema for data. Please use data_schema instead.

.google.protobuf.Struct schema = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the schema field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.