Interface SearchAgreementsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchAgreementsRequest.Builder,
,SearchAgreementsRequest> MarketplaceAgreementRequest.Builder
,SdkBuilder<SearchAgreementsRequest.Builder,
,SearchAgreementsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchAgreementsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe catalog in which the agreement was created.filters
(Collection<Filter> filters) The filter name and value pair used to return a specific list of results.filters
(Consumer<Filter.Builder>... filters) The filter name and value pair used to return a specific list of results.The filter name and value pair used to return a specific list of results.maxResults
(Integer maxResults) The maximum number of agreements to return in the response.A token to specify where to start pagination.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default SearchAgreementsRequest.Builder
sort
(Consumer<Sort.Builder> sort) An object that contains theSortBy
andSortOrder
attributes.An object that contains theSortBy
andSortOrder
attributes.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.marketplaceagreement.model.MarketplaceAgreementRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
catalog
The catalog in which the agreement was created.
- Parameters:
catalog
- The catalog in which the agreement was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, orSaaSProduct
). -
PartyType
– The party type (eitherAcceptor
orProposer
) of the caller. For agreements where the caller is the proposer, use theProposer
filter. For agreements where the caller is the acceptor, use theAcceptor
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 includeACTIVE
,ARCHIVED
,CANCELLED
,EXPIRED
,RENEWED
,REPLACED
, andTERMINATED
. -
BeforeEndTime
– A date used to filter agreements with a date before theendTime
of an agreement. -
AfterEndTime
– A date used to filter agreements with a date after theendTime
of an agreement. -
AgreementType
– The type of agreement. Values includePurchaseAgreement
orVendorInsightsAgreement
.
- Parameters:
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
, orSaaSProduct
). -
PartyType
– The party type (eitherAcceptor
orProposer
) of the caller. For agreements where the caller is the proposer, use theProposer
filter. For agreements where the caller is the acceptor, use theAcceptor
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 includeACTIVE
,ARCHIVED
,CANCELLED
,EXPIRED
,RENEWED
,REPLACED
, andTERMINATED
. -
BeforeEndTime
– A date used to filter agreements with a date before theendTime
of an agreement. -
AfterEndTime
– A date used to filter agreements with a date after theendTime
of an agreement. -
AgreementType
– The type of agreement. Values includePurchaseAgreement
orVendorInsightsAgreement
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
, orSaaSProduct
). -
PartyType
– The party type (eitherAcceptor
orProposer
) of the caller. For agreements where the caller is the proposer, use theProposer
filter. For agreements where the caller is the acceptor, use theAcceptor
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 includeACTIVE
,ARCHIVED
,CANCELLED
,EXPIRED
,RENEWED
,REPLACED
, andTERMINATED
. -
BeforeEndTime
– A date used to filter agreements with a date before theendTime
of an agreement. -
AfterEndTime
– A date used to filter agreements with a date after theendTime
of an agreement. -
AgreementType
– The type of agreement. Values includePurchaseAgreement
orVendorInsightsAgreement
.
- Parameters:
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
, orSaaSProduct
). -
PartyType
– The party type (eitherAcceptor
orProposer
) of the caller. For agreements where the caller is the proposer, use theProposer
filter. For agreements where the caller is the acceptor, use theAcceptor
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 includeACTIVE
,ARCHIVED
,CANCELLED
,EXPIRED
,RENEWED
,REPLACED
, andTERMINATED
. -
BeforeEndTime
– A date used to filter agreements with a date before theendTime
of an agreement. -
AfterEndTime
– A date used to filter agreements with a date after theendTime
of an agreement. -
AgreementType
– The type of agreement. Values includePurchaseAgreement
orVendorInsightsAgreement
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
, orSaaSProduct
). -
PartyType
– The party type (eitherAcceptor
orProposer
) of the caller. For agreements where the caller is the proposer, use theProposer
filter. For agreements where the caller is the acceptor, use theAcceptor
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 includeACTIVE
,ARCHIVED
,CANCELLED
,EXPIRED
,RENEWED
,REPLACED
, andTERMINATED
. -
BeforeEndTime
– A date used to filter agreements with a date before theendTime
of an agreement. -
AfterEndTime
– A date used to filter agreements with a date after theendTime
of an agreement. -
AgreementType
– The type of agreement. Values includePurchaseAgreement
orVendorInsightsAgreement
.
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
maxResults
The maximum number of agreements to return in the response.
- Parameters:
maxResults
- The maximum number of agreements to return in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
A token to specify where to start pagination.
- Parameters:
nextToken
- A token to specify where to start pagination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sort
An object that contains the
SortBy
andSortOrder
attributes.- Parameters:
sort
- An object that contains theSortBy
andSortOrder
attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sort
An object that contains the
This is a convenience method that creates an instance of theSortBy
andSortOrder
attributes.Sort.Builder
avoiding the need to create one manually viaSort.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosort(Sort)
.- Parameters:
sort
- a consumer that will call methods onSort.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SearchAgreementsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SearchAgreementsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-