com.amazonaws.services.ec2.model.DescribeFlowLogsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2011-2016 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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeFlowLogsRequestMarshaller;
/**
*
* Contains the parameters for DescribeFlowLogs.
*
*/
public class DescribeFlowLogsRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more flow log IDs.
*
*/
private com.amazonaws.internal.SdkInternalList flowLogIds;
/**
*
* One or more filters.
*
*
* -
*
* deliver-log-status - The status of the logs delivery (
* SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (ACCEPT |
* REJECT | ALL)
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filter;
/**
*
* The token to retrieve the next page of results.
*
*/
private String nextToken;
/**
*
* The maximum number of results to return for the request in a single page.
* The remaining results can be seen by sending another request with the
* returned NextToken value. This value can be between 5 and
* 1000; if MaxResults is given a value larger than 1000, only
* 1000 results are returned. You cannot specify this parameter and the flow
* log IDs parameter in the same request.
*
*/
private Integer maxResults;
/**
*
* One or more flow log IDs.
*
*
* @return One or more flow log IDs.
*/
public java.util.List getFlowLogIds() {
if (flowLogIds == null) {
flowLogIds = new com.amazonaws.internal.SdkInternalList();
}
return flowLogIds;
}
/**
*
* One or more flow log IDs.
*
*
* @param flowLogIds
* One or more flow log IDs.
*/
public void setFlowLogIds(java.util.Collection flowLogIds) {
if (flowLogIds == null) {
this.flowLogIds = null;
return;
}
this.flowLogIds = new com.amazonaws.internal.SdkInternalList(
flowLogIds);
}
/**
*
* One or more flow log IDs.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFlowLogIds(java.util.Collection)} or
* {@link #withFlowLogIds(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param flowLogIds
* One or more flow log IDs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFlowLogsRequest withFlowLogIds(String... flowLogIds) {
if (this.flowLogIds == null) {
setFlowLogIds(new com.amazonaws.internal.SdkInternalList(
flowLogIds.length));
}
for (String ele : flowLogIds) {
this.flowLogIds.add(ele);
}
return this;
}
/**
*
* One or more flow log IDs.
*
*
* @param flowLogIds
* One or more flow log IDs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFlowLogsRequest withFlowLogIds(
java.util.Collection flowLogIds) {
setFlowLogIds(flowLogIds);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* deliver-log-status - The status of the logs delivery (
* SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (ACCEPT |
* REJECT | ALL)
*
*
*
*
* @return One or more filters.
*
* -
*
* deliver-log-status - The status of the logs delivery
* (SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (
* ACCEPT | REJECT | ALL)
*
*
*/
public java.util.List getFilter() {
if (filter == null) {
filter = new com.amazonaws.internal.SdkInternalList();
}
return filter;
}
/**
*
* One or more filters.
*
*
* -
*
* deliver-log-status - The status of the logs delivery (
* SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (ACCEPT |
* REJECT | ALL)
*
*
*
*
* @param filter
* One or more filters.
*
* -
*
* deliver-log-status - The status of the logs delivery
* (SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (
* ACCEPT | REJECT | ALL)
*
*
*/
public void setFilter(java.util.Collection filter) {
if (filter == null) {
this.filter = null;
return;
}
this.filter = new com.amazonaws.internal.SdkInternalList(filter);
}
/**
*
* One or more filters.
*
*
* -
*
* deliver-log-status - The status of the logs delivery (
* SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (ACCEPT |
* REJECT | ALL)
*
*
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFilter(java.util.Collection)} or
* {@link #withFilter(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param filter
* One or more filters.
*
* -
*
* deliver-log-status - The status of the logs delivery
* (SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (
* ACCEPT | REJECT | ALL)
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFlowLogsRequest withFilter(Filter... filter) {
if (this.filter == null) {
setFilter(new com.amazonaws.internal.SdkInternalList(
filter.length));
}
for (Filter ele : filter) {
this.filter.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* deliver-log-status - The status of the logs delivery (
* SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (ACCEPT |
* REJECT | ALL)
*
*
*
*
* @param filter
* One or more filters.
*
* -
*
* deliver-log-status - The status of the logs delivery
* (SUCCESS | FAILED).
*
*
* -
*
* flow-log-id - The ID of the flow log.
*
*
* -
*
* log-group-name - The name of the log group.
*
*
* -
*
* resource-id - The ID of the VPC, subnet, or network
* interface.
*
*
* -
*
* traffic-type - The type of traffic (
* ACCEPT | REJECT | ALL)
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFlowLogsRequest withFilter(
java.util.Collection filter) {
setFilter(filter);
return this;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @param nextToken
* The token to retrieve the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @return The token to retrieve the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @param nextToken
* The token to retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFlowLogsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of results to return for the request in a single page.
* The remaining results can be seen by sending another request with the
* returned NextToken value. This value can be between 5 and
* 1000; if MaxResults is given a value larger than 1000, only
* 1000 results are returned. You cannot specify this parameter and the flow
* log IDs parameter in the same request.
*
*
* @param maxResults
* The maximum number of results to return for the request in a
* single page. The remaining results can be seen by sending another
* request with the returned NextToken value. This value
* can be between 5 and 1000; if MaxResults is given a
* value larger than 1000, only 1000 results are returned. You cannot
* specify this parameter and the flow log IDs parameter in the same
* request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return for the request in a single page.
* The remaining results can be seen by sending another request with the
* returned NextToken value. This value can be between 5 and
* 1000; if MaxResults is given a value larger than 1000, only
* 1000 results are returned. You cannot specify this parameter and the flow
* log IDs parameter in the same request.
*
*
* @return The maximum number of results to return for the request in a
* single page. The remaining results can be seen by sending another
* request with the returned NextToken value. This
* value can be between 5 and 1000; if MaxResults is
* given a value larger than 1000, only 1000 results are returned.
* You cannot specify this parameter and the flow log IDs parameter
* in the same request.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return for the request in a single page.
* The remaining results can be seen by sending another request with the
* returned NextToken value. This value can be between 5 and
* 1000; if MaxResults is given a value larger than 1000, only
* 1000 results are returned. You cannot specify this parameter and the flow
* log IDs parameter in the same request.
*
*
* @param maxResults
* The maximum number of results to return for the request in a
* single page. The remaining results can be seen by sending another
* request with the returned NextToken value. This value
* can be between 5 and 1000; if MaxResults is given a
* value larger than 1000, only 1000 results are returned. You cannot
* specify this parameter and the flow log IDs parameter in the same
* request.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeFlowLogsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled
* request configured with additional parameters to enable operation
* dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeFlowLogsRequestMarshaller()
.marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFlowLogIds() != null)
sb.append("FlowLogIds: " + getFlowLogIds() + ",");
if (getFilter() != null)
sb.append("Filter: " + getFilter() + ",");
if (getNextToken() != null)
sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null)
sb.append("MaxResults: " + getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeFlowLogsRequest == false)
return false;
DescribeFlowLogsRequest other = (DescribeFlowLogsRequest) obj;
if (other.getFlowLogIds() == null ^ this.getFlowLogIds() == null)
return false;
if (other.getFlowLogIds() != null
&& other.getFlowLogIds().equals(this.getFlowLogIds()) == false)
return false;
if (other.getFilter() == null ^ this.getFilter() == null)
return false;
if (other.getFilter() != null
&& other.getFilter().equals(this.getFilter()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getFlowLogIds() == null) ? 0 : getFlowLogIds().hashCode());
hashCode = prime * hashCode
+ ((getFilter() == null) ? 0 : getFilter().hashCode());
hashCode = prime * hashCode
+ ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode
+ ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeFlowLogsRequest clone() {
return (DescribeFlowLogsRequest) super.clone();
}
}