tech.ydb.core

Class Status

java.lang.Object

tech.ydb.core.Status

All Implemented Interfaces:

Serializable

public final class Status
extends Object
implements Serializable

Author:

Sergey Polovko, Alexandr Gorshenin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Status	SUCCESS

Method Summary

Modifier and Type	Method and Description
static <T> Function<Status,CompletableFuture<Result<T>>>	bindValue(T value) Create functor to compose the successful status to completed future with specified value.
static Function<Status,CompletableFuture<Status>>	compose(Supplier<CompletableFuture<Status>> supplier) Create functor to compose the successful status to next completable future with another status.
static <T> Function<Status,CompletableFuture<Result<T>>>	composeResult(Supplier<CompletableFuture<Result<T>>> supplier) Create functor to compose the successful status to next completable future with result.
boolean	equals(Object o)
void	expectSuccess()
void	expectSuccess(String errorMsg)
Throwable	getCause()
StatusCode	getCode()
Double	getConsumedRu()
Issue[]	getIssues()
boolean	hasConsumedRu()
int	hashCode()
boolean	isSuccess()
static Status	of(StatusCode code)
static Status	of(StatusCode code, Double consumedRu, Issue... issues)
static Status	of(StatusCode code, Issue... issues)
static Status	of(StatusCode code, Throwable cause, Issue... issues)
String	toString()
Status	withCause(Throwable cause)
Status	withConsumedRu(Double newConsumedRu)
Status	withIssues(Issue... newIssues)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SUCCESS

public static final Status SUCCESS

Method Detail

compose

public static Function<Status,CompletableFuture<Status>> compose(Supplier<CompletableFuture<Status>> supplier)

Create functor to compose the successful status to next completable future with another status. Failed statuses will be passed as is.

This helper is designed to be used as CompletableFuture.thenCompose(java.util.function.Function) argument

Example of usage:

 
 // Create one table
 session.createTable(...)
    // Create second table if first was created successful
    .thenCompose(Status.compose(() -> session.createTable(...)));
 

Parameters:

supplier - generator for completable future with another status

Returns:

functor which composes successful status to completable future with another status

composeResult

public static <T> Function<Status,CompletableFuture<Result<T>>> composeResult(Supplier<CompletableFuture<Result<T>>> supplier)

Create functor to compose the successful status to next completable future with result. Failed statuses will be composed to failed results.

This helper is designed to be used as CompletableFuture.thenCompose(java.util.function.Function) argument

Example of usage:

 
 // Create one table
 session.createTable(...)
    // Execute query if table was created successful
    .thenCompose(Status.composeResult(() -> session.executeDataQuery(...)));
 

Type Parameters:

T - type of value in Result

Parameters:

supplier - generator for completable future with result

Returns:

functor which composes successful status to completable future with result

bindValue

public static <T> Function<Status,CompletableFuture<Result<T>>> bindValue(T value)

Create functor to compose the successful status to completed future with specified value. Failed statuses will be composed to failed results.

This helper is designed to be used as CompletableFuture.thenCompose(java.util.function.Function) argument

Example of usage:

 
 // Start new transaction
 session.beginTransaction(...)
    // Execute query in opened transaction
    .thenCompose(Result.compose(transaction -> session.executeDataQuery(...)
        // Commmit transaction
        .thenCompose(Result.compose(result -> transaction.commit()
            // And return result of query if commit was successful
            .thenCompose(Status.bindValue(result.getResultSet(0)))
        ))
    ));
 

Type Parameters:

T - type of value in Result

Parameters:

value - value to create completed future

Returns:

functor which composes successful status to completed future with specified value

of

public static Status of(StatusCode code,
                        Double consumedRu,
                        Issue... issues)

of

public static Status of(StatusCode code,
                        Issue... issues)

of

public static Status of(StatusCode code,
                        Throwable cause,
                        Issue... issues)

of

public static Status of(StatusCode code)

withIssues

public Status withIssues(Issue... newIssues)

withConsumedRu

public Status withConsumedRu(Double newConsumedRu)

withCause

public Status withCause(Throwable cause)

hasConsumedRu

public boolean hasConsumedRu()

getConsumedRu

public Double getConsumedRu()

getCode

public StatusCode getCode()

getCause

public Throwable getCause()

getIssues

public Issue[] getIssues()

isSuccess

public boolean isSuccess()

expectSuccess

public void expectSuccess(String errorMsg)
                   throws UnexpectedResultException

Throws:

UnexpectedResultException

expectSuccess

public void expectSuccess()
                   throws UnexpectedResultException

Throws:

UnexpectedResultException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object