com.amazonaws.services.imagebuilder.model.ListImagesRequest Maven / Gradle / Ivy
/*
* 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.imagebuilder.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 ListImagesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The owner defines which images you want to list. By default, this request will only show images owned by your
* account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those
* images that have been shared with you by other customers.
*
*/
private String owner;
/**
*
* Use the following filters to streamline results:
*
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
*
*/
private java.util.List filters;
/**
*
* Requests a list of images with a specific recipe name.
*
*/
private Boolean byName;
/**
*
* The maximum items to return in a request.
*
*/
private Integer maxResults;
/**
*
* A token to specify where to start paginating. This is the nextToken from a previously truncated response.
*
*/
private String nextToken;
/**
*
* Includes deprecated images in the response list.
*
*/
private Boolean includeDeprecated;
/**
*
* The owner defines which images you want to list. By default, this request will only show images owned by your
* account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those
* images that have been shared with you by other customers.
*
*
* @param owner
* The owner defines which images you want to list. By default, this request will only show images owned by
* your account. You can use this field to specify if you want to view images owned by yourself, by Amazon,
* or those images that have been shared with you by other customers.
* @see Ownership
*/
public void setOwner(String owner) {
this.owner = owner;
}
/**
*
* The owner defines which images you want to list. By default, this request will only show images owned by your
* account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those
* images that have been shared with you by other customers.
*
*
* @return The owner defines which images you want to list. By default, this request will only show images owned by
* your account. You can use this field to specify if you want to view images owned by yourself, by Amazon,
* or those images that have been shared with you by other customers.
* @see Ownership
*/
public String getOwner() {
return this.owner;
}
/**
*
* The owner defines which images you want to list. By default, this request will only show images owned by your
* account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those
* images that have been shared with you by other customers.
*
*
* @param owner
* The owner defines which images you want to list. By default, this request will only show images owned by
* your account. You can use this field to specify if you want to view images owned by yourself, by Amazon,
* or those images that have been shared with you by other customers.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Ownership
*/
public ListImagesRequest withOwner(String owner) {
setOwner(owner);
return this;
}
/**
*
* The owner defines which images you want to list. By default, this request will only show images owned by your
* account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those
* images that have been shared with you by other customers.
*
*
* @param owner
* The owner defines which images you want to list. By default, this request will only show images owned by
* your account. You can use this field to specify if you want to view images owned by yourself, by Amazon,
* or those images that have been shared with you by other customers.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Ownership
*/
public ListImagesRequest withOwner(Ownership owner) {
this.owner = owner.toString();
return this;
}
/**
*
* Use the following filters to streamline results:
*
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
*
*
* @return Use the following filters to streamline results:
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* Use the following filters to streamline results:
*
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
*
*
* @param filters
* Use the following filters to streamline results:
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* Use the following filters to streamline results:
*
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
*
*
* 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
* Use the following filters to streamline results:
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* Use the following filters to streamline results:
*
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
*
*
* @param filters
* Use the following filters to streamline results:
*
* -
*
* name
*
*
* -
*
* osVersion
*
*
* -
*
* platform
*
*
* -
*
* type
*
*
* -
*
* version
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* Requests a list of images with a specific recipe name.
*
*
* @param byName
* Requests a list of images with a specific recipe name.
*/
public void setByName(Boolean byName) {
this.byName = byName;
}
/**
*
* Requests a list of images with a specific recipe name.
*
*
* @return Requests a list of images with a specific recipe name.
*/
public Boolean getByName() {
return this.byName;
}
/**
*
* Requests a list of images with a specific recipe name.
*
*
* @param byName
* Requests a list of images with a specific recipe name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withByName(Boolean byName) {
setByName(byName);
return this;
}
/**
*
* Requests a list of images with a specific recipe name.
*
*
* @return Requests a list of images with a specific recipe name.
*/
public Boolean isByName() {
return this.byName;
}
/**
*
* The maximum items to return in a request.
*
*
* @param maxResults
* The maximum items to return in a request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum items to return in a request.
*
*
* @return The maximum items to return in a request.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum items to return in a request.
*
*
* @param maxResults
* The maximum items to return in a request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* A token to specify where to start paginating. This is the nextToken from a previously truncated response.
*
*
* @param nextToken
* A token to specify where to start paginating. This is the nextToken from a previously truncated response.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A token to specify where to start paginating. This is the nextToken from a previously truncated response.
*
*
* @return A token to specify where to start paginating. This is the nextToken from a previously truncated response.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A token to specify where to start paginating. This is the nextToken from a previously truncated response.
*
*
* @param nextToken
* A token to specify where to start paginating. This is the nextToken from a previously truncated response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Includes deprecated images in the response list.
*
*
* @param includeDeprecated
* Includes deprecated images in the response list.
*/
public void setIncludeDeprecated(Boolean includeDeprecated) {
this.includeDeprecated = includeDeprecated;
}
/**
*
* Includes deprecated images in the response list.
*
*
* @return Includes deprecated images in the response list.
*/
public Boolean getIncludeDeprecated() {
return this.includeDeprecated;
}
/**
*
* Includes deprecated images in the response list.
*
*
* @param includeDeprecated
* Includes deprecated images in the response list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withIncludeDeprecated(Boolean includeDeprecated) {
setIncludeDeprecated(includeDeprecated);
return this;
}
/**
*
* Includes deprecated images in the response list.
*
*
* @return Includes deprecated images in the response list.
*/
public Boolean isIncludeDeprecated() {
return this.includeDeprecated;
}
/**
* 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 (getOwner() != null)
sb.append("Owner: ").append(getOwner()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getByName() != null)
sb.append("ByName: ").append(getByName()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getIncludeDeprecated() != null)
sb.append("IncludeDeprecated: ").append(getIncludeDeprecated());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListImagesRequest == false)
return false;
ListImagesRequest other = (ListImagesRequest) obj;
if (other.getOwner() == null ^ this.getOwner() == null)
return false;
if (other.getOwner() != null && other.getOwner().equals(this.getOwner()) == 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.getByName() == null ^ this.getByName() == null)
return false;
if (other.getByName() != null && other.getByName().equals(this.getByName()) == 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.getIncludeDeprecated() == null ^ this.getIncludeDeprecated() == null)
return false;
if (other.getIncludeDeprecated() != null && other.getIncludeDeprecated().equals(this.getIncludeDeprecated()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getOwner() == null) ? 0 : getOwner().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getByName() == null) ? 0 : getByName().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getIncludeDeprecated() == null) ? 0 : getIncludeDeprecated().hashCode());
return hashCode;
}
@Override
public ListImagesRequest clone() {
return (ListImagesRequest) super.clone();
}
}