software.amazon.awssdk.services.transfer.model

Class ListProfilesRequest

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.ListProfilesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListProfilesRequest.Builder,ListProfilesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListProfilesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListProfilesRequest.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 profiles to return.
String	nextToken() When there are additional results that were not returned, a NextToken parameter is returned.
ProfileType	profileType() Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
String	profileTypeAsString() Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
List<SdkField<?>>	sdkFields()
static Class<? extends ListProfilesRequest.Builder>	serializableBuilderClass()
ListProfilesRequest.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 profiles to return.

Returns:

The maximum number of profiles to return.

nextToken

public final String nextToken()

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

Returns:

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

profileType

public final ProfileType profileType()

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

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

Returns:

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

See Also:

ProfileType

profileTypeAsString

public final String profileTypeAsString()

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

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

Returns:

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

See Also:

ProfileType

toBuilder

public ListProfilesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListProfilesRequest.Builder,ListProfilesRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static ListProfilesRequest.Builder builder()

serializableBuilderClass

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