Package org.projectnessie.gc.base

Class ImmutableGCParams

java.lang.Object

org.projectnessie.gc.base.ImmutableGCParams

All Implemented Interfaces:

Serializable, GCParams

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableGCParams
extends Object
implements GCParams

Immutable implementation of GCParams.

Use the builder to create immutable instances: ImmutableGCParams.builder().

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableGCParams.Builder	Builds instances of type ImmutableGCParams.

Method Summary

Modifier and Type	Method	Description
static ImmutableGCParams.Builder	builder()	Creates a builder for ImmutableGCParams.
static ImmutableGCParams	copyOf(GCParams instance)	Creates an immutable copy of a GCParams value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableGCParams that have equal attribute values.
Long	getBloomFilterExpectedEntries()	Optional bloom filter expected live commits entries per reference.
double	getBloomFilterFpp()	Optional bloom filter fpp.
Duration	getCommitProtectionDuration()	Commit protection duration to avoid expiring on going or recent commits.
com.google.common.collect.ImmutableMap<String,Instant>	getCutOffTimestampPerRef()	Optional cutoff time per live reference.
Instant	getDeadReferenceCutOffTimeStamp()	Optional cutoff time for all the dead references.
Instant	getDefaultCutOffTimestamp()	Default cutoff time for all the references.
String	getNessieCatalogName()	Nessie catalog name to be used with spark to create the output results table.
com.google.common.collect.ImmutableMap<String,String>	getNessieClientConfigs()	Nessie client configurations from NessieConfigConstants.
String	getOutputBranchName()	Branch's name to be used for creating the output table.
String	getOutputTableIdentifier()	Output table identifier (namespace and table name) to be used for storing the results in getOutputBranchName().
Integer	getSparkPartitionsCount()	Optional spark partitions count to be used for distributing references.
int	hashCode()	Computes a hash code from attributes: nessieClientConfigs, cutOffTimestampPerRef, defaultCutOffTimestamp, deadReferenceCutOffTimeStamp, sparkPartitionsCount, commitProtectionDuration, bloomFilterExpectedEntries, bloomFilterFpp, nessieCatalogName, outputBranchName, outputTableIdentifier.
String	toString()	Prints the immutable value GCParams with attribute values.
ImmutableGCParams	withBloomFilterExpectedEntries(Long value)	Copy the current immutable object by setting a value for the bloomFilterExpectedEntries attribute.
ImmutableGCParams	withBloomFilterFpp(double value)	Copy the current immutable object by setting a value for the bloomFilterFpp attribute.
ImmutableGCParams	withCommitProtectionDuration(Duration value)	Copy the current immutable object by setting a value for the commitProtectionDuration attribute.
ImmutableGCParams	withCutOffTimestampPerRef(Map<String,? extends Instant> entries)	Copy the current immutable object by replacing the cutOffTimestampPerRef map with the specified map.
ImmutableGCParams	withDeadReferenceCutOffTimeStamp(Instant value)	Copy the current immutable object by setting a value for the deadReferenceCutOffTimeStamp attribute.
ImmutableGCParams	withDefaultCutOffTimestamp(Instant value)	Copy the current immutable object by setting a value for the defaultCutOffTimestamp attribute.
ImmutableGCParams	withNessieCatalogName(String value)	Copy the current immutable object by setting a value for the nessieCatalogName attribute.
ImmutableGCParams	withNessieClientConfigs(Map<String,? extends String> entries)	Copy the current immutable object by replacing the nessieClientConfigs map with the specified map.
ImmutableGCParams	withOutputBranchName(String value)	Copy the current immutable object by setting a value for the outputBranchName attribute.
ImmutableGCParams	withOutputTableIdentifier(String value)	Copy the current immutable object by setting a value for the outputTableIdentifier attribute.
ImmutableGCParams	withSparkPartitionsCount(Integer value)	Copy the current immutable object by setting a value for the sparkPartitionsCount attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.projectnessie.gc.base.GCParams

validate

Method Detail

getNessieClientConfigs

public com.google.common.collect.ImmutableMap<String,String> getNessieClientConfigs()

Nessie client configurations from NessieConfigConstants.

Specified by:

getNessieClientConfigs in interface GCParams

getCutOffTimestampPerRef

@Nullable
public com.google.common.collect.ImmutableMap<String,Instant> getCutOffTimestampPerRef()

Optional cutoff time per live reference.

Specified by:

getCutOffTimestampPerRef in interface GCParams

getDefaultCutOffTimestamp

public Instant getDefaultCutOffTimestamp()

Default cutoff time for all the references.

Specified by:

getDefaultCutOffTimestamp in interface GCParams

getDeadReferenceCutOffTimeStamp

@Nullable
public Instant getDeadReferenceCutOffTimeStamp()

Optional cutoff time for all the dead references.

Specified by:

getDeadReferenceCutOffTimeStamp in interface GCParams

getSparkPartitionsCount

@Nullable
public Integer getSparkPartitionsCount()

Optional spark partitions count to be used for distributing references. Default total reference count (live + dead) will be used.

Specified by:

getSparkPartitionsCount in interface GCParams

getCommitProtectionDuration

public Duration getCommitProtectionDuration()

Commit protection duration to avoid expiring on going or recent commits. Default is 2 hours.

Specified by:

getCommitProtectionDuration in interface GCParams

getBloomFilterExpectedEntries

@Nullable
public Long getBloomFilterExpectedEntries()

Optional bloom filter expected live commits entries per reference. Default is total commits in the default reference.

Specified by:

getBloomFilterExpectedEntries in interface GCParams

getBloomFilterFpp

public double getBloomFilterFpp()

Optional bloom filter fpp. Default value is 0.03d.

Specified by:

getBloomFilterFpp in interface GCParams

getNessieCatalogName

public String getNessieCatalogName()

Nessie catalog name to be used with spark to create the output results table.

Specified by:

getNessieCatalogName in interface GCParams

getOutputBranchName

public String getOutputBranchName()

Branch's name to be used for creating the output table.

If the branch doesn't exist for this name, branch with this name pointing to beginning of time (aka NO_ANCESTOR hash) will be created.

Specified by:

getOutputBranchName in interface GCParams

getOutputTableIdentifier

public String getOutputTableIdentifier()

Output table identifier (namespace and table name) to be used for storing the results in getOutputBranchName().

Specified by:

getOutputTableIdentifier in interface GCParams

withNessieClientConfigs

public final ImmutableGCParams withNessieClientConfigs(Map<String,? extends String> entries)

Copy the current immutable object by replacing the nessieClientConfigs map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the nessieClientConfigs map

Returns:

A modified copy of this object

withCutOffTimestampPerRef

public final ImmutableGCParams withCutOffTimestampPerRef(@Nullable
                                                         Map<String,? extends Instant> entries)

Copy the current immutable object by replacing the cutOffTimestampPerRef map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the cutOffTimestampPerRef map

Returns:

A modified copy of this object

withDefaultCutOffTimestamp

public final ImmutableGCParams withDefaultCutOffTimestamp(Instant value)

Copy the current immutable object by setting a value for the defaultCutOffTimestamp attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for defaultCutOffTimestamp

Returns:

A modified copy of the this object

withDeadReferenceCutOffTimeStamp

public final ImmutableGCParams withDeadReferenceCutOffTimeStamp(@Nullable
                                                                Instant value)

Copy the current immutable object by setting a value for the deadReferenceCutOffTimeStamp attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for deadReferenceCutOffTimeStamp (can be null)

Returns:

A modified copy of the this object

withSparkPartitionsCount

public final ImmutableGCParams withSparkPartitionsCount(@Nullable
                                                        Integer value)

Copy the current immutable object by setting a value for the sparkPartitionsCount attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for sparkPartitionsCount (can be null)

Returns:

A modified copy of the this object

withCommitProtectionDuration

public final ImmutableGCParams withCommitProtectionDuration(Duration value)

Copy the current immutable object by setting a value for the commitProtectionDuration attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for commitProtectionDuration

Returns:

A modified copy of the this object

withBloomFilterExpectedEntries

public final ImmutableGCParams withBloomFilterExpectedEntries(@Nullable
                                                              Long value)

Copy the current immutable object by setting a value for the bloomFilterExpectedEntries attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for bloomFilterExpectedEntries (can be null)

Returns:

A modified copy of the this object

withBloomFilterFpp

public final ImmutableGCParams withBloomFilterFpp(double value)

Copy the current immutable object by setting a value for the bloomFilterFpp attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for bloomFilterFpp

Returns:

A modified copy of the this object

withNessieCatalogName

public final ImmutableGCParams withNessieCatalogName(String value)

Copy the current immutable object by setting a value for the nessieCatalogName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for nessieCatalogName

Returns:

A modified copy of the this object

withOutputBranchName

public final ImmutableGCParams withOutputBranchName(String value)

Copy the current immutable object by setting a value for the outputBranchName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for outputBranchName

Returns:

A modified copy of the this object

withOutputTableIdentifier

public final ImmutableGCParams withOutputTableIdentifier(String value)

Copy the current immutable object by setting a value for the outputTableIdentifier attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for outputTableIdentifier

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableGCParams that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: nessieClientConfigs, cutOffTimestampPerRef, defaultCutOffTimestamp, deadReferenceCutOffTimeStamp, sparkPartitionsCount, commitProtectionDuration, bloomFilterExpectedEntries, bloomFilterFpp, nessieCatalogName, outputBranchName, outputTableIdentifier.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value GCParams with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableGCParams copyOf(GCParams instance)

Creates an immutable copy of a GCParams value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable GCParams instance

builder

public static ImmutableGCParams.Builder builder()

Creates a builder for ImmutableGCParams.

 ImmutableGCParams.builder()
    .putNessieClientConfigs|putAllNessieClientConfigs(String => String) // nessieClientConfigs mappings
    .cutOffTimestampPerRef(Map<String, java.time.Instant> | null) // nullable cutOffTimestampPerRef
    .defaultCutOffTimestamp(java.time.Instant) // required defaultCutOffTimestamp
    .deadReferenceCutOffTimeStamp(java.time.Instant | null) // nullable deadReferenceCutOffTimeStamp
    .sparkPartitionsCount(Integer | null) // nullable sparkPartitionsCount
    .commitProtectionDuration(java.time.Duration) // optional commitProtectionDuration
    .bloomFilterExpectedEntries(Long | null) // nullable bloomFilterExpectedEntries
    .bloomFilterFpp(double) // optional bloomFilterFpp
    .nessieCatalogName(String) // required nessieCatalogName
    .outputBranchName(String) // required outputBranchName
    .outputTableIdentifier(String) // required outputTableIdentifier
    .build();
 

Returns:

A new ImmutableGCParams builder