Class ListGuestUsersRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.wickr.model.WickrRequest
software.amazon.awssdk.services.wickr.model.ListGuestUsersRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListGuestUsersRequest.Builder,ListGuestUsersRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListGuestUsersRequest extends WickrRequest implements ToCopyableBuilder<ListGuestUsersRequest.Builder,ListGuestUsersRequest>

  • Method Details

    • networkId

      public final String networkId()

      The ID of the Wickr network from which to list guest users.

      Returns:
      The ID of the Wickr network from which to list guest users.

    • maxResults

      public final Integer maxResults()

      The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.

      Returns:
      The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.

    • sortDirection

      public final SortDirection sortDirection()

      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

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

      Returns:
      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
      See Also:

    • sortDirectionAsString

      public final String sortDirectionAsString()

      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

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

      Returns:
      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
      See Also:

    • sortFields

      public final String sortFields()

      The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.

      Returns:
      The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.

    • username

      public final String username()

      Filter results to only include guest users with usernames matching this value.

      Returns:
      Filter results to only include guest users with usernames matching this value.

    • billingPeriod

      public final String billingPeriod()

      Filter results to only include guest users from this billing period (e.g., '2024-01').

      Returns:
      Filter results to only include guest users from this billing period (e.g., '2024-01').

    • nextToken

      public final String nextToken()

      The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

      Returns:
      The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    • toBuilder

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

    • builder

      public static ListGuestUsersRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.