Package software.amazon.awssdk.services.transfer.model

Class ListAgreementsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.ListAgreementsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAgreementsRequest.Builder,ListAgreementsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAgreementsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListAgreementsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of items to return.
String	nextToken()	When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListAgreementsRequest.Builder>	serializableBuilderClass()
String	serverId()	The identifier of the server for which you want a list of agreements.
ListAgreementsRequest.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

maxResults

public final Integer maxResults()

The maximum number of items to return.

Returns:

The maximum number of items to return.

nextToken

public final String nextToken()

When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

Returns:

When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

serverId

public final String serverId()

The identifier of the server for which you want a list of agreements.

Returns:

The identifier of the server for which you want a list of agreements.

toBuilder

public ListAgreementsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAgreementsRequest.Builder,ListAgreementsRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static ListAgreementsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListAgreementsRequest.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