com.amazonaws.services.codeguruprofiler.model.ListProfileTimesRequest 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 listProfileTimesRequest.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListProfileTimesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The end time of the time range from which to list the profiles.
*
*/
private java.util.Date endTime;
/**
*
* The maximum number of profile time results returned by ListProfileTimes in paginated output. When
* this parameter is used, ListProfileTimes only returns maxResults results in a single
* page with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListProfileTimes request with the returned nextToken value.
*
*/
private Integer maxResults;
/**
*
* The nextToken value returned from a previous paginated ListProfileTimes 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 order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
*
*/
private String orderBy;
/**
*
* The aggregation period. This specifies the period during which an aggregation profile collects posted agent
* profiles for a profiling group. There are 3 valid values.
*
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
*
*/
private String period;
/**
*
* The name of the profiling group.
*
*/
private String profilingGroupName;
/**
*
* The start time of the time range from which to list the profiles.
*
*/
private java.util.Date startTime;
/**
*
* The end time of the time range from which to list the profiles.
*
*
* @param endTime
* The end time of the time range from which to list the profiles.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end time of the time range from which to list the profiles.
*
*
* @return The end time of the time range from which to list the profiles.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end time of the time range from which to list the profiles.
*
*
* @param endTime
* The end time of the time range from which to list the profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListProfileTimesRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The maximum number of profile time results returned by ListProfileTimes in paginated output. When
* this parameter is used, ListProfileTimes only returns maxResults results in a single
* page with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListProfileTimes request with the returned nextToken value.
*
*
* @param maxResults
* The maximum number of profile time results returned by ListProfileTimes in paginated output.
* When this parameter is used, ListProfileTimes only returns maxResults results in
* a single page with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListProfileTimes request with the returned
* nextToken value.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of profile time results returned by ListProfileTimes in paginated output. When
* this parameter is used, ListProfileTimes only returns maxResults results in a single
* page with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListProfileTimes request with the returned nextToken value.
*
*
* @return The maximum number of profile time results returned by ListProfileTimes in paginated output.
* When this parameter is used, ListProfileTimes only returns maxResults results
* in a single page with a nextToken response element. The remaining results of the initial
* request can be seen by sending another ListProfileTimes request with the returned
* nextToken value.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of profile time results returned by ListProfileTimes in paginated output. When
* this parameter is used, ListProfileTimes only returns maxResults results in a single
* page with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListProfileTimes request with the returned nextToken value.
*
*
* @param maxResults
* The maximum number of profile time results returned by ListProfileTimes in paginated output.
* When this parameter is used, ListProfileTimes only returns maxResults results in
* a single page with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListProfileTimes request with the returned
* nextToken value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListProfileTimesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The nextToken value returned from a previous paginated ListProfileTimes 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 ListProfileTimes 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 ListProfileTimes 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 ListProfileTimes 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 ListProfileTimes 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 ListProfileTimes 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 ListProfileTimesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
*
*
* @param orderBy
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
* @see OrderBy
*/
public void setOrderBy(String orderBy) {
this.orderBy = orderBy;
}
/**
*
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
*
*
* @return The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults
* to TIMESTAMP_DESCENDING.
* @see OrderBy
*/
public String getOrderBy() {
return this.orderBy;
}
/**
*
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
*
*
* @param orderBy
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrderBy
*/
public ListProfileTimesRequest withOrderBy(String orderBy) {
setOrderBy(orderBy);
return this;
}
/**
*
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
*
*
* @param orderBy
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
* TIMESTAMP_DESCENDING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrderBy
*/
public ListProfileTimesRequest withOrderBy(OrderBy orderBy) {
this.orderBy = orderBy.toString();
return this;
}
/**
*
* The aggregation period. This specifies the period during which an aggregation profile collects posted agent
* profiles for a profiling group. There are 3 valid values.
*
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
*
*
* @param period
* The aggregation period. This specifies the period during which an aggregation profile collects posted
* agent profiles for a profiling group. There are 3 valid values.
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
* @see AggregationPeriod
*/
public void setPeriod(String period) {
this.period = period;
}
/**
*
* The aggregation period. This specifies the period during which an aggregation profile collects posted agent
* profiles for a profiling group. There are 3 valid values.
*
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
*
*
* @return The aggregation period. This specifies the period during which an aggregation profile collects posted
* agent profiles for a profiling group. There are 3 valid values.
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
* @see AggregationPeriod
*/
public String getPeriod() {
return this.period;
}
/**
*
* The aggregation period. This specifies the period during which an aggregation profile collects posted agent
* profiles for a profiling group. There are 3 valid values.
*
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
*
*
* @param period
* The aggregation period. This specifies the period during which an aggregation profile collects posted
* agent profiles for a profiling group. There are 3 valid values.
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AggregationPeriod
*/
public ListProfileTimesRequest withPeriod(String period) {
setPeriod(period);
return this;
}
/**
*
* The aggregation period. This specifies the period during which an aggregation profile collects posted agent
* profiles for a profiling group. There are 3 valid values.
*
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
*
*
* @param period
* The aggregation period. This specifies the period during which an aggregation profile collects posted
* agent profiles for a profiling group. There are 3 valid values.
*
* -
*
* P1D — 1 day
*
*
* -
*
* PT1H — 1 hour
*
*
* -
*
* PT5M — 5 minutes
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AggregationPeriod
*/
public ListProfileTimesRequest withPeriod(AggregationPeriod period) {
this.period = period.toString();
return this;
}
/**
*
* The name of the profiling group.
*
*
* @param profilingGroupName
* The name of the profiling group.
*/
public void setProfilingGroupName(String profilingGroupName) {
this.profilingGroupName = profilingGroupName;
}
/**
*
* The name of the profiling group.
*
*
* @return The name of the profiling group.
*/
public String getProfilingGroupName() {
return this.profilingGroupName;
}
/**
*
* The name of the profiling group.
*
*
* @param profilingGroupName
* The name of the profiling group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListProfileTimesRequest withProfilingGroupName(String profilingGroupName) {
setProfilingGroupName(profilingGroupName);
return this;
}
/**
*
* The start time of the time range from which to list the profiles.
*
*
* @param startTime
* The start time of the time range from which to list the profiles.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The start time of the time range from which to list the profiles.
*
*
* @return The start time of the time range from which to list the profiles.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The start time of the time range from which to list the profiles.
*
*
* @param startTime
* The start time of the time range from which to list the profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListProfileTimesRequest 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 (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 (getOrderBy() != null)
sb.append("OrderBy: ").append(getOrderBy()).append(",");
if (getPeriod() != null)
sb.append("Period: ").append(getPeriod()).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 ListProfileTimesRequest == false)
return false;
ListProfileTimesRequest other = (ListProfileTimesRequest) obj;
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.getOrderBy() == null ^ this.getOrderBy() == null)
return false;
if (other.getOrderBy() != null && other.getOrderBy().equals(this.getOrderBy()) == false)
return false;
if (other.getPeriod() == null ^ this.getPeriod() == null)
return false;
if (other.getPeriod() != null && other.getPeriod().equals(this.getPeriod()) == 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 + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getOrderBy() == null) ? 0 : getOrderBy().hashCode());
hashCode = prime * hashCode + ((getPeriod() == null) ? 0 : getPeriod().hashCode());
hashCode = prime * hashCode + ((getProfilingGroupName() == null) ? 0 : getProfilingGroupName().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
return hashCode;
}
@Override
public ListProfileTimesRequest clone() {
return (ListProfileTimesRequest) super.clone();
}
}