Package software.amazon.awssdk.services.datazone.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListSubscriptionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	approverProjectId()	The identifier of the project for the subscription's approver.
static ListSubscriptionsRequest.Builder	builder()
String	domainIdentifier()	The identifier of the Amazon DataZone domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of subscriptions to return in a single call to ListSubscriptions.
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.
String	owningProjectId()	The identifier of the owning project.
List<SdkField<?>>	sdkFields()
static Class<? extends ListSubscriptionsRequest.Builder>	serializableBuilderClass()
SortKey	sortBy()	Specifies the way in which the results of this action are to be sorted.
String	sortByAsString()	Specifies the way in which the results of this action are to be sorted.
SortOrder	sortOrder()	Specifies the sort order for the results of this action.
String	sortOrderAsString()	Specifies the sort order for the results of this action.
SubscriptionStatus	status()	The status of the subscriptions that you want to list.
String	statusAsString()	The status of the subscriptions that you want to list.
String	subscribedListingId()	The identifier of the subscribed listing for the subscriptions that you want to list.
String	subscriptionRequestIdentifier()	The identifier of the subscription request for the subscriptions that you want to list.
ListSubscriptionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SortKey

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:

SortKey

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:

SortOrder

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:

SortOrder

status

public final SubscriptionStatus status()

The status of the subscriptions that you want to list.

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.

See Also:

SubscriptionStatus

statusAsString

public final String statusAsString()

The status of the subscriptions that you want to list.

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.

See Also:

SubscriptionStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListSubscriptionsRequest.Builder,ListSubscriptionsRequest>

Specified by:

toBuilder in class DataZoneRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo