software.amazon.awssdk.services.kafka.model

Class ListClustersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kafka.model.KafkaRequest

software.amazon.awssdk.services.kafka.model.ListClustersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListClustersRequest.Builder,ListClustersRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListClustersRequest
extends KafkaRequest
implements ToCopyableBuilder<ListClustersRequest.Builder,ListClustersRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListClustersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListClustersRequest.Builder	builder()
String	clusterNameFilter() Specify a prefix of the name of the clusters that you want to list.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of clusters to return in the response.
String	nextToken() The paginated results marker.
List<SdkField<?>>	sdkFields()
static Class<? extends ListClustersRequest.Builder>	serializableBuilderClass()
ListClustersRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clusterNameFilter

public String clusterNameFilter()

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

Returns:

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

maxResults

public Integer maxResults()

The maximum number of clusters to return in the response. If there are more clusters, the response includes a NextToken parameter.

Returns:

The maximum number of clusters to return in the response. If there are more clusters, the response includes a NextToken parameter.

nextToken

public String nextToken()

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

Returns:

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

toBuilder

public ListClustersRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListClustersRequest.Builder,ListClustersRequest>

Specified by:

toBuilder in class KafkaRequest

Returns:

a builder for type T

builder

public static ListClustersRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.