Class DescribeFirewallMetadataResponse

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.DescribeFirewallMetadataResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeFirewallMetadataResponse.Builder,DescribeFirewallMetadataResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeFirewallMetadataResponse extends NetworkFirewallResponse implements ToCopyableBuilder<DescribeFirewallMetadataResponse.Builder,DescribeFirewallMetadataResponse>

  • Method Details

    • firewallArn

      public final String firewallArn()

      The Amazon Resource Name (ARN) of the firewall.

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

    • firewallPolicyArn

      public final String firewallPolicyArn()

      The Amazon Resource Name (ARN) of the firewall policy.

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

    • description

      public final String description()

      A description of the firewall.

      Returns:
      A description of the firewall.

    • status

      public final FirewallStatusValue status()

      The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.

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

      Returns:
      The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
      See Also:

    • statusAsString

      public final String statusAsString()

      The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.

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

      Returns:
      The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
      See Also:

    • hasSupportedAvailabilityZones

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

    • supportedAvailabilityZones

      public final Map<String,AvailabilityZoneMetadata> supportedAvailabilityZones()

      The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.

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

      Returns:
      The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.

    • transitGatewayAttachmentId

      public final String transitGatewayAttachmentId()

      The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.

      Returns:
      The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.

    • toBuilder

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

    • builder

      public static DescribeFirewallMetadataResponse.Builder builder()

    • serializableBuilderClass

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