com.iland.cohesity.iaas.backups.samples.model

Class ImmutableSample

java.lang.Object

com.iland.cohesity.iaas.backups.samples.model.ImmutableSample

All Implemented Interfaces:

Sample

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableSample
extends Object
implements Sample

Immutable implementation of Sample.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableSample.Builder	builder() Creates a builder for ImmutableSample.
com.google.common.collect.ImmutableMap<BackupClusterUid,Optional<Long>>	components() The component samples that contribute to the total value.
static ImmutableSample	copyOf(Sample instance) Creates an immutable copy of a Sample value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableSample that have equal attribute values.
int	hashCode() Computes a hash code from attributes: timestamp, value, components.
Instant	timestamp() The timestamp of the sample.
String	toString() Prints the immutable value Sample with attribute values.
Optional<Long>	value() The value in bytes.
ImmutableSample	withComponents(Map<? extends BackupClusterUid,? extends Optional<Long>> entries) Copy the current immutable object by replacing the components map with the specified map.
ImmutableSample	withTimestamp(Instant value) Copy the current immutable object by setting a value for the timestamp attribute.
ImmutableSample	withValue(long value) Copy the current immutable object by setting a present value for the optional value attribute.
ImmutableSample	withValue(Optional<Long> optional) Copy the current immutable object by setting an optional value for the value attribute.

Methods inherited from class java.lang.Object

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

Method Detail

timestamp

public Instant timestamp()

The timestamp of the sample.

Specified by:

timestamp in interface Sample

value

public Optional<Long> value()

The value in bytes.

Specified by:

value in interface Sample

components

public com.google.common.collect.ImmutableMap<BackupClusterUid,Optional<Long>> components()

The component samples that contribute to the total value.

Specified by:

components in interface Sample

Returns:

Map of BackupClusterUid keys to value in bytes

withTimestamp

public final ImmutableSample withTimestamp(Instant value)

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

Parameters:

value - A new value for timestamp

Returns:

A modified copy of the this object

withValue

public final ImmutableSample withValue(long value)

Copy the current immutable object by setting a present value for the optional value attribute.

Parameters:

value - The value for value

Returns:

A modified copy of this object

withValue

public final ImmutableSample withValue(Optional<Long> optional)

Copy the current immutable object by setting an optional value for the value attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for value

Returns:

A modified copy of this object

withComponents

public final ImmutableSample withComponents(Map<? extends BackupClusterUid,? extends Optional<Long>> entries)

Copy the current immutable object by replacing the components 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 components map

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableSample 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: timestamp, value, components.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Sample with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableSample copyOf(Sample instance)

Creates an immutable copy of a Sample 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 Sample instance

builder

public static ImmutableSample.Builder builder()

Creates a builder for ImmutableSample.

 ImmutableSample.builder()
    .timestamp(java.time.Instant) // required timestamp
    .value(Long) // optional value
    .putComponents|putAllComponents(com.iland.cohesity.iaas.backups.common.model.BackupClusterUid => Optional<Long>) // components mappings
    .build();
 

Returns:

A new ImmutableSample builder