Class TrafficMirrorSession

java.lang.Object
software.amazon.awssdk.services.ec2.model.TrafficMirrorSession
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TrafficMirrorSession.Builder,TrafficMirrorSession>
@Generated("software.amazon.awssdk:codegen") public final class TrafficMirrorSession extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TrafficMirrorSession.Builder,TrafficMirrorSession>

Describes a Traffic Mirror session.

See Also:

  • Method Details

    • trafficMirrorSessionId

      public final String trafficMirrorSessionId()

      The ID for the Traffic Mirror session.

      Returns:
      The ID for the Traffic Mirror session.

    • trafficMirrorTargetId

      public final String trafficMirrorTargetId()

      The ID of the Traffic Mirror target.

      Returns:
      The ID of the Traffic Mirror target.

    • trafficMirrorFilterId

      public final String trafficMirrorFilterId()

      The ID of the Traffic Mirror filter.

      Returns:
      The ID of the Traffic Mirror filter.

    • networkInterfaceId

      public final String networkInterfaceId()

      The ID of the Traffic Mirror session's network interface.

      Returns:
      The ID of the Traffic Mirror session's network interface.

    • ownerId

      public final String ownerId()

      The ID of the account that owns the Traffic Mirror session.

      Returns:
      The ID of the account that owns the Traffic Mirror session.

    • packetLength

      public final Integer packetLength()

      The number of bytes in each packet to mirror. These are the 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 the 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 associated with the Traffic Mirror session.

      Returns:
      The virtual network ID associated with the Traffic Mirror session.

    • description

      public final String description()

      The description of the Traffic Mirror session.

      Returns:
      The description of the Traffic Mirror session.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tags assigned to 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 hasTags() method.

      Returns:
      The tags assigned to the Traffic Mirror session.

    • toBuilder

      public TrafficMirrorSession.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TrafficMirrorSession.Builder,TrafficMirrorSession>
      Returns:
      a builder for type T

    • builder

      public static TrafficMirrorSession.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.