Class MonitorTopContributorsRow

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

A set of information for a top contributor network flow in a monitor. In a monitor, Network Flow Monitor returns information about the network flows for top contributors for each metric. Top contributors are network flows with the top values for each metric type.

See Also:

  • Method Details

    • localIp

      public final String localIp()

      The IP address of the local resource for a top contributor network flow.

      Returns:
      The IP address of the local resource for a top contributor network flow.

    • snatIp

      public final String snatIp()

      The secure network address translation (SNAT) IP address for a top contributor network flow.

      Returns:
      The secure network address translation (SNAT) IP address for a top contributor network flow.

    • localInstanceId

      public final String localInstanceId()

      The instance identifier for the local resource for a top contributor network flow.

      Returns:
      The instance identifier for the local resource for a top contributor network flow.

    • localVpcId

      public final String localVpcId()

      The VPC ID for a top contributor network flow for the local resource.

      Returns:
      The VPC ID for a top contributor network flow for the local resource.

    • localRegion

      public final String localRegion()

      The Amazon Web Services Region for the local resource for a top contributor network flow.

      Returns:
      The Amazon Web Services Region for the local resource for a top contributor network flow.

    • localAz

      public final String localAz()

      The Availability Zone for the local resource for a top contributor network flow.

      Returns:
      The Availability Zone for the local resource for a top contributor network flow.

    • localSubnetId

      public final String localSubnetId()

      The subnet ID for the local resource for a top contributor network flow.

      Returns:
      The subnet ID for the local resource for a top contributor network flow.

    • targetPort

      public final Integer targetPort()

      The target port.

      Returns:
      The target port.

    • destinationCategory

      public final DestinationCategory destinationCategory()

      The destination category for a top contributors row. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      If the service returns an enum value that is not available in the current SDK version, destinationCategory will return DestinationCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationCategoryAsString().

      Returns:
      The destination category for a top contributors row. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      See Also:

    • destinationCategoryAsString

      public final String destinationCategoryAsString()

      The destination category for a top contributors row. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      If the service returns an enum value that is not available in the current SDK version, destinationCategory will return DestinationCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationCategoryAsString().

      Returns:
      The destination category for a top contributors row. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      See Also:

    • remoteVpcId

      public final String remoteVpcId()

      The VPC ID for a top contributor network flow for the remote resource.

      Returns:
      The VPC ID for a top contributor network flow for the remote resource.

    • remoteRegion

      public final String remoteRegion()

      The Amazon Web Services Region for the remote resource for a top contributor network flow.

      Returns:
      The Amazon Web Services Region for the remote resource for a top contributor network flow.

    • remoteAz

      public final String remoteAz()

      The Availability Zone for the remote resource for a top contributor network flow.

      Returns:
      The Availability Zone for the remote resource for a top contributor network flow.

    • remoteSubnetId

      public final String remoteSubnetId()

      The subnet ID for the remote resource for a top contributor network flow.

      Returns:
      The subnet ID for the remote resource for a top contributor network flow.

    • remoteInstanceId

      public final String remoteInstanceId()

      The instance identifier for the remote resource for a top contributor network flow.

      Returns:
      The instance identifier for the remote resource for a top contributor network flow.

    • remoteIp

      public final String remoteIp()

      The IP address of the remote resource for a top contributor network flow.

      Returns:
      The IP address of the remote resource for a top contributor network flow.

    • dnatIp

      public final String dnatIp()

      The destination network address translation (DNAT) IP address for a top contributor network flow.

      Returns:
      The destination network address translation (DNAT) IP address for a top contributor network flow.

    • value

      public final Long value()

      The value of the metric for a top contributor network flow.

      Returns:
      The value of the metric for a top contributor network flow.

    • hasTraversedConstructs

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

    • traversedConstructs

      public final List<TraversedComponent> traversedConstructs()

      The constructs traversed by a network flow.

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

      Returns:
      The constructs traversed by a network flow.

    • kubernetesMetadata

      public final KubernetesMetadata kubernetesMetadata()

      Meta data about Kubernetes resources.

      Returns:
      Meta data about Kubernetes resources.

    • localInstanceArn

      public final String localInstanceArn()

      The Amazon Resource Name (ARN) of a local resource.

      Returns:
      The Amazon Resource Name (ARN) of a local resource.

    • localSubnetArn

      public final String localSubnetArn()

      The Amazon Resource Name (ARN) of a local subnet.

      Returns:
      The Amazon Resource Name (ARN) of a local subnet.

    • localVpcArn

      public final String localVpcArn()

      The Amazon Resource Name (ARN) of a local VPC.

      Returns:
      The Amazon Resource Name (ARN) of a local VPC.

    • remoteInstanceArn

      public final String remoteInstanceArn()

      The Amazon Resource Name (ARN) of a remote resource.

      Returns:
      The Amazon Resource Name (ARN) of a remote resource.

    • remoteSubnetArn

      public final String remoteSubnetArn()

      The Amazon Resource Name (ARN) of a remote subnet.

      Returns:
      The Amazon Resource Name (ARN) of a remote subnet.

    • remoteVpcArn

      public final String remoteVpcArn()

      The Amazon Resource Name (ARN) of a remote VPC.

      Returns:
      The Amazon Resource Name (ARN) of a remote VPC.

    • toBuilder

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

    • builder

      public static MonitorTopContributorsRow.Builder builder()

    • serializableBuilderClass

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