io.delta.standalone

Class Operation

Object

io.delta.standalone.Operation

public final class Operation
extends Object

An operation that can be performed on a Delta table.

An operation is tracked as the first line in delta logs, and powers DESCRIBE HISTORY for Delta tables.

Operations must be constructed using one of the Operation.Name types below. As well, optional Operation.Metrics values are given below.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Operation.Metrics Some possible operation metrics and their suggested corresponding operation types.
static class	Operation.Name Supported operation types.

Constructor Summary

Constructors

Constructor and Description
Operation(Operation.Name name)
Operation(Operation.Name name, java.util.Map<String,String> parameters)
Operation(Operation.Name name, java.util.Map<String,String> parameters, java.util.Map<String,String> metrics)
Operation(Operation.Name name, java.util.Map<String,String> parameters, java.util.Map<String,String> metrics, java.util.Optional<String> userMetadata)

Method Summary

Modifier and Type	Method and Description
java.util.Map<String,String>	getMetrics()
Operation.Name	getName()
java.util.Map<String,String>	getParameters()
java.util.Optional<String>	getUserMetadata()

Methods inherited from class Object

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

Constructor Detail

Operation

public Operation(@Nonnull
                 Operation.Name name)

Parameters:

name - The Operation.Name of the operation.

Operation

public Operation(@Nonnull
                 Operation.Name name,
                 @Nullable
                 java.util.Map<String,String> parameters)

Parameters:

name - The Operation.Name of the operation.

parameters - Any relevant operation parameters, where values are JSON-encoded.

Operation

public Operation(@Nonnull
                 Operation.Name name,
                 @Nullable
                 java.util.Map<String,String> parameters,
                 @Nullable
                 java.util.Map<String,String> metrics)

Parameters:

name - The Operation.Name of the operation.

parameters - Any relevant operation parameters, where values are JSON-encoded.

metrics - Any relevant operation metrics. See Operation.Metrics for suggested keys.

Operation

public Operation(@Nonnull
                 Operation.Name name,
                 @Nullable
                 java.util.Map<String,String> parameters,
                 @Nullable
                 java.util.Map<String,String> metrics,
                 @Nonnull
                 java.util.Optional<String> userMetadata)

Parameters:

name - The Operation.Name of the operation.

parameters - Any relevant operation parameters, where values are JSON-encoded.

metrics - Any relevant operation metrics. See Operation.Metrics for suggested keys.

userMetadata - Optional additional user metadata.

Method Detail

getName

@Nonnull
public Operation.Name getName()

Returns:

operation name

getParameters

@Nullable
public java.util.Map<String,String> getParameters()

Returns:

operation parameters

getMetrics

@Nullable
public java.util.Map<String,String> getMetrics()

Returns:

operation metrics

getUserMetadata

@Nonnull
public java.util.Optional<String> getUserMetadata()

Returns:

user metadata for this operation