Class ListChannelHandshakesRequest

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

  • Method Details

    • handshakeType

      public final HandshakeType handshakeType()

      Filter results by handshake type.

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

      Returns:
      Filter results by handshake type.
      See Also:

    • handshakeTypeAsString

      public final String handshakeTypeAsString()

      Filter results by handshake type.

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

      Returns:
      Filter results by handshake type.
      See Also:

    • catalog

      public final String catalog()

      The catalog identifier to filter handshakes.

      Returns:
      The catalog identifier to filter handshakes.

    • participantType

      public final ParticipantType participantType()

      Filter by participant type (sender or receiver).

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

      Returns:
      Filter by participant type (sender or receiver).
      See Also:

    • participantTypeAsString

      public final String participantTypeAsString()

      Filter by participant type (sender or receiver).

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

      Returns:
      Filter by participant type (sender or receiver).
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single call.

      Returns:
      The maximum number of results to return in a single call.

    • statuses

      public final List<HandshakeStatus> statuses()

      Filter results by handshake status.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatuses() method.

      Returns:
      Filter results by handshake status.

    • hasStatuses

      public final boolean hasStatuses()
      For responses, this returns true if the service returned a value for the Statuses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • statusesAsStrings

      public final List<String> statusesAsStrings()

      Filter results by handshake status.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatuses() method.

      Returns:
      Filter results by handshake status.

    • hasAssociatedResourceIdentifiers

      public final boolean hasAssociatedResourceIdentifiers()
      For responses, this returns true if the service returned a value for the AssociatedResourceIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • associatedResourceIdentifiers

      public final List<String> associatedResourceIdentifiers()

      Filter by associated resource identifiers.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedResourceIdentifiers() method.

      Returns:
      Filter by associated resource identifiers.

    • handshakeTypeFilters

      public final ListChannelHandshakesTypeFilters handshakeTypeFilters()

      Type-specific filters for handshakes.

      Returns:
      Type-specific filters for handshakes.

    • handshakeTypeSort

      public final ListChannelHandshakesTypeSort handshakeTypeSort()

      Type-specific sorting options for handshakes.

      Returns:
      Type-specific sorting options for handshakes.

    • nextToken

      public final String nextToken()

      Token for retrieving the next page of results.

      Returns:
      Token for retrieving the next page of results.

    • toBuilder

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

    • builder

      public static ListChannelHandshakesRequest.Builder builder()

    • serializableBuilderClass

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