Class DescribeFlowOperationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallResponse
software.amazon.awssdk.services.networkfirewall.model.DescribeFlowOperationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeFlowOperationResponse.Builder,DescribeFlowOperationResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeFlowOperationResponse extends NetworkFirewallResponse implements ToCopyableBuilder<DescribeFlowOperationResponse.Builder,DescribeFlowOperationResponse>

  • Method Details

    • firewallArn

      public final String firewallArn()

      The Amazon Resource Name (ARN) of the firewall.

      Returns:
      The Amazon Resource Name (ARN) of the firewall.

    • availabilityZone

      public final String availabilityZone()

      The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

      Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

      Returns:
      The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

      Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

    • vpcEndpointAssociationArn

      public final String vpcEndpointAssociationArn()

      The Amazon Resource Name (ARN) of a VPC endpoint association.

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

    • vpcEndpointId

      public final String vpcEndpointId()

      A unique identifier for the primary endpoint associated with a firewall.

      Returns:
      A unique identifier for the primary endpoint associated with a firewall.

    • flowOperationId

      public final String flowOperationId()

      A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

      Returns:
      A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

    • flowOperationType

      public final FlowOperationType flowOperationType()

      Defines the type of FlowOperation.

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

      Returns:
      Defines the type of FlowOperation.
      See Also:

    • flowOperationTypeAsString

      public final String flowOperationTypeAsString()

      Defines the type of FlowOperation.

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

      Returns:
      Defines the type of FlowOperation.
      See Also:

    • flowOperationStatus

      public final FlowOperationStatus flowOperationStatus()

      Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

      If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

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

      Returns:
      Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

      If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

      See Also:

    • flowOperationStatusAsString

      public final String flowOperationStatusAsString()

      Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

      If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

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

      Returns:
      Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

      If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

      See Also:

    • statusMessage

      public final String statusMessage()

      If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.

      Returns:
      If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.

    • flowRequestTimestamp

      public final Instant flowRequestTimestamp()

      A timestamp indicating when the Suricata engine identified flows impacted by an operation.

      Returns:
      A timestamp indicating when the Suricata engine identified flows impacted by an operation.

    • flowOperation

      public final FlowOperation flowOperation()

      Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.

      Returns:
      Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.

    • toBuilder

      public DescribeFlowOperationResponse.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<DescribeFlowOperationResponse.Builder,DescribeFlowOperationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeFlowOperationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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