software.amazon.awssdk.services.marketplaceentitlement.model

Class GetEntitlementsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.marketplaceentitlement.model.MarketplaceEntitlementRequest

software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetEntitlementsRequest.Builder,GetEntitlementsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetEntitlementsRequest
extends MarketplaceEntitlementRequest
implements ToCopyableBuilder<GetEntitlementsRequest.Builder,GetEntitlementsRequest>

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetEntitlementsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetEntitlementsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<GetEntitlementFilterName,List<String>>	filter() Filter is used to return entitlements for a specific customer or for a specific dimension.
Map<String,List<String>>	filterAsStrings() Filter is used to return entitlements for a specific customer or for a specific dimension.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilter() For responses, this returns true if the service returned a value for the Filter property.
int	hashCode()
Integer	maxResults() The maximum number of items to retrieve from the GetEntitlements operation.
String	nextToken() For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
String	productCode() Product code is used to uniquely identify a product in AWS Marketplace.
List<SdkField<?>>	sdkFields()
static Class<? extends GetEntitlementsRequest.Builder>	serializableBuilderClass()
GetEntitlementsRequest.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

productCode

public final String productCode()

Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

Returns:

Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

filter

public final Map<GetEntitlementFilterName,List<String>> filter()

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

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 hasFilter() method.

Returns:

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

hasFilter

public final boolean hasFilter()

For responses, this returns true if the service returned a value for the Filter 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.

filterAsStrings

public final Map<String,List<String>> filterAsStrings()

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

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 hasFilter() method.

Returns:

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

nextToken

public final String nextToken()

For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

Returns:

For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

maxResults

public final Integer maxResults()

The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

Returns:

The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

toBuilder

public GetEntitlementsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetEntitlementsRequest.Builder,GetEntitlementsRequest>

Specified by:

toBuilder in class MarketplaceEntitlementRequest

builder

public static GetEntitlementsRequest.Builder builder()

serializableBuilderClass

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