com.amazonaws.services.cloudtrail.model.ListQueriesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudtrail 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.cloudtrail.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 ListQueriesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
*
*/
private String eventDataStore;
/**
*
* A token you can use to get the next page of results.
*
*/
private String nextToken;
/**
*
* The maximum number of queries to show on a page.
*
*/
private Integer maxResults;
/**
*
* Use with EndTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*/
private java.util.Date startTime;
/**
*
* Use with StartTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*/
private java.util.Date endTime;
/**
*
* The status of queries that you want to return in results. Valid values for QueryStatus include
* QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or
* CANCELLED.
*
*/
private String queryStatus;
/**
*
* The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
*
*
* @param eventDataStore
* The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
*/
public void setEventDataStore(String eventDataStore) {
this.eventDataStore = eventDataStore;
}
/**
*
* The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
*
*
* @return The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
*/
public String getEventDataStore() {
return this.eventDataStore;
}
/**
*
* The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
*
*
* @param eventDataStore
* The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueriesRequest withEventDataStore(String eventDataStore) {
setEventDataStore(eventDataStore);
return this;
}
/**
*
* A token you can use to get the next page of results.
*
*
* @param nextToken
* A token you can use to get the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A token you can use to get the next page of results.
*
*
* @return A token you can use to get the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A token you can use to get the next page of results.
*
*
* @param nextToken
* A token you can use to get the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueriesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of queries to show on a page.
*
*
* @param maxResults
* The maximum number of queries to show on a page.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of queries to show on a page.
*
*
* @return The maximum number of queries to show on a page.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of queries to show on a page.
*
*
* @param maxResults
* The maximum number of queries to show on a page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueriesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* Use with EndTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*
* @param startTime
* Use with EndTime to bound a ListQueries request, and limit its results to only
* those queries run within a specified time period.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* Use with EndTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*
* @return Use with EndTime to bound a ListQueries request, and limit its results to only
* those queries run within a specified time period.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* Use with EndTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*
* @param startTime
* Use with EndTime to bound a ListQueries request, and limit its results to only
* those queries run within a specified time period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueriesRequest withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* Use with StartTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*
* @param endTime
* Use with StartTime to bound a ListQueries request, and limit its results to only
* those queries run within a specified time period.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* Use with StartTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*
* @return Use with StartTime to bound a ListQueries request, and limit its results to
* only those queries run within a specified time period.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* Use with StartTime to bound a ListQueries request, and limit its results to only those
* queries run within a specified time period.
*
*
* @param endTime
* Use with StartTime to bound a ListQueries request, and limit its results to only
* those queries run within a specified time period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListQueriesRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The status of queries that you want to return in results. Valid values for QueryStatus include
* QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or
* CANCELLED.
*
*
* @param queryStatus
* The status of queries that you want to return in results. Valid values for QueryStatus
* include QUEUED, RUNNING, FINISHED, FAILED,
* TIMED_OUT, or CANCELLED.
* @see QueryStatus
*/
public void setQueryStatus(String queryStatus) {
this.queryStatus = queryStatus;
}
/**
*
* The status of queries that you want to return in results. Valid values for QueryStatus include
* QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or
* CANCELLED.
*
*
* @return The status of queries that you want to return in results. Valid values for QueryStatus
* include QUEUED, RUNNING, FINISHED, FAILED,
* TIMED_OUT, or CANCELLED.
* @see QueryStatus
*/
public String getQueryStatus() {
return this.queryStatus;
}
/**
*
* The status of queries that you want to return in results. Valid values for QueryStatus include
* QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or
* CANCELLED.
*
*
* @param queryStatus
* The status of queries that you want to return in results. Valid values for QueryStatus
* include QUEUED, RUNNING, FINISHED, FAILED,
* TIMED_OUT, or CANCELLED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueryStatus
*/
public ListQueriesRequest withQueryStatus(String queryStatus) {
setQueryStatus(queryStatus);
return this;
}
/**
*
* The status of queries that you want to return in results. Valid values for QueryStatus include
* QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or
* CANCELLED.
*
*
* @param queryStatus
* The status of queries that you want to return in results. Valid values for QueryStatus
* include QUEUED, RUNNING, FINISHED, FAILED,
* TIMED_OUT, or CANCELLED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueryStatus
*/
public ListQueriesRequest withQueryStatus(QueryStatus queryStatus) {
this.queryStatus = queryStatus.toString();
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 (getEventDataStore() != null)
sb.append("EventDataStore: ").append(getEventDataStore()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getQueryStatus() != null)
sb.append("QueryStatus: ").append(getQueryStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListQueriesRequest == false)
return false;
ListQueriesRequest other = (ListQueriesRequest) obj;
if (other.getEventDataStore() == null ^ this.getEventDataStore() == null)
return false;
if (other.getEventDataStore() != null && other.getEventDataStore().equals(this.getEventDataStore()) == 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.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == 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.getQueryStatus() == null ^ this.getQueryStatus() == null)
return false;
if (other.getQueryStatus() != null && other.getQueryStatus().equals(this.getQueryStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEventDataStore() == null) ? 0 : getEventDataStore().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getQueryStatus() == null) ? 0 : getQueryStatus().hashCode());
return hashCode;
}
@Override
public ListQueriesRequest clone() {
return (ListQueriesRequest) super.clone();
}
}