Package software.amazon.awssdk.services.networkfirewall.model

Class DescribeFirewallResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFirewallResponse.Builder,DescribeFirewallResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeFirewallResponse
extends NetworkFirewallResponse
implements ToCopyableBuilder<DescribeFirewallResponse.Builder,DescribeFirewallResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeFirewallResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeFirewallResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Firewall	firewall()	The configuration settings for the firewall.
FirewallStatus	firewallStatus()	Detailed information about the current status of a Firewall.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFirewallResponse.Builder>	serializableBuilderClass()
DescribeFirewallResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	updateToken()	An optional token that you can use for optimistic locking.

Methods inherited from class software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

updateToken

public final String updateToken()

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

Returns:

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

firewall

public final Firewall firewall()

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

Returns:

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

firewallStatus

public final FirewallStatus firewallStatus()

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

Returns:

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

toBuilder

public DescribeFirewallResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFirewallResponse.Builder,DescribeFirewallResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeFirewallResponse.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo