software.amazon.awssdk.services.ec2.model

Class ModifyTrafficMirrorSessionRequest

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.ModifyTrafficMirrorSessionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyTrafficMirrorSessionRequest.Builder,ModifyTrafficMirrorSessionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyTrafficMirrorSessionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ModifyTrafficMirrorSessionRequest.Builder	builder()
String	description() The description to assign to the Traffic Mirror session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRemoveFields() For responses, this returns true if the service returned a value for the RemoveFields property.
Integer	packetLength() The number of bytes in each packet to mirror.
List<TrafficMirrorSessionField>	removeFields() The properties that you want to remove from the Traffic Mirror session.
List<String>	removeFieldsAsStrings() The properties that you want to remove from the Traffic Mirror session.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyTrafficMirrorSessionRequest.Builder>	serializableBuilderClass()
Integer	sessionNumber() The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
ModifyTrafficMirrorSessionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	trafficMirrorFilterId() The ID of the Traffic Mirror filter.
String	trafficMirrorSessionId() The ID of the Traffic Mirror session.
String	trafficMirrorTargetId() The Traffic Mirror target.
Integer	virtualNetworkId() The virtual network 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

trafficMirrorSessionId

public final String trafficMirrorSessionId()

The ID of the Traffic Mirror session.

Returns:

The ID of the Traffic Mirror session.

trafficMirrorTargetId

public final String trafficMirrorTargetId()

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

Returns:

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

trafficMirrorFilterId

public final String trafficMirrorFilterId()

The ID of the Traffic Mirror filter.

Returns:

The ID of the Traffic Mirror filter.

packetLength

public final Integer packetLength()

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

Returns:

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

sessionNumber

public final Integer sessionNumber()

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

Returns:

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

virtualNetworkId

public final Integer virtualNetworkId()

The virtual network ID of the Traffic Mirror session.

Returns:

The virtual network ID of the Traffic Mirror session.

description

public final String description()

The description to assign to the Traffic Mirror session.

Returns:

The description to assign to the Traffic Mirror session.

removeFields

public final List<TrafficMirrorSessionField> removeFields()

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

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 hasRemoveFields() method.

Returns:

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

hasRemoveFields

public final boolean hasRemoveFields()

For responses, this returns true if the service returned a value for the RemoveFields 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.

removeFieldsAsStrings

public final List<String> removeFieldsAsStrings()

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

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 hasRemoveFields() method.

Returns:

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

toBuilder

public ModifyTrafficMirrorSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyTrafficMirrorSessionRequest.Builder,ModifyTrafficMirrorSessionRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyTrafficMirrorSessionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyTrafficMirrorSessionRequest.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