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("software.amazon.awssdk:codegen") public final class ListProfilesRequest extends TransferRequest implements ToCopyableBuilder<ListProfilesRequest.Builder,ListProfilesRequest>

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public ListProfilesRequest.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<ListProfilesRequest.Builder,ListProfilesRequest>
      Specified by:
      toBuilder in class TransferRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.