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

Interface CreateRuleGroupResponse.Builder

All Superinterfaces:

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

Enclosing class:

CreateRuleGroupResponse

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

Method Summary

Modifier and Type	Method	Description
default CreateRuleGroupResponse.Builder	ruleGroupResponse(Consumer<RuleGroupResponse.Builder> ruleGroupResponse)	The high-level properties of a rule group.
CreateRuleGroupResponse.Builder	ruleGroupResponse(RuleGroupResponse ruleGroupResponse)	The high-level properties of a rule group.
CreateRuleGroupResponse.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

CreateRuleGroupResponse.Builder updateToken(String updateToken)

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

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a 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 rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a 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.

ruleGroupResponse

CreateRuleGroupResponse.Builder ruleGroupResponse(RuleGroupResponse ruleGroupResponse)

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Parameters:

ruleGroupResponse - The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Returns:

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

ruleGroupResponse

default CreateRuleGroupResponse.Builder ruleGroupResponse(Consumer<RuleGroupResponse.Builder> ruleGroupResponse)

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

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

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

Parameters:

ruleGroupResponse - a consumer that will call methods on RuleGroupResponse.Builder

Returns:

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

See Also:

ruleGroupResponse(RuleGroupResponse)