Interface DescribeFlowOperationResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeFlowOperationResponse.Builder,
,DescribeFlowOperationResponse> NetworkFirewallResponse.Builder
,SdkBuilder<DescribeFlowOperationResponse.Builder,
,DescribeFlowOperationResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeFlowOperationResponse
-
Method Summary
Modifier and TypeMethodDescriptionavailabilityZone
(String availabilityZone) The ID of the Availability Zone where the firewall is located.firewallArn
(String firewallArn) The Amazon Resource Name (ARN) of the firewall.flowOperation
(Consumer<FlowOperation.Builder> flowOperation) Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.flowOperation
(FlowOperation flowOperation) Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.flowOperationId
(String flowOperationId) A unique identifier for the flow operation.flowOperationStatus
(String flowOperationStatus) Returns the status of the flow operation.flowOperationStatus
(FlowOperationStatus flowOperationStatus) Returns the status of the flow operation.flowOperationType
(String flowOperationType) Defines the type ofFlowOperation
.flowOperationType
(FlowOperationType flowOperationType) Defines the type ofFlowOperation
.flowRequestTimestamp
(Instant flowRequestTimestamp) A timestamp indicating when the Suricata engine identified flows impacted by an operation.statusMessage
(String statusMessage) If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure.vpcEndpointAssociationArn
(String vpcEndpointAssociationArn) The Amazon Resource Name (ARN) of a VPC endpoint association.vpcEndpointId
(String vpcEndpointId) A unique identifier for the primary endpoint associated with a firewall.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, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
firewallArn
The Amazon Resource Name (ARN) of the firewall.
- Parameters:
firewallArn
- The Amazon Resource Name (ARN) of the firewall.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZone
The ID of the Availability Zone where the firewall is located. For example,
us-east-2a
.Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
- Parameters:
availabilityZone
- The ID of the Availability Zone where the firewall is located. For example,us-east-2a
.Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcEndpointAssociationArn
The Amazon Resource Name (ARN) of a VPC endpoint association.
- Parameters:
vpcEndpointAssociationArn
- The Amazon Resource Name (ARN) of a VPC endpoint association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcEndpointId
A unique identifier for the primary endpoint associated with a firewall.
- Parameters:
vpcEndpointId
- A unique identifier for the primary endpoint associated with a firewall.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flowOperationId
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
- Parameters:
flowOperationId
- A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flowOperationType
Defines the type of
FlowOperation
.- Parameters:
flowOperationType
- Defines the type ofFlowOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
flowOperationType
Defines the type of
FlowOperation
.- Parameters:
flowOperationType
- Defines the type ofFlowOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
flowOperationStatus
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is
COMPLETED_WITH_ERRORS
, results may be returned with any number ofFlows
missing from the response. If the status isFAILED
,Flows
returned will be empty.- Parameters:
flowOperationStatus
- Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.If the status is
COMPLETED_WITH_ERRORS
, results may be returned with any number ofFlows
missing from the response. If the status isFAILED
,Flows
returned will be empty.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
flowOperationStatus
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is
COMPLETED_WITH_ERRORS
, results may be returned with any number ofFlows
missing from the response. If the status isFAILED
,Flows
returned will be empty.- Parameters:
flowOperationStatus
- Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.If the status is
COMPLETED_WITH_ERRORS
, results may be returned with any number ofFlows
missing from the response. If the status isFAILED
,Flows
returned will be empty.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusMessage
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include
Flow operation error
andFlow timeout
.- Parameters:
statusMessage
- If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options includeFlow operation error
andFlow timeout
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flowRequestTimestamp
A timestamp indicating when the Suricata engine identified flows impacted by an operation.
- Parameters:
flowRequestTimestamp
- A timestamp indicating when the Suricata engine identified flows impacted by an operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flowOperation
Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.
- Parameters:
flowOperation
- Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flowOperation
default DescribeFlowOperationResponse.Builder flowOperation(Consumer<FlowOperation.Builder> flowOperation) Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.
This is a convenience method that creates an instance of theFlowOperation.Builder
avoiding the need to create one manually viaFlowOperation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toflowOperation(FlowOperation)
.- Parameters:
flowOperation
- a consumer that will call methods onFlowOperation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-