software.amazon.awssdk.services.networkfirewall.model

Class FirewallPolicyResponse

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.FirewallPolicyResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FirewallPolicyResponse.Builder,FirewallPolicyResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class FirewallPolicyResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FirewallPolicyResponse.Builder,FirewallPolicyResponse>

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FirewallPolicyResponse.Builder

Method Summary

Modifier and Type	Method and Description
static FirewallPolicyResponse.Builder	builder()
Integer	consumedStatefulRuleCapacity() The number of capacity units currently consumed by the policy's stateful rules.
Integer	consumedStatelessRuleCapacity() The number of capacity units currently consumed by the policy's stateless rules.
String	description() A description of the firewall policy.
EncryptionConfiguration	encryptionConfiguration() A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firewallPolicyArn() The Amazon Resource Name (ARN) of the firewall policy.
String	firewallPolicyId() The unique identifier for the firewall policy.
String	firewallPolicyName() The descriptive name of the firewall policy.
ResourceStatus	firewallPolicyStatus() The current status of the firewall policy.
String	firewallPolicyStatusAsString() The current status of the firewall policy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Instant	lastModifiedTime() The last time that the firewall policy was changed.
Integer	numberOfAssociations() The number of firewalls that are associated with this firewall policy.
List<SdkField<?>>	sdkFields()
static Class<? extends FirewallPolicyResponse.Builder>	serializableBuilderClass()
List<Tag>	tags() The key:value pairs to associate with the resource.
FirewallPolicyResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

firewallPolicyName

public final String firewallPolicyName()

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

Returns:

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

firewallPolicyArn

public final String firewallPolicyArn()

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

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Returns:

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

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

firewallPolicyId

public final String firewallPolicyId()

The unique identifier for the firewall policy.

Returns:

The unique identifier for the firewall policy.

description

public final String description()

A description of the firewall policy.

Returns:

A description of the firewall policy.

firewallPolicyStatus

public final ResourceStatus firewallPolicyStatus()

The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

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

Returns:

The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

See Also:

ResourceStatus

firewallPolicyStatusAsString

public final String firewallPolicyStatusAsString()

The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

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

Returns:

The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

See Also:

ResourceStatus

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 key:value pairs to associate with the resource.

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 key:value pairs to associate with the resource.

consumedStatelessRuleCapacity

public final Integer consumedStatelessRuleCapacity()

The number of capacity units currently consumed by the policy's stateless rules.

Returns:

The number of capacity units currently consumed by the policy's stateless rules.

consumedStatefulRuleCapacity

public final Integer consumedStatefulRuleCapacity()

The number of capacity units currently consumed by the policy's stateful rules.

Returns:

The number of capacity units currently consumed by the policy's stateful rules.

numberOfAssociations

public final Integer numberOfAssociations()

The number of firewalls that are associated with this firewall policy.

Returns:

The number of firewalls that are associated with this firewall policy.

encryptionConfiguration

public final EncryptionConfiguration encryptionConfiguration()

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

Returns:

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

lastModifiedTime

public final Instant lastModifiedTime()

The last time that the firewall policy was changed.

Returns:

The last time that the firewall policy was changed.

toBuilder

public FirewallPolicyResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FirewallPolicyResponse.Builder,FirewallPolicyResponse>

builder

public static FirewallPolicyResponse.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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