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

Class DescribeFirewallPolicyResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFirewallPolicyResponse.Builder,DescribeFirewallPolicyResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeFirewallPolicyResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeFirewallPolicyResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FirewallPolicy	firewallPolicy()	The policy for the specified firewall policy.
FirewallPolicyResponse	firewallPolicyResponse()	The high-level properties of a firewall policy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFirewallPolicyResponse.Builder>	serializableBuilderClass()
DescribeFirewallPolicyResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	updateToken()	A token used 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()

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

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

Returns:

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

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

firewallPolicyResponse

public final FirewallPolicyResponse 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.

Returns:

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.

firewallPolicy

public final FirewallPolicy firewallPolicy()

The policy for the specified firewall policy.

Returns:

The policy for the specified firewall policy.

toBuilder

public DescribeFirewallPolicyResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFirewallPolicyResponse.Builder,DescribeFirewallPolicyResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeFirewallPolicyResponse.Builder builder()

serializableBuilderClass

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