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

Interface DescribeFirewallPolicyResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeFirewallPolicyResponse.Builder,DescribeFirewallPolicyResponse>, NetworkFirewallResponse.Builder, SdkBuilder<DescribeFirewallPolicyResponse.Builder,DescribeFirewallPolicyResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeFirewallPolicyResponse

public static interface DescribeFirewallPolicyResponse.Builder
extends NetworkFirewallResponse.Builder, SdkPojo, CopyableBuilder<DescribeFirewallPolicyResponse.Builder,DescribeFirewallPolicyResponse>

Method Summary

Modifier and Type	Method	Description
default DescribeFirewallPolicyResponse.Builder	firewallPolicy(Consumer<FirewallPolicy.Builder> firewallPolicy)	The policy for the specified firewall policy.
DescribeFirewallPolicyResponse.Builder	firewallPolicy(FirewallPolicy firewallPolicy)	The policy for the specified firewall policy.
default DescribeFirewallPolicyResponse.Builder	firewallPolicyResponse(Consumer<FirewallPolicyResponse.Builder> firewallPolicyResponse)	The high-level properties of a firewall policy.
DescribeFirewallPolicyResponse.Builder	firewallPolicyResponse(FirewallPolicyResponse firewallPolicyResponse)	The high-level properties of a firewall policy.
DescribeFirewallPolicyResponse.Builder	updateToken(String updateToken)	A token used for optimistic locking.

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

copy

Methods inherited from interface software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

updateToken

DescribeFirewallPolicyResponse.Builder updateToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

firewallPolicyResponse

DescribeFirewallPolicyResponse.Builder firewallPolicyResponse(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

firewallPolicyResponse

default DescribeFirewallPolicyResponse.Builder firewallPolicyResponse(Consumer<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.

This is a convenience method that creates an instance of the FirewallPolicyResponse.Builder avoiding the need to create one manually via FirewallPolicyResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to firewallPolicyResponse(FirewallPolicyResponse).

Parameters:

firewallPolicyResponse - a consumer that will call methods on FirewallPolicyResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

firewallPolicyResponse(FirewallPolicyResponse)

firewallPolicy

DescribeFirewallPolicyResponse.Builder firewallPolicy(FirewallPolicy firewallPolicy)

The policy for the specified firewall policy.

Parameters:

firewallPolicy - The policy for the specified firewall policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

firewallPolicy

default DescribeFirewallPolicyResponse.Builder firewallPolicy(Consumer<FirewallPolicy.Builder> firewallPolicy)

The policy for the specified firewall policy.

This is a convenience method that creates an instance of the FirewallPolicy.Builder avoiding the need to create one manually via FirewallPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to firewallPolicy(FirewallPolicy).

Parameters:

firewallPolicy - a consumer that will call methods on FirewallPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

firewallPolicy(FirewallPolicy)