Class Flow

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

Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.

See Also:

  • Method Details

    • sourceAddress

      public final Address sourceAddress()
      Returns the value of the SourceAddress property for this object.
      Returns:
      The value of the SourceAddress property for this object.

    • destinationAddress

      public final Address destinationAddress()
      Returns the value of the DestinationAddress property for this object.
      Returns:
      The value of the DestinationAddress property for this object.

    • sourcePort

      public final String sourcePort()

      The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

      Returns:
      The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

    • destinationPort

      public final String destinationPort()

      The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

      Returns:
      The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

    • protocol

      public final String protocol()

      The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

      Returns:
      The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

    • age

      public final Integer age()

      Returned as info about age of the flows identified by the flow operation.

      Returns:
      Returned as info about age of the flows identified by the flow operation.

    • packetCount

      public final Integer packetCount()

      Returns the total number of data packets received or transmitted in a flow.

      Returns:
      Returns the total number of data packets received or transmitted in a flow.

    • byteCount

      public final Long byteCount()

      Returns the number of bytes received or transmitted in a specific flow.

      Returns:
      Returns the number of bytes received or transmitted in a specific flow.

    • toBuilder

      public Flow.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<Flow.Builder,Flow>
      Returns:
      a builder for type T

    • builder

      public static Flow.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.