com.amazonaws.services.marketplaceagreement.model.SearchAgreementsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-marketplaceagreement Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.marketplaceagreement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SearchAgreementsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The catalog in which the agreement was created.
*
*/
private String catalog;
/**
*
* 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.
*
*
*
*/
private java.util.List filters;
/**
*
* The maximum number of agreements to return in the response.
*
*/
private Integer maxResults;
/**
*
* A token to specify where to start pagination.
*
*/
private String nextToken;
/**
*
* An object that contains the SortBy and SortOrder attributes.
*
*/
private Sort sort;
/**
*
* The catalog in which the agreement was created.
*
*
* @param catalog
* The catalog in which the agreement was created.
*/
public void setCatalog(String catalog) {
this.catalog = catalog;
}
/**
*
* The catalog in which the agreement was created.
*
*
* @return The catalog in which the agreement was created.
*/
public String getCatalog() {
return this.catalog;
}
/**
*
* The catalog in which the agreement was created.
*
*
* @param catalog
* The catalog in which the agreement was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchAgreementsRequest withCatalog(String catalog) {
setCatalog(catalog);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public java.util.List getFilters() {
return 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.
*
*
*
*
* @param 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.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(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.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchAgreementsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchAgreementsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of agreements to return in the response.
*
*
* @param maxResults
* The maximum number of agreements to return in the response.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of agreements to return in the response.
*
*
* @return The maximum number of agreements to return in the response.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of agreements to return in the response.
*
*
* @param maxResults
* The maximum number of agreements to return in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchAgreementsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* A token to specify where to start pagination.
*
*
* @param nextToken
* A token to specify where to start pagination.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A token to specify where to start pagination.
*
*
* @return A token to specify where to start pagination.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A token to specify where to start pagination.
*
*
* @param nextToken
* A token to specify where to start pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchAgreementsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* An object that contains the SortBy and SortOrder attributes.
*
*
* @param sort
* An object that contains the SortBy and SortOrder attributes.
*/
public void setSort(Sort sort) {
this.sort = sort;
}
/**
*
* An object that contains the SortBy and SortOrder attributes.
*
*
* @return An object that contains the SortBy and SortOrder attributes.
*/
public Sort getSort() {
return this.sort;
}
/**
*
* An object that contains the SortBy and SortOrder attributes.
*
*
* @param sort
* An object that contains the SortBy and SortOrder attributes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchAgreementsRequest withSort(Sort sort) {
setSort(sort);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCatalog() != null)
sb.append("Catalog: ").append(getCatalog()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getSort() != null)
sb.append("Sort: ").append(getSort());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchAgreementsRequest == false)
return false;
SearchAgreementsRequest other = (SearchAgreementsRequest) obj;
if (other.getCatalog() == null ^ this.getCatalog() == null)
return false;
if (other.getCatalog() != null && other.getCatalog().equals(this.getCatalog()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getSort() == null ^ this.getSort() == null)
return false;
if (other.getSort() != null && other.getSort().equals(this.getSort()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCatalog() == null) ? 0 : getCatalog().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getSort() == null) ? 0 : getSort().hashCode());
return hashCode;
}
@Override
public SearchAgreementsRequest clone() {
return (SearchAgreementsRequest) super.clone();
}
}