Package software.amazon.awssdk.services.marketplaceagreement.model

Class SearchAgreementsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.marketplaceagreement.model.MarketplaceAgreementRequest

software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchAgreementsRequest.Builder,SearchAgreementsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchAgreementsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchAgreementsRequest.Builder	builder()
String	catalog()	The catalog in which the agreement was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	The filter name and value pair used to return a specific list of results.
<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 agreements to return in the response.
String	nextToken()	A token to specify where to start pagination.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchAgreementsRequest.Builder>	serializableBuilderClass()
Sort	sort()	An object that contains the SortBy and SortOrder attributes.
SearchAgreementsRequest.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

catalog

public final String catalog()

The catalog in which the agreement was created.

Returns:

The catalog in which the agreement was created.

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 filter name and value pair used to return a specific list of results.

The following filters are supported:

• ResourceIdentifier – The unique identifier of the resource.

• ResourceType – Type of the resource, which is the product (AmiProduct, ContainerProduct, or SaaSProduct).

• PartyType – The party type (either Acceptor or Proposer) of the caller. For agreements where the caller is the proposer, use the Proposer filter. For agreements where the caller is the acceptor, use the Acceptor filter.

• AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.

• OfferId – The unique identifier of the offer in which the terms are registered in the agreement token.

• Status – The current status of the agreement. Values include ACTIVE, ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.

• BeforeEndTime – A date used to filter agreements with a date before the endTime of an agreement.

• AfterEndTime – A date used to filter agreements with a date after the endTime of an agreement.

• AgreementType – The type of agreement. Values include PurchaseAgreement or VendorInsightsAgreement.

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 filter name and value pair used to return a specific list of results.

The following filters are supported:

• ResourceIdentifier – The unique identifier of the resource.

• ResourceType – Type of the resource, which is the product (AmiProduct, ContainerProduct, or SaaSProduct).

• PartyType – The party type (either Acceptor or Proposer) of the caller. For agreements where the caller is the proposer, use the Proposer filter. For agreements where the caller is the acceptor, use the Acceptor filter.

• AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.

• OfferId – The unique identifier of the offer in which the terms are registered in the agreement token.

• Status – The current status of the agreement. Values include ACTIVE, ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.

• BeforeEndTime – A date used to filter agreements with a date before the endTime of an agreement.

• AfterEndTime – A date used to filter agreements with a date after the endTime of an agreement.

• AgreementType – The type of agreement. Values include PurchaseAgreement or VendorInsightsAgreement.

maxResults

public final Integer maxResults()

The maximum number of agreements to return in the response.

Returns:

The maximum number of agreements to return in the response.

nextToken

public final String nextToken()

A token to specify where to start pagination.

Returns:

A token to specify where to start pagination.

sort

public final Sort sort()

An object that contains the SortBy and SortOrder attributes.

Returns:

An object that contains the SortBy and SortOrder attributes.

toBuilder

public SearchAgreementsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchAgreementsRequest.Builder,SearchAgreementsRequest>

Specified by:

toBuilder in class MarketplaceAgreementRequest

builder

public static SearchAgreementsRequest.Builder builder()

serializableBuilderClass

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