Package software.amazon.awssdk.services.eventbridge.model

Class ListArchivesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest

software.amazon.awssdk.services.eventbridge.model.ListArchivesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListArchivesRequest.Builder,ListArchivesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListArchivesRequest
extends EventBridgeRequest
implements ToCopyableBuilder<ListArchivesRequest.Builder,ListArchivesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListArchivesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListArchivesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventSourceArn()	The ARN of the event source associated with the archive.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of results to return.
String	namePrefix()	A name prefix to filter the archives returned.
String	nextToken()	The token returned by a previous call, which you can use to retrieve the next set of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListArchivesRequest.Builder>	serializableBuilderClass()
ArchiveState	state()	The state of the archive.
String	stateAsString()	The state of the archive.
ListArchivesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

namePrefix

public final String namePrefix()

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

Returns:

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

eventSourceArn

public final String eventSourceArn()

The ARN of the event source associated with the archive.

Returns:

The ARN of the event source associated with the archive.

state

public final ArchiveState state()

The state of the archive.

If the service returns an enum value that is not available in the current SDK version, state will return ArchiveState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the archive.

See Also:

ArchiveState

stateAsString

public final String stateAsString()

The state of the archive.

If the service returns an enum value that is not available in the current SDK version, state will return ArchiveState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the archive.

See Also:

ArchiveState

nextToken

public final String nextToken()

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Returns:

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

limit

public final Integer limit()

The maximum number of results to return.

Returns:

The maximum number of results to return.

toBuilder

public ListArchivesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListArchivesRequest.Builder,ListArchivesRequest>

Specified by:

toBuilder in class EventBridgeRequest

builder

public static ListArchivesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListArchivesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo