Package software.amazon.awssdk.services.pricing.model

Class GetProductsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pricing.model.PricingRequest

software.amazon.awssdk.services.pricing.model.GetProductsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetProductsRequest.Builder,GetProductsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetProductsRequest
extends PricingRequest
implements ToCopyableBuilder<GetProductsRequest.Builder,GetProductsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetProductsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetProductsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	The list of filters that limit the returned products.
String	formatVersion()	The format version that you want the response to be in.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	The maximum number of results to return in the response.
String	nextToken()	The pagination token that indicates the next set of results that you want to retrieve.
List<SdkField<?>>	sdkFields()
static Class<? extends GetProductsRequest.Builder>	serializableBuilderClass()
String	serviceCode()	The code for the service whose products you want to retrieve.
GetProductsRequest.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

serviceCode

public final String serviceCode()

The code for the service whose products you want to retrieve.

Returns:

The code for the service whose products you want to retrieve.

hasFilters

public final boolean hasFilters()

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

filters

public final List<Filter> filters()

The list of filters that limit the returned products. only products that match all filters are returned.

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

Returns:

The list of filters that limit the returned products. only products that match all filters are returned.

formatVersion

public final String formatVersion()

The format version that you want the response to be in.

Valid values are: aws_v1

Returns:

The format version that you want the response to be in.

Valid values are: aws_v1

nextToken

public final String nextToken()

The pagination token that indicates the next set of results that you want to retrieve.

Returns:

The pagination token that indicates the next set of results that you want to retrieve.

maxResults

public final Integer maxResults()

The maximum number of results to return in the response.

Returns:

The maximum number of results to return in the response.

toBuilder

public GetProductsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetProductsRequest.Builder,GetProductsRequest>

Specified by:

toBuilder in class PricingRequest

builder

public static GetProductsRequest.Builder builder()

serializableBuilderClass

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