FutureProgress (Oracle Graph Java API Reference for Property Graph Release 24.2 (F95689-01))

java.lang.Object
- oracle.pgx.api.FutureProgress

Direct Known Subclasses:

AlgorithmProgress, DefaultFutureProgress, GraphLoadingProgress
```
public abstract class FutureProgress
extends java.lang.Object
```
Represents the progress PgxFuture execution

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FutureProgress.FutureProgressType

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String TYPE_ID_PROPERTY

Constructor Summary

Constructors
Constructor Description

FutureProgress(FutureProgress.FutureProgressType futureProgressType, oracle.pgx.common.Progress progress)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Optional<AlgorithmProgress>`	`asAlgorithmExecutionProgress()`	In case of algorithm execution future, return AlgorithmProgress
`abstract java.util.Optional<GraphLoadingProgress>`	`asGraphLoadingProgress()`	In case of graph loading future, return stats about graph loading progress
`FutureProgress.FutureProgressType`	`getFutureProgressType()`
`oracle.pgx.common.Progress`	`getState()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_ID_PROPERTY
```
public static final java.lang.String TYPE_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FutureProgress
```
public FutureProgress(@Nonnull
                      FutureProgress.FutureProgressType futureProgressType,
                      @Nonnull
                      oracle.pgx.common.Progress progress)
```
- Method Detail
  - asGraphLoadingProgress
```
public abstract java.util.Optional<GraphLoadingProgress> asGraphLoadingProgress()
```
    In case of graph loading future, return stats about graph loading progress
    
    Returns:
    
    empty if the PgxFuture is not a graph loading future.
  - asAlgorithmExecutionProgress
```
public java.util.Optional<AlgorithmProgress> asAlgorithmExecutionProgress()
```
    In case of algorithm execution future, return AlgorithmProgress
    
    Returns:
    
    empty if the PgxFuture is not an algorithm execution future.
    
    Since:
    
    24.2
  - getFutureProgressType
```
@Nonnull
public final FutureProgress.FutureProgressType getFutureProgressType()
```
    Returns:
    
    the type of the future progress
  - getState
```
@Nonnull
public final oracle.pgx.common.Progress getState()
```
    Returns:
    
    The current state of the PgxFuture, whether it's pending, in progress, done, ...
    
    Since:
    
    23.4