Package software.amazon.awssdk.services.ec2.model

Class DescribeTrafficMirrorSessionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeTrafficMirrorSessionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTrafficMirrorSessionsRequest.Builder,DescribeTrafficMirrorSessionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeTrafficMirrorSessionsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeTrafficMirrorSessionsRequest.Builder,DescribeTrafficMirrorSessionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeTrafficMirrorSessionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeTrafficMirrorSessionsRequest.Builder	builder()
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasTrafficMirrorSessionIds()	For responses, this returns true if the service returned a value for the TrafficMirrorSessionIds property.
Integer	maxResults()	The maximum number of results to return with a single call.
String	nextToken()	The token for the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTrafficMirrorSessionsRequest.Builder>	serializableBuilderClass()
DescribeTrafficMirrorSessionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	trafficMirrorSessionIds()	The ID of the Traffic Mirror session.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasTrafficMirrorSessionIds

public final boolean hasTrafficMirrorSessionIds()

For responses, this returns true if the service returned a value for the TrafficMirrorSessionIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

trafficMirrorSessionIds

public final List<String> trafficMirrorSessionIds()

The ID of the Traffic Mirror session.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTrafficMirrorSessionIds() method.

Returns:

The ID of the Traffic Mirror session.

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final List<Filter> filters()

One or more filters. The possible values are:

• description: The Traffic Mirror session description.

• network-interface-id: The ID of the Traffic Mirror session network interface.

• owner-id: The ID of the account that owns the Traffic Mirror session.

• packet-length: The assigned number of packets to mirror.

• session-number: The assigned session number.

• traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

• traffic-mirror-session-id: The ID of the Traffic Mirror session.

• traffic-mirror-target-id: The ID of the Traffic Mirror target.

• virtual-network-id: The virtual network ID of the Traffic Mirror session.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

Returns:

One or more filters. The possible values are:

• description: The Traffic Mirror session description.

• network-interface-id: The ID of the Traffic Mirror session network interface.

• owner-id: The ID of the account that owns the Traffic Mirror session.

• packet-length: The assigned number of packets to mirror.

• session-number: The assigned session number.

• traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

• traffic-mirror-session-id: The ID of the Traffic Mirror session.

• traffic-mirror-target-id: The ID of the Traffic Mirror target.

• virtual-network-id: The virtual network ID of the Traffic Mirror session.

maxResults

public final Integer maxResults()

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

nextToken

public final String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

toBuilder

public DescribeTrafficMirrorSessionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTrafficMirrorSessionsRequest.Builder,DescribeTrafficMirrorSessionsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeTrafficMirrorSessionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeTrafficMirrorSessionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo