Interface ListFlowOperationResultsResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListFlowOperationResultsResponse.Builder,
,ListFlowOperationResultsResponse> NetworkFirewallResponse.Builder
,SdkBuilder<ListFlowOperationResultsResponse.Builder,
,ListFlowOperationResultsResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
ListFlowOperationResultsResponse
-
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.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.flowRequestTimestamp
(Instant flowRequestTimestamp) A timestamp indicating when the Suricata engine identified flows impacted by an operation.flows
(Collection<Flow> flows) Any number of arrays, where each array is a single flow identified in the scope of the operation.flows
(Consumer<Flow.Builder>... flows) Any number of arrays, where each array is a single flow identified in the scope of the operation.Any number of arrays, where each array is a single flow identified in the scope of the operation.When you request a list of objects with aMaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response.statusMessage
(String statusMessage) If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure.vpcEndpointAssociationArn
(String vpcEndpointAssociationArn) vpcEndpointId
(String vpcEndpointId) 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
ListFlowOperationResultsResponse.Builder vpcEndpointAssociationArn(String vpcEndpointAssociationArn) - Parameters:
vpcEndpointAssociationArn
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcEndpointId
- Parameters:
vpcEndpointId
-- 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.
-
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
ListFlowOperationResultsResponse.Builder flowOperationStatus(FlowOperationStatus 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.
-
flows
Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple
Flows
arrays are returned.- Parameters:
flows
- Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multipleFlows
arrays are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flows
Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple
Flows
arrays are returned.- Parameters:
flows
- Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multipleFlows
arrays are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flows
Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple
This is a convenience method that creates an instance of theFlows
arrays are returned.Flow.Builder
avoiding the need to create one manually viaFlow.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toflows(List<Flow>)
.- Parameters:
flows
- a consumer that will call methods onFlow.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nextToken
When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.- Parameters:
nextToken
- When you request a list of objects with aMaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-