Package org.projectnessie.model

Class ImmutableLogResponse

java.lang.Object

org.projectnessie.model.ImmutableLogResponse

All Implemented Interfaces:

LogResponse, PaginatedResponse

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

Immutable implementation of LogResponse.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.projectnessie.model.LogResponse

LogResponse.LogEntry

Method Summary

Modifier and Type	Method	Description
static ImmutableLogResponse.Builder	builder()	Creates a builder for ImmutableLogResponse.
static ImmutableLogResponse	copyOf(LogResponse instance)	Creates an immutable copy of a LogResponse value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableLogResponse that have equal attribute values.
List<LogResponse.LogEntry>	getLogEntries()
String	getToken()	Pass this value to the next invocation of the API function to get the next page of results.
int	hashCode()	Computes a hash code from attributes: isHasMore, token, logEntries.
boolean	isHasMore()	Whether there are more result-items than returned by this response object.
String	toString()	Prints the immutable value LogResponse with attribute values.
ImmutableLogResponse	withIsHasMore(boolean value)	Copy the current immutable object by setting a value for the isHasMore attribute.
ImmutableLogResponse	withLogEntries(Iterable<? extends LogResponse.LogEntry> elements)	Copy the current immutable object with elements that replace the content of logEntries.
ImmutableLogResponse	withLogEntries(LogResponse.LogEntry... elements)	Copy the current immutable object with elements that replace the content of logEntries.
ImmutableLogResponse	withToken(String value)	Copy the current immutable object by setting a value for the token attribute.

Methods inherited from class java.lang.Object

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

Method Detail

isHasMore

public boolean isHasMore()

Whether there are more result-items than returned by this response object.

If there are more result-items, the value returned by getToken() can be used in the next invocation to get the next "page" of results.

Specified by:

isHasMore in interface PaginatedResponse

Returns:

true, if there are more result items.

getToken

@Nullable
public String getToken()

Pass this value to the next invocation of the API function to get the next page of results.

Paging tokens are opaque and the structure may change without prior notice even in patch releases.

Specified by:

getToken in interface PaginatedResponse

Returns:

paging continuation token for the next invocation of an API function taking a subclass of AbstractParams, if isHasMore() is true. Undefined, if isHasMore() is false.

getLogEntries

public List<LogResponse.LogEntry> getLogEntries()

Specified by:

getLogEntries in interface LogResponse

Returns:

The value of the logEntries attribute

withIsHasMore

public final ImmutableLogResponse withIsHasMore(boolean value)

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

Parameters:

value - A new value for isHasMore

Returns:

A modified copy of the this object

withToken

public final ImmutableLogResponse withToken(@Nullable
                                            String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withLogEntries

public final ImmutableLogResponse withLogEntries(LogResponse.LogEntry... elements)

Copy the current immutable object with elements that replace the content of logEntries.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withLogEntries

public final ImmutableLogResponse withLogEntries(Iterable<? extends LogResponse.LogEntry> elements)

Copy the current immutable object with elements that replace the content of logEntries. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of logEntries elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableLogResponse 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: isHasMore, token, logEntries.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value LogResponse with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableLogResponse copyOf(LogResponse instance)

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

builder

public static ImmutableLogResponse.Builder builder()

Creates a builder for ImmutableLogResponse.

 ImmutableLogResponse.builder()
    .isHasMore(boolean) // optional isHasMore
    .token(String | null) // nullable token
    .addLogEntries|addAllLogEntries(org.projectnessie.model.LogResponse.LogEntry) // logEntries elements
    .build();
 

Returns:

A new ImmutableLogResponse builder