Interface SearchAgreementsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchAgreementsRequest.Builder,SearchAgreementsRequest>, MarketplaceAgreementRequest.Builder, SdkBuilder<SearchAgreementsRequest.Builder,SearchAgreementsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchAgreementsRequest
@Mutable @NotThreadSafe public static interface SearchAgreementsRequest.Builder extends MarketplaceAgreementRequest.Builder, SdkPojo, CopyableBuilder<SearchAgreementsRequest.Builder,SearchAgreementsRequest>

  • Method Details

    • catalog

      SearchAgreementsRequest.Builder catalog(String 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

      SearchAgreementsRequest.Builder filters(Collection<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, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).

      • PartyType – The party type of the caller. Use Proposer or Acceptor.

      • 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, 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.

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

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

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

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

      • AgreementType – The type of agreement. Supported value includes PurchaseAgreement.

      • OfferSetId – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

      • EndTimeBehaviorType – What happens to the agreement when it reaches its end date. Values include RENEW, REPLACE, and EXPIRE.

      • EndTimeBehaviorReasonCode – The reason why the agreement doesn't renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT, ACCEPTOR_RENEW_OPTED_OUT, NO_RENEWAL_TERM, and RENEWAL_LIMIT_EXHAUSTED.

      • InitialAgreementId – The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.

      • LicenseArn – The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.

      A proposer can use any combination of the preceding filters along with AgreementType, which is required.

      The following filter combinations are supported when the PartyType is Acceptor:

      • AgreementType

      • AgreementType + Status

      • AgreementType + EndTime

      • AgreementType + Status + EndTime

      • AgreementType + ResourceIdentifier

      • AgreementType + ResourceIdentifier + EndTime

      • AgreementType + ResourceIdentifier + Status

      • AgreementType + ResourceIdentifier + Status + EndTime

      • AgreementType + ResourceType

      • AgreementType + ResourceType + EndTime

      • AgreementType + OfferId

      • AgreementType + OfferId + EndTime

      • AgreementType + OfferId + Status

      • AgreementType + OfferId + Status + EndTime

      • AgreementType + OfferSetId

      • AgreementType + OfferSetId + EndTime

      • AgreementType + OfferSetId + Status

      • AgreementType + OfferSetId + Status + EndTime

      To filter by EndTime, you can use BeforeEndTime, AfterEndTime, or both.

      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, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).

      • PartyType – The party type of the caller. Use Proposer or Acceptor.

      • 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, 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.

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

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

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

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

      • AgreementType – The type of agreement. Supported value includes PurchaseAgreement.

      • OfferSetId – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

      • EndTimeBehaviorType – What happens to the agreement when it reaches its end date. Values include RENEW, REPLACE, and EXPIRE.

      • EndTimeBehaviorReasonCode – The reason why the agreement doesn't renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT, ACCEPTOR_RENEW_OPTED_OUT, NO_RENEWAL_TERM, and RENEWAL_LIMIT_EXHAUSTED.

      • InitialAgreementId – The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.

      • LicenseArn – The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.

      A proposer can use any combination of the preceding filters along with AgreementType, which is required.

      The following filter combinations are supported when the PartyType is Acceptor:

      • AgreementType

      • AgreementType + Status

      • AgreementType + EndTime

      • AgreementType + Status + EndTime

      • AgreementType + ResourceIdentifier

      • AgreementType + ResourceIdentifier + EndTime

      • AgreementType + ResourceIdentifier + Status

      • AgreementType + ResourceIdentifier + Status + EndTime

      • AgreementType + ResourceType

      • AgreementType + ResourceType + EndTime

      • AgreementType + OfferId

      • AgreementType + OfferId + EndTime

      • AgreementType + OfferId + Status

      • AgreementType + OfferId + Status + EndTime

      • AgreementType + OfferSetId

      • AgreementType + OfferSetId + EndTime

      • AgreementType + OfferSetId + Status

      • AgreementType + OfferSetId + Status + EndTime

      To filter by EndTime, you can use BeforeEndTime, AfterEndTime, or both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchAgreementsRequest.Builder filters(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, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).

      • PartyType – The party type of the caller. Use Proposer or Acceptor.

      • 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, 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.

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

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

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

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

      • AgreementType – The type of agreement. Supported value includes PurchaseAgreement.

      • OfferSetId – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

      • EndTimeBehaviorType – What happens to the agreement when it reaches its end date. Values include RENEW, REPLACE, and EXPIRE.

      • EndTimeBehaviorReasonCode – The reason why the agreement doesn't renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT, ACCEPTOR_RENEW_OPTED_OUT, NO_RENEWAL_TERM, and RENEWAL_LIMIT_EXHAUSTED.

      • InitialAgreementId – The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.

      • LicenseArn – The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.

      A proposer can use any combination of the preceding filters along with AgreementType, which is required.

      The following filter combinations are supported when the PartyType is Acceptor:

      • AgreementType

      • AgreementType + Status

      • AgreementType + EndTime

      • AgreementType + Status + EndTime

      • AgreementType + ResourceIdentifier

      • AgreementType + ResourceIdentifier + EndTime

      • AgreementType + ResourceIdentifier + Status

      • AgreementType + ResourceIdentifier + Status + EndTime

      • AgreementType + ResourceType

      • AgreementType + ResourceType + EndTime

      • AgreementType + OfferId

      • AgreementType + OfferId + EndTime

      • AgreementType + OfferId + Status

      • AgreementType + OfferId + Status + EndTime

      • AgreementType + OfferSetId

      • AgreementType + OfferSetId + EndTime

      • AgreementType + OfferSetId + Status

      • AgreementType + OfferSetId + Status + EndTime

      To filter by EndTime, you can use BeforeEndTime, AfterEndTime, or both.

      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, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).

      • PartyType – The party type of the caller. Use Proposer or Acceptor.

      • 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, 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.

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

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

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

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

      • AgreementType – The type of agreement. Supported value includes PurchaseAgreement.

      • OfferSetId – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

      • EndTimeBehaviorType – What happens to the agreement when it reaches its end date. Values include RENEW, REPLACE, and EXPIRE.

      • EndTimeBehaviorReasonCode – The reason why the agreement doesn't renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT, ACCEPTOR_RENEW_OPTED_OUT, NO_RENEWAL_TERM, and RENEWAL_LIMIT_EXHAUSTED.

      • InitialAgreementId – The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.

      • LicenseArn – The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.

      A proposer can use any combination of the preceding filters along with AgreementType, which is required.

      The following filter combinations are supported when the PartyType is Acceptor:

      • AgreementType

      • AgreementType + Status

      • AgreementType + EndTime

      • AgreementType + Status + EndTime

      • AgreementType + ResourceIdentifier

      • AgreementType + ResourceIdentifier + EndTime

      • AgreementType + ResourceIdentifier + Status

      • AgreementType + ResourceIdentifier + Status + EndTime

      • AgreementType + ResourceType

      • AgreementType + ResourceType + EndTime

      • AgreementType + OfferId

      • AgreementType + OfferId + EndTime

      • AgreementType + OfferId + Status

      • AgreementType + OfferId + Status + EndTime

      • AgreementType + OfferSetId

      • AgreementType + OfferSetId + EndTime

      • AgreementType + OfferSetId + Status

      • AgreementType + OfferSetId + Status + EndTime

      To filter by EndTime, you can use BeforeEndTime, AfterEndTime, or both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchAgreementsRequest.Builder filters(Consumer<Filter.Builder>... 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, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).

      • PartyType – The party type of the caller. Use Proposer or Acceptor.

      • 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, 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.

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

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

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

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

      • AgreementType – The type of agreement. Supported value includes PurchaseAgreement.

      • OfferSetId – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

      • EndTimeBehaviorType – What happens to the agreement when it reaches its end date. Values include RENEW, REPLACE, and EXPIRE.

      • EndTimeBehaviorReasonCode – The reason why the agreement doesn't renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT, ACCEPTOR_RENEW_OPTED_OUT, NO_RENEWAL_TERM, and RENEWAL_LIMIT_EXHAUSTED.

      • InitialAgreementId – The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.

      • LicenseArn – The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.

      A proposer can use any combination of the preceding filters along with AgreementType, which is required.

      The following filter combinations are supported when the PartyType is Acceptor:

      • AgreementType

      • AgreementType + Status

      • AgreementType + EndTime

      • AgreementType + Status + EndTime

      • AgreementType + ResourceIdentifier

      • AgreementType + ResourceIdentifier + EndTime

      • AgreementType + ResourceIdentifier + Status

      • AgreementType + ResourceIdentifier + Status + EndTime

      • AgreementType + ResourceType

      • AgreementType + ResourceType + EndTime

      • AgreementType + OfferId

      • AgreementType + OfferId + EndTime

      • AgreementType + OfferId + Status

      • AgreementType + OfferId + Status + EndTime

      • AgreementType + OfferSetId

      • AgreementType + OfferSetId + EndTime

      • AgreementType + OfferSetId + Status

      • AgreementType + OfferSetId + Status + EndTime

      To filter by EndTime, you can use BeforeEndTime, AfterEndTime, or both.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sort

      SearchAgreementsRequest.Builder sort(Sort sort)

      An object that contains the SortBy and SortOrder attributes. For SearchAgreements, SortBy supports EndTime for both party types, and StartTime and LastUpdateTime only when PartyType is Proposer. The default SortBy value is EndTime.

      Parameters:
      sort - An object that contains the SortBy and SortOrder attributes. For SearchAgreements, SortBy supports EndTime for both party types, and StartTime and LastUpdateTime only when PartyType is Proposer. The default SortBy value is EndTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sort

      default SearchAgreementsRequest.Builder sort(Consumer<Sort.Builder> sort)

      An object that contains the SortBy and SortOrder attributes. For SearchAgreements, SortBy supports EndTime for both party types, and StartTime and LastUpdateTime only when PartyType is Proposer. The default SortBy value is EndTime.

      This is a convenience method that creates an instance of the Sort.Builder avoiding the need to create one manually via Sort.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sort(Sort).

      Parameters:
      sort - a consumer that will call methods on Sort.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      SearchAgreementsRequest.Builder maxResults(Integer 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

      SearchAgreementsRequest.Builder nextToken(String 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.

    • overrideConfiguration

      SearchAgreementsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.