com.amazonaws.services.codeguruprofiler.model.ListFindingsReportsRequest 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 ListFindingsReportsRequest.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListFindingsReportsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False, analysis
* data is returned from smaller time windows (for example, one hour).
*
*/
private Boolean dailyReportsOnly;
/**
*
* The end time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*/
private java.util.Date endTime;
/**
*
* The maximum number of report results returned by ListFindingsReports in paginated output. When this
* parameter is used, ListFindingsReports 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 ListFindingsReports request with the returned nextToken value.
*
*/
private Integer maxResults;
/**
*
* The nextToken value returned from a previous paginated ListFindingsReportsRequest
* 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;
/**
*
* The name of the profiling group from which to search for analysis data.
*
*/
private String profilingGroupName;
/**
*
* The start time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*/
private java.util.Date startTime;
/**
*
* A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False, analysis
* data is returned from smaller time windows (for example, one hour).
*
*
* @param dailyReportsOnly
* A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False,
* analysis data is returned from smaller time windows (for example, one hour).
*/
public void setDailyReportsOnly(Boolean dailyReportsOnly) {
this.dailyReportsOnly = dailyReportsOnly;
}
/**
*
* A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False, analysis
* data is returned from smaller time windows (for example, one hour).
*
*
* @return A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False,
* analysis data is returned from smaller time windows (for example, one hour).
*/
public Boolean getDailyReportsOnly() {
return this.dailyReportsOnly;
}
/**
*
* A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False, analysis
* data is returned from smaller time windows (for example, one hour).
*
*
* @param dailyReportsOnly
* A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False,
* analysis data is returned from smaller time windows (for example, one hour).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFindingsReportsRequest withDailyReportsOnly(Boolean dailyReportsOnly) {
setDailyReportsOnly(dailyReportsOnly);
return this;
}
/**
*
* A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False, analysis
* data is returned from smaller time windows (for example, one hour).
*
*
* @return A Boolean value indicating whether to only return reports from daily profiles. If set to
* True, only analysis data from daily profiles is returned. If set to False,
* analysis data is returned from smaller time windows (for example, one hour).
*/
public Boolean isDailyReportsOnly() {
return this.dailyReportsOnly;
}
/**
*
* The end time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*
* @param endTime
* The end time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*
* @return The end time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*
* @param endTime
* The end time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFindingsReportsRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The maximum number of report results returned by ListFindingsReports in paginated output. When this
* parameter is used, ListFindingsReports 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 ListFindingsReports request with the returned nextToken value.
*
*
* @param maxResults
* The maximum number of report results returned by ListFindingsReports in paginated output.
* When this parameter is used, ListFindingsReports 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 ListFindingsReports request with the returned
* nextToken value.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of report results returned by ListFindingsReports in paginated output. When this
* parameter is used, ListFindingsReports 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 ListFindingsReports request with the returned nextToken value.
*
*
* @return The maximum number of report results returned by ListFindingsReports in paginated output.
* When this parameter is used, ListFindingsReports 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 ListFindingsReports request with the
* returned nextToken value.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of report results returned by ListFindingsReports in paginated output. When this
* parameter is used, ListFindingsReports 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 ListFindingsReports request with the returned nextToken value.
*
*
* @param maxResults
* The maximum number of report results returned by ListFindingsReports in paginated output.
* When this parameter is used, ListFindingsReports 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 ListFindingsReports request with the returned
* nextToken value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFindingsReportsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The nextToken value returned from a previous paginated ListFindingsReportsRequest
* 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
* ListFindingsReportsRequest 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 ListFindingsReportsRequest
* 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
* ListFindingsReportsRequest 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 ListFindingsReportsRequest
* 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
* ListFindingsReportsRequest 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 ListFindingsReportsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The name of the profiling group from which to search for analysis data.
*
*
* @param profilingGroupName
* The name of the profiling group from which to search for analysis data.
*/
public void setProfilingGroupName(String profilingGroupName) {
this.profilingGroupName = profilingGroupName;
}
/**
*
* The name of the profiling group from which to search for analysis data.
*
*
* @return The name of the profiling group from which to search for analysis data.
*/
public String getProfilingGroupName() {
return this.profilingGroupName;
}
/**
*
* The name of the profiling group from which to search for analysis data.
*
*
* @param profilingGroupName
* The name of the profiling group from which to search for analysis data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFindingsReportsRequest withProfilingGroupName(String profilingGroupName) {
setProfilingGroupName(profilingGroupName);
return this;
}
/**
*
* The start time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*
* @param startTime
* The start time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The start time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*
* @return The start time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The start time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*
*
* @param startTime
* The start time of the profile to get analysis data about. You must specify startTime and
* endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
* represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFindingsReportsRequest withStartTime(java.util.Date startTime) {
setStartTime(startTime);
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 (getDailyReportsOnly() != null)
sb.append("DailyReportsOnly: ").append(getDailyReportsOnly()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getProfilingGroupName() != null)
sb.append("ProfilingGroupName: ").append(getProfilingGroupName()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListFindingsReportsRequest == false)
return false;
ListFindingsReportsRequest other = (ListFindingsReportsRequest) obj;
if (other.getDailyReportsOnly() == null ^ this.getDailyReportsOnly() == null)
return false;
if (other.getDailyReportsOnly() != null && other.getDailyReportsOnly().equals(this.getDailyReportsOnly()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == 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.getProfilingGroupName() == null ^ this.getProfilingGroupName() == null)
return false;
if (other.getProfilingGroupName() != null && other.getProfilingGroupName().equals(this.getProfilingGroupName()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDailyReportsOnly() == null) ? 0 : getDailyReportsOnly().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getProfilingGroupName() == null) ? 0 : getProfilingGroupName().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
return hashCode;
}
@Override
public ListFindingsReportsRequest clone() {
return (ListFindingsReportsRequest) super.clone();
}
}