com.amazonaws.services.codeguruprofiler.model.GetProfileRequest 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 getProfileRequest.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetProfileRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The format of the returned profiling data. The format maps to the Accept and
* Content-Type headers of the HTTP request. You can specify one of the following: or the default .
*
*
*
* <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*
*/
private String accept;
/**
*
* The end time of the requested profile. Specify 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.
*
*
* If you specify endTime, then you must also specify period or startTime,
* but not both.
*
*/
private java.util.Date endTime;
/**
*
* The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if
* CodeGuru Profiler finds a method A, which calls method B, which calls method
* C, which calls method D, then the depth is 4. If the maxDepth is set to 2,
* then the aggregated profile contains representations of methods A and B.
*
*/
private Integer maxDepth;
/**
*
* Used with startTime or endTime to specify the time range for the returned aggregated
* profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
*
*
*
* <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
*
*/
private String period;
/**
*
* The name of the profiling group to get.
*
*/
private String profilingGroupName;
/**
*
* The start time of the profile to get. Specify 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.
*
*
*
* <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
*
*/
private java.util.Date startTime;
/**
*
* The format of the returned profiling data. The format maps to the Accept and
* Content-Type headers of the HTTP request. You can specify one of the following: or the default .
*
*
*
* <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*
*
* @param accept
* The format of the returned profiling data. The format maps to the Accept and
* Content-Type headers of the HTTP request. You can specify one of the following: or the
* default .
*
* <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*/
public void setAccept(String accept) {
this.accept = accept;
}
/**
*
* The format of the returned profiling data. The format maps to the Accept and
* Content-Type headers of the HTTP request. You can specify one of the following: or the default .
*
*
*
* <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*
*
* @return The format of the returned profiling data. The format maps to the Accept and
* Content-Type headers of the HTTP request. You can specify one of the following: or the
* default .
*
* <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*/
public String getAccept() {
return this.accept;
}
/**
*
* The format of the returned profiling data. The format maps to the Accept and
* Content-Type headers of the HTTP request. You can specify one of the following: or the default .
*
*
*
* <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*
*
* @param accept
* The format of the returned profiling data. The format maps to the Accept and
* Content-Type headers of the HTTP request. You can specify one of the following: or the
* default .
*
*
* <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetProfileRequest withAccept(String accept) {
setAccept(accept);
return this;
}
/**
*
* The end time of the requested profile. Specify 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.
*
*
* If you specify endTime, then you must also specify period or startTime,
* but not both.
*
*
* @param endTime
* The end time of the requested profile. Specify 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.
*
* If you specify endTime, then you must also specify period or
* startTime, but not both.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end time of the requested profile. Specify 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.
*
*
* If you specify endTime, then you must also specify period or startTime,
* but not both.
*
*
* @return The end time of the requested profile. Specify 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.
*
* If you specify endTime, then you must also specify period or
* startTime, but not both.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end time of the requested profile. Specify 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.
*
*
* If you specify endTime, then you must also specify period or startTime,
* but not both.
*
*
* @param endTime
* The end time of the requested profile. Specify 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.
*
* If you specify endTime, then you must also specify period or
* startTime, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetProfileRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if
* CodeGuru Profiler finds a method A, which calls method B, which calls method
* C, which calls method D, then the depth is 4. If the maxDepth is set to 2,
* then the aggregated profile contains representations of methods A and B.
*
*
* @param maxDepth
* The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if
* CodeGuru Profiler finds a method A, which calls method B, which calls method
* C, which calls method D, then the depth is 4. If the maxDepth is
* set to 2, then the aggregated profile contains representations of methods A and
* B.
*/
public void setMaxDepth(Integer maxDepth) {
this.maxDepth = maxDepth;
}
/**
*
* The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if
* CodeGuru Profiler finds a method A, which calls method B, which calls method
* C, which calls method D, then the depth is 4. If the maxDepth is set to 2,
* then the aggregated profile contains representations of methods A and B.
*
*
* @return The maximum depth of the stacks in the code that is represented in the aggregated profile. For example,
* if CodeGuru Profiler finds a method A, which calls method B, which calls method
* C, which calls method D, then the depth is 4. If the maxDepth is
* set to 2, then the aggregated profile contains representations of methods A and
* B.
*/
public Integer getMaxDepth() {
return this.maxDepth;
}
/**
*
* The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if
* CodeGuru Profiler finds a method A, which calls method B, which calls method
* C, which calls method D, then the depth is 4. If the maxDepth is set to 2,
* then the aggregated profile contains representations of methods A and B.
*
*
* @param maxDepth
* The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if
* CodeGuru Profiler finds a method A, which calls method B, which calls method
* C, which calls method D, then the depth is 4. If the maxDepth is
* set to 2, then the aggregated profile contains representations of methods A and
* B.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetProfileRequest withMaxDepth(Integer maxDepth) {
setMaxDepth(maxDepth);
return this;
}
/**
*
* Used with startTime or endTime to specify the time range for the returned aggregated
* profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
*
*
*
* <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
*
*
* @param period
* Used with startTime or endTime to specify the time range for the returned
* aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
*
* <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
*/
public void setPeriod(String period) {
this.period = period;
}
/**
*
* Used with startTime or endTime to specify the time range for the returned aggregated
* profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
*
*
*
* <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
*
*
* @return Used with startTime or endTime to specify the time range for the returned
* aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
*
* <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
*/
public String getPeriod() {
return this.period;
}
/**
*
* Used with startTime or endTime to specify the time range for the returned aggregated
* profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
*
*
*
* <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
*
*
* @param period
* Used with startTime or endTime to specify the time range for the returned
* aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
*
*
* <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetProfileRequest withPeriod(String period) {
setPeriod(period);
return this;
}
/**
*
* The name of the profiling group to get.
*
*
* @param profilingGroupName
* The name of the profiling group to get.
*/
public void setProfilingGroupName(String profilingGroupName) {
this.profilingGroupName = profilingGroupName;
}
/**
*
* The name of the profiling group to get.
*
*
* @return The name of the profiling group to get.
*/
public String getProfilingGroupName() {
return this.profilingGroupName;
}
/**
*
* The name of the profiling group to get.
*
*
* @param profilingGroupName
* The name of the profiling group to get.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetProfileRequest withProfilingGroupName(String profilingGroupName) {
setProfilingGroupName(profilingGroupName);
return this;
}
/**
*
* The start time of the profile to get. Specify 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.
*
*
*
* <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
*
*
* @param startTime
* The start time of the profile to get. Specify 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.
*
* <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The start time of the profile to get. Specify 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.
*
*
*
* <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
*
*
* @return The start time of the profile to get. Specify 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.
*
* <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The start time of the profile to get. Specify 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.
*
*
*
* <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
*
*
* @param startTime
* The start time of the profile to get. Specify 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.
*
*
* <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetProfileRequest 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 (getAccept() != null)
sb.append("Accept: ").append(getAccept()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getMaxDepth() != null)
sb.append("MaxDepth: ").append(getMaxDepth()).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 GetProfileRequest == false)
return false;
GetProfileRequest other = (GetProfileRequest) obj;
if (other.getAccept() == null ^ this.getAccept() == null)
return false;
if (other.getAccept() != null && other.getAccept().equals(this.getAccept()) == 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.getMaxDepth() == null ^ this.getMaxDepth() == null)
return false;
if (other.getMaxDepth() != null && other.getMaxDepth().equals(this.getMaxDepth()) == 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 + ((getAccept() == null) ? 0 : getAccept().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getMaxDepth() == null) ? 0 : getMaxDepth().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 GetProfileRequest clone() {
return (GetProfileRequest) super.clone();
}
}