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>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchAgreementsRequest.Builder,SearchAgreementsRequest>
      Specified by:
      toBuilder in class MarketplaceAgreementRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.