com.amazonaws.services.marketplaceentitlement.model.GetEntitlementsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-marketplaceentitlement 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.marketplaceentitlement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetEntitlementsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS
* Marketplace when the product listing is created.
*
*/
private String productCode;
/**
*
* Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described
* as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and
* then intersected for each filter key.
*
*/
private java.util.Map> filter;
/**
*
* For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
*
*/
private String nextToken;
/**
*
* The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken
* field in subsequent calls to GetEntitlements.
*
*/
private Integer maxResults;
/**
*
* Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS
* Marketplace when the product listing is created.
*
*
* @param productCode
* Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided
* by AWS Marketplace when the product listing is created.
*/
public void setProductCode(String productCode) {
this.productCode = productCode;
}
/**
*
* Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS
* Marketplace when the product listing is created.
*
*
* @return Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided
* by AWS Marketplace when the product listing is created.
*/
public String getProductCode() {
return this.productCode;
}
/**
*
* Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS
* Marketplace when the product listing is created.
*
*
* @param productCode
* Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided
* by AWS Marketplace when the product listing is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntitlementsRequest withProductCode(String productCode) {
setProductCode(productCode);
return this;
}
/**
*
* Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described
* as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and
* then intersected for each filter key.
*
*
* @return Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are
* described as keys mapped to a lists of values. Filtered requests are unioned for each value in the
* value list, and then intersected for each filter key.
*/
public java.util.Map> getFilter() {
return filter;
}
/**
*
* Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described
* as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and
* then intersected for each filter key.
*
*
* @param filter
* Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are
* described as keys mapped to a lists of values. Filtered requests are unioned for each value in the
* value list, and then intersected for each filter key.
*/
public void setFilter(java.util.Map> filter) {
this.filter = filter;
}
/**
*
* Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described
* as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and
* then intersected for each filter key.
*
*
* @param filter
* Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are
* described as keys mapped to a lists of values. Filtered requests are unioned for each value in the
* value list, and then intersected for each filter key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntitlementsRequest withFilter(java.util.Map> filter) {
setFilter(filter);
return this;
}
/**
* Add a single Filter entry
*
* @see GetEntitlementsRequest#withFilter
* @returns a reference to this object so that method calls can be chained together.
*/
public GetEntitlementsRequest addFilterEntry(String key, java.util.List value) {
if (null == this.filter) {
this.filter = new java.util.HashMap>();
}
if (this.filter.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.filter.put(key, value);
return this;
}
/**
* Removes all the entries added into Filter.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntitlementsRequest clearFilterEntries() {
this.filter = null;
return this;
}
/**
*
* For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
*
*
* @param nextToken
* For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
*
*
* @return For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
*
*
* @param nextToken
* For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntitlementsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken
* field in subsequent calls to GetEntitlements.
*
*
* @param maxResults
* The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the
* NextToken field in subsequent calls to GetEntitlements.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken
* field in subsequent calls to GetEntitlements.
*
*
* @return The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the
* NextToken field in subsequent calls to GetEntitlements.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken
* field in subsequent calls to GetEntitlements.
*
*
* @param maxResults
* The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the
* NextToken field in subsequent calls to GetEntitlements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntitlementsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getProductCode() != null)
sb.append("ProductCode: ").append(getProductCode()).append(",");
if (getFilter() != null)
sb.append("Filter: ").append(getFilter()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetEntitlementsRequest == false)
return false;
GetEntitlementsRequest other = (GetEntitlementsRequest) obj;
if (other.getProductCode() == null ^ this.getProductCode() == null)
return false;
if (other.getProductCode() != null && other.getProductCode().equals(this.getProductCode()) == false)
return false;
if (other.getFilter() == null ^ this.getFilter() == null)
return false;
if (other.getFilter() != null && other.getFilter().equals(this.getFilter()) == 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.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getProductCode() == null) ? 0 : getProductCode().hashCode());
hashCode = prime * hashCode + ((getFilter() == null) ? 0 : getFilter().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public GetEntitlementsRequest clone() {
return (GetEntitlementsRequest) super.clone();
}
}