com.iland.cohesity.iaas.backups.policies.api.model

Class ImmutableBlackoutPeriod

java.lang.Object

com.iland.cohesity.iaas.backups.policies.api.model.ImmutableBlackoutPeriod

All Implemented Interfaces:

BlackoutPeriod

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

Immutable implementation of BlackoutPeriod.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableBlackoutPeriod.Builder	builder() Creates a builder for ImmutableBlackoutPeriod.
static ImmutableBlackoutPeriod	copyOf(BlackoutPeriod instance) Creates an immutable copy of a BlackoutPeriod value.
Optional<Day>	day() Blackout Day.
TimeOfDay	endTime() Specifies the end time of the blackout time range.
boolean	equals(Object another) This instance is equal to all instances of ImmutableBlackoutPeriod that have equal attribute values.
int	hashCode() Computes a hash code from attributes: day, endTime, startTime.
TimeOfDay	startTime() Specifies the start time of the blackout time range.
String	toString() Prints the immutable value BlackoutPeriod with attribute values.
ImmutableBlackoutPeriod	withDay(Day value) Copy the current immutable object by setting a present value for the optional day attribute.
ImmutableBlackoutPeriod	withDay(Optional<? extends Day> optional) Copy the current immutable object by setting an optional value for the day attribute.
ImmutableBlackoutPeriod	withEndTime(TimeOfDay value) Copy the current immutable object by setting a value for the endTime attribute.
ImmutableBlackoutPeriod	withStartTime(TimeOfDay value) Copy the current immutable object by setting a value for the startTime attribute.

Methods inherited from class java.lang.Object

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

Method Detail

day

public Optional<Day> day()

Blackout Day.

Specifies a day in the week when no new backup group Runs should be started such as 'SUNDAY'. If not set, the time range applies to all days. Specifies a day in a week such as 'SUNDAY', 'MONDAY', etc.

Specified by:

day in interface BlackoutPeriod

endTime

public TimeOfDay endTime()

Specifies the end time of the blackout time range.

Specified by:

endTime in interface BlackoutPeriod

startTime

public TimeOfDay startTime()

Specifies the start time of the blackout time range.

Specified by:

startTime in interface BlackoutPeriod

withDay

public final ImmutableBlackoutPeriod withDay(Day value)

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

Parameters:

value - The value for day

Returns:

A modified copy of this object

withDay

public final ImmutableBlackoutPeriod withDay(Optional<? extends Day> optional)

Copy the current immutable object by setting an optional value for the day 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 day

Returns:

A modified copy of this object

withEndTime

public final ImmutableBlackoutPeriod withEndTime(TimeOfDay value)

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

Parameters:

value - A new value for endTime

Returns:

A modified copy of the this object

withStartTime

public final ImmutableBlackoutPeriod withStartTime(TimeOfDay value)

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

Parameters:

value - A new value for startTime

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableBlackoutPeriod 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: day, endTime, startTime.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BlackoutPeriod with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableBlackoutPeriod copyOf(BlackoutPeriod instance)

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

builder

public static ImmutableBlackoutPeriod.Builder builder()

Creates a builder for ImmutableBlackoutPeriod.

 ImmutableBlackoutPeriod.builder()
    .day(com.iland.cohesity.iaas.backups.policies.api.enums.Day) // optional day
    .endTime(com.iland.cohesity.iaas.backups.common.model.TimeOfDay) // required endTime
    .startTime(com.iland.cohesity.iaas.backups.common.model.TimeOfDay) // required startTime
    .build();
 

Returns:

A new ImmutableBlackoutPeriod builder