com.amazonaws.services.codeguruprofiler.model.ListProfilingGroupsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codeguruprofiler 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.codeguruprofiler.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The structure representing the listProfilingGroupsRequest.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListProfilingGroupsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A Boolean value indicating whether to include a description. If true, then a list of
* ProfilingGroupDescription objects that contain detailed information about profiling groups is
* returned. If false, then a list of profiling group names is returned.
*
*/
private Boolean includeDescription;
/**
*
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated output.
* When this parameter is used, ListProfilingGroups only returns maxResults results in a
* single page along with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListProfilingGroups request with the returned nextToken
* value.
*
*/
private Integer maxResults;
/**
*
* The nextToken value returned from a previous paginated ListProfilingGroups request
* where maxResults was used and the results exceeded the value of that parameter. Pagination continues
* from the end of the previous results that returned the nextToken value.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*/
private String nextToken;
/**
*
* A Boolean value indicating whether to include a description. If true, then a list of
* ProfilingGroupDescription objects that contain detailed information about profiling groups is
* returned. If false, then a list of profiling group names is returned.
*
*
* @param includeDescription
* A Boolean value indicating whether to include a description. If true, then a
* list of
* ProfilingGroupDescription objects that contain detailed information about profiling
* groups is returned. If false, then a list of profiling group names is returned.
*/
public void setIncludeDescription(Boolean includeDescription) {
this.includeDescription = includeDescription;
}
/**
*
* A Boolean value indicating whether to include a description. If true, then a list of
* ProfilingGroupDescription objects that contain detailed information about profiling groups is
* returned. If false, then a list of profiling group names is returned.
*
*
* @return A Boolean value indicating whether to include a description. If true, then a
* list of
* ProfilingGroupDescription objects that contain detailed information about profiling
* groups is returned. If false, then a list of profiling group names is returned.
*/
public Boolean getIncludeDescription() {
return this.includeDescription;
}
/**
*
* A Boolean value indicating whether to include a description. If true, then a list of
* ProfilingGroupDescription objects that contain detailed information about profiling groups is
* returned. If false, then a list of profiling group names is returned.
*
*
* @param includeDescription
* A Boolean value indicating whether to include a description. If true, then a
* list of
* ProfilingGroupDescription objects that contain detailed information about profiling
* groups is returned. If false, then a list of profiling group names is returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListProfilingGroupsRequest withIncludeDescription(Boolean includeDescription) {
setIncludeDescription(includeDescription);
return this;
}
/**
*
* A Boolean value indicating whether to include a description. If true, then a list of
* ProfilingGroupDescription objects that contain detailed information about profiling groups is
* returned. If false, then a list of profiling group names is returned.
*
*
* @return A Boolean value indicating whether to include a description. If true, then a
* list of
* ProfilingGroupDescription objects that contain detailed information about profiling
* groups is returned. If false, then a list of profiling group names is returned.
*/
public Boolean isIncludeDescription() {
return this.includeDescription;
}
/**
*
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated output.
* When this parameter is used, ListProfilingGroups only returns maxResults results in a
* single page along with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListProfilingGroups request with the returned nextToken
* value.
*
*
* @param maxResults
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated
* output. When this parameter is used, ListProfilingGroups only returns maxResults
* results in a single page along with a nextToken response element. The remaining results of
* the initial request can be seen by sending another ListProfilingGroups request with the
* returned nextToken value.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated output.
* When this parameter is used, ListProfilingGroups only returns maxResults results in a
* single page along with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListProfilingGroups request with the returned nextToken
* value.
*
*
* @return The maximum number of profiling groups results returned by ListProfilingGroups in paginated
* output. When this parameter is used, ListProfilingGroups only returns
* maxResults results in a single page along with a nextToken response element.
* The remaining results of the initial request can be seen by sending another
* ListProfilingGroups request with the returned nextToken value.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated output.
* When this parameter is used, ListProfilingGroups only returns maxResults results in a
* single page along with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListProfilingGroups request with the returned nextToken
* value.
*
*
* @param maxResults
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated
* output. When this parameter is used, ListProfilingGroups only returns maxResults
* results in a single page along with a nextToken response element. The remaining results of
* the initial request can be seen by sending another ListProfilingGroups request with the
* returned nextToken value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListProfilingGroupsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The nextToken value returned from a previous paginated ListProfilingGroups request
* where maxResults was used and the results exceeded the value of that parameter. Pagination continues
* from the end of the previous results that returned the nextToken value.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a previous paginated ListProfilingGroups
* request where maxResults was used and the results exceeded the value of that parameter.
* Pagination continues from the end of the previous results that returned the nextToken value.
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value returned from a previous paginated ListProfilingGroups request
* where maxResults was used and the results exceeded the value of that parameter. Pagination continues
* from the end of the previous results that returned the nextToken value.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @return The nextToken value returned from a previous paginated ListProfilingGroups
* request where maxResults was used and the results exceeded the value of that parameter.
* Pagination continues from the end of the previous results that returned the nextToken value.
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value returned from a previous paginated ListProfilingGroups request
* where maxResults was used and the results exceeded the value of that parameter. Pagination continues
* from the end of the previous results that returned the nextToken value.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a previous paginated ListProfilingGroups
* request where maxResults was used and the results exceeded the value of that parameter.
* Pagination continues from the end of the previous results that returned the nextToken value.
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListProfilingGroupsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getIncludeDescription() != null)
sb.append("IncludeDescription: ").append(getIncludeDescription()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListProfilingGroupsRequest == false)
return false;
ListProfilingGroupsRequest other = (ListProfilingGroupsRequest) obj;
if (other.getIncludeDescription() == null ^ this.getIncludeDescription() == null)
return false;
if (other.getIncludeDescription() != null && other.getIncludeDescription().equals(this.getIncludeDescription()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIncludeDescription() == null) ? 0 : getIncludeDescription().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public ListProfilingGroupsRequest clone() {
return (ListProfilingGroupsRequest) super.clone();
}
}