Class ListSubscriptionsRequest

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

  • Method Details

    • approverProjectId

      public final String approverProjectId()

      The identifier of the project for the subscription's approver.

      Returns:
      The identifier of the project for the subscription's approver.

    • domainIdentifier

      public final String domainIdentifier()

      The identifier of the Amazon DataZone domain.

      Returns:
      The identifier of the Amazon DataZone domain.

    • maxResults

      public final Integer maxResults()

      The maximum number of subscriptions to return in a single call to ListSubscriptions. When the number of subscriptions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptions to list the next set of Subscriptions.

      Returns:
      The maximum number of subscriptions to return in a single call to ListSubscriptions. When the number of subscriptions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptions to list the next set of Subscriptions.

    • nextToken

      public final String nextToken()

      When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

      Returns:
      When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

    • owningProjectId

      public final String owningProjectId()

      The identifier of the owning project.

      Returns:
      The identifier of the owning project.

    • sortBy

      public final SortKey sortBy()

      Specifies the way in which the results of this action are to be sorted.

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

      Returns:
      Specifies the way in which the results of this action are to be sorted.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      Specifies the way in which the results of this action are to be sorted.

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

      Returns:
      Specifies the way in which the results of this action are to be sorted.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      Specifies the sort order for the results of this action.

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

      Returns:
      Specifies the sort order for the results of this action.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      Specifies the sort order for the results of this action.

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

      Returns:
      Specifies the sort order for the results of this action.
      See Also:

    • status

      public final SubscriptionStatus status()

      The status of the subscriptions that you want to list.

      This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

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

      Returns:
      The status of the subscriptions that you want to list.

      This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the subscriptions that you want to list.

      This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

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

      Returns:
      The status of the subscriptions that you want to list.

      This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

      See Also:

    • subscribedListingId

      public final String subscribedListingId()

      The identifier of the subscribed listing for the subscriptions that you want to list.

      Returns:
      The identifier of the subscribed listing for the subscriptions that you want to list.

    • subscriptionRequestIdentifier

      public final String subscriptionRequestIdentifier()

      The identifier of the subscription request for the subscriptions that you want to list.

      Returns:
      The identifier of the subscription request for the subscriptions that you want to list.

    • toBuilder

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

    • builder

      public static ListSubscriptionsRequest.Builder builder()

    • serializableBuilderClass

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