Package io.stargate.sdk.rest

Class TypeClient

java.lang.Object

io.stargate.sdk.rest.TypeClient

public class TypeClient
extends Object

Working with UDT.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
Function<ServiceHttp,String>	typeResource	/v2/keyspaces/{keyspace}/tables/{tableName}
Function<ServiceHttp,String>	typeSchemaResource	/v2/schemas/keyspaces/{keyspace}/tables/{tableName}

Constructor Summary

Constructors

Constructor	Description
TypeClient(LoadBalancedHttpClient stargateHttpClient, KeyspaceClient keyspaceClient, String typeName)	Full constructor.

Method Summary

Modifier and Type	Method	Description
void	create(CreateType tcr)	Create a type.
void	delete()	Delete a type
boolean	exist()	Check if the table exist.
Optional<TypeDefinition>	find()	Get metadata of the collection.
String	getTypeName()	Getter accessor for attribute 'tableName'.
void	update(UpdateType update)	updateOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

typeSchemaResource

public Function<ServiceHttp,String> typeSchemaResource

/v2/schemas/keyspaces/{keyspace}/tables/{tableName}

typeResource

public Function<ServiceHttp,String> typeResource

/v2/keyspaces/{keyspace}/tables/{tableName}

Constructor Details

TypeClient

public TypeClient(LoadBalancedHttpClient stargateHttpClient,
 KeyspaceClient keyspaceClient,
 String typeName)

Full constructor.

Parameters:

stargateHttpClient - stargateHttpClient

keyspaceClient - KeyspaceClient

typeName - String

Method Details

find

public Optional<TypeDefinition> find()

Get metadata of the collection. There is no dedicated resources we use the list and filter with what we need.

Returns:

metadata of the collection if its exist or empty

exist

public boolean exist()

Check if the table exist.

Returns:

boolean

create

public void create(CreateType tcr)

Create a type.

Parameters:

tcr - creation request

See Also:

• Reference Documentation

update

public void update(UpdateType update)

updateOptions

Parameters:

update - to TableOptions

See Also:

• Reference Documentation

delete

public void delete()

Delete a type

See Also:

• Reference Documentation

getTypeName

public String getTypeName()

Getter accessor for attribute 'tableName'.

Returns:

current value of 'tableName'