com.datastax.bdp.graph.api.model

Interface PropertyKey.Builder

Enclosing interface:

PropertyKey

public static interface PropertyKey.Builder

Builder interface for properties.

Method Summary

Modifier and Type	Method and Description
PropertyKey	add() Create and add the property type to the schema.
PropertyKey.Builder	addPropertyKeys(java.lang.String... propertyKeys) Add property keys to the vertex label
PropertyKey.Builder	bounds(double minX, double minY, double maxX, double maxY) Applies to Point type only.
PropertyKey.Builder	cardinality(Cardinality cardinality) Sets the cardinality for this property key.
PropertyKey.Builder	geoBounds() Applies to Point type only.
PropertyKey.Builder	ifNotExists()
default PropertyKey.Builder	multiple() Sets the cardinality for this property key to multiple (which is the default).
default PropertyKey.Builder	single() Sets the cardinality for this property key to single.
PropertyKey.Builder	ttl(java.time.Duration ttl)

Method Detail

cardinality

PropertyKey.Builder cardinality(Cardinality cardinality)

Sets the cardinality for this property key. If the cardinality is set to Cardinality.Single then only a single value may be associated with this key. If the cardinality is Cardinality.Multiple then multiple values can be associated. The default cardinality is Cardinality.Multiple.

Parameters:

cardinality - The cardinality of this property key.

Returns:

This builder.

single

default PropertyKey.Builder single()

Sets the cardinality for this property key to single.

Returns:

This builder

See Also:

cardinality(Cardinality)

multiple

default PropertyKey.Builder multiple()

Sets the cardinality for this property key to multiple (which is the default).

Returns:

This builder

See Also:

cardinality(Cardinality)

ttl

PropertyKey.Builder ttl(java.time.Duration ttl)

Parameters:

ttl - The time to live for the property key. Once expired the edge will be automatically removed.

Returns:

the builder.

ifNotExists

PropertyKey.Builder ifNotExists()

Returns:

if the property key already exists then just return it.

add

PropertyKey add()

Create and add the property type to the schema.

Returns:

the added property type.

addPropertyKeys

PropertyKey.Builder addPropertyKeys(java.lang.String... propertyKeys)

Add property keys to the vertex label

Parameters:

propertyKeys - The property key.

bounds

PropertyKey.Builder bounds(double minX,
                           double minY,
                           double maxX,
                           double maxY)

Applies to Point type only. Sets the parameters for range checking data.

Parameters:

minX - The minimum X value

minY - The minimum Y value

maxX - The max X value

maxY - The max Y value

geoBounds

PropertyKey.Builder geoBounds()

Applies to Point type only. Restricts values to geoBounds range.