com.amazonaws.services.ec2.model

Class DescribeFlowLogsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeFlowLogsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeFlowLogsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeFlowLogs operation.

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

See Also:

AmazonEC2.describeFlowLogs(DescribeFlowLogsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeFlowLogsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeFlowLogsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<Filter>	getFilter() One or more filters.
List<String>	getFlowLogIds() One or more flow log IDs.
Integer	getMaxResults() The maximum number of results to return for the request in a single page.
String	getNextToken() The token to retrieve the next page of results.
int	hashCode()
void	setFilter(Collection<Filter> filter) One or more filters.
void	setFlowLogIds(Collection<String> flowLogIds) One or more flow log IDs.
void	setMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
void	setNextToken(String nextToken) The token to retrieve the next page of results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeFlowLogsRequest	withFilter(Collection<Filter> filter) One or more filters.
DescribeFlowLogsRequest	withFilter(Filter... filter) One or more filters.
DescribeFlowLogsRequest	withFlowLogIds(Collection<String> flowLogIds) One or more flow log IDs.
DescribeFlowLogsRequest	withFlowLogIds(String... flowLogIds) One or more flow log IDs.
DescribeFlowLogsRequest	withMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
DescribeFlowLogsRequest	withNextToken(String nextToken) The token to retrieve the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeFlowLogsRequest

public DescribeFlowLogsRequest()

Method Detail

getFlowLogIds

public List<String> getFlowLogIds()

One or more flow log IDs.

Returns:

One or more flow log IDs.

setFlowLogIds

public void setFlowLogIds(Collection<String> flowLogIds)

One or more flow log IDs.

Parameters:

flowLogIds - One or more flow log IDs.

withFlowLogIds

public DescribeFlowLogsRequest withFlowLogIds(String... flowLogIds)

One or more flow log IDs.

NOTE: This method appends the values to the existing list (if any). Use setFlowLogIds(java.util.Collection) or withFlowLogIds(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

flowLogIds - One or more flow log IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

withFlowLogIds

public DescribeFlowLogsRequest withFlowLogIds(Collection<String> flowLogIds)

One or more flow log IDs.

Returns a reference to this object so that method calls can be chained together.

Parameters:

flowLogIds - One or more flow log IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilter

public List<Filter> getFilter()

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)

Returns:

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)

setFilter

public void setFilter(Collection<Filter> 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)

Parameters:

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)

withFilter

public DescribeFlowLogsRequest withFilter(Filter... 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 setFilter(java.util.Collection) or withFilter(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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)

Returns:

A reference to this updated object so that method calls can be chained together.

withFilter

public DescribeFlowLogsRequest withFilter(Collection<Filter> 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)

Returns a reference to this object so that method calls can be chained together.

Parameters:

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)

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

setNextToken

public void setNextToken(String nextToken)

The token to retrieve the next page of results.

Parameters:

nextToken - The token to retrieve the next page of results.

withNextToken

public DescribeFlowLogsRequest withNextToken(String nextToken)

The token to retrieve the next page of results.

Returns a reference to this object so that method calls can be chained together.

Parameters:

nextToken - The token to retrieve the next page of results.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

setMaxResults

public void setMaxResults(Integer 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.

Parameters:

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.

withMaxResults

public DescribeFlowLogsRequest withMaxResults(Integer 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeFlowLogsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()