Class ListConnectionInvitationsRequest

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

  • Method Details

    • catalog

      public final String catalog()

      The catalog identifier for the partner account.

      Returns:
      The catalog identifier for the partner account.

    • nextToken

      public final String nextToken()

      The token for retrieving the next page of results in paginated responses.

      Returns:
      The token for retrieving the next page of results in paginated responses.

    • connectionType

      public final ConnectionType connectionType()

      Filter results by connection type (e.g., reseller, distributor, technology partner).

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

      Returns:
      Filter results by connection type (e.g., reseller, distributor, technology partner).
      See Also:

    • connectionTypeAsString

      public final String connectionTypeAsString()

      Filter results by connection type (e.g., reseller, distributor, technology partner).

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

      Returns:
      Filter results by connection type (e.g., reseller, distributor, technology partner).
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of connection invitations to return in a single response.

      Returns:
      The maximum number of connection invitations to return in a single response.

    • hasOtherParticipantIdentifiers

      public final boolean hasOtherParticipantIdentifiers()
      For responses, this returns true if the service returned a value for the OtherParticipantIdentifiers 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.

    • otherParticipantIdentifiers

      public final List<String> otherParticipantIdentifiers()

      Filter results by specific participant 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 hasOtherParticipantIdentifiers() method.

      Returns:
      Filter results by specific participant identifiers.

    • participantType

      public final ParticipantType participantType()

      Filter results by participant type (inviter or invitee).

      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 results by participant type (inviter or invitee).
      See Also:

    • participantTypeAsString

      public final String participantTypeAsString()

      Filter results by participant type (inviter or invitee).

      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 results by participant type (inviter or invitee).
      See Also:

    • status

      public final InvitationStatus status()

      Filter results by invitation status (pending, accepted, rejected, canceled, expired).

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

      Returns:
      Filter results by invitation status (pending, accepted, rejected, canceled, expired).
      See Also:

    • statusAsString

      public final String statusAsString()

      Filter results by invitation status (pending, accepted, rejected, canceled, expired).

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

      Returns:
      Filter results by invitation status (pending, accepted, rejected, canceled, expired).
      See Also:

    • toBuilder

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

    • builder

      public static ListConnectionInvitationsRequest.Builder builder()

    • serializableBuilderClass

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