Class ModifyTrafficMirrorFilterRuleRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.ModifyTrafficMirrorFilterRuleRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyTrafficMirrorFilterRuleRequest.Builder,ModifyTrafficMirrorFilterRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyTrafficMirrorFilterRuleRequest extends Ec2Request implements ToCopyableBuilder<ModifyTrafficMirrorFilterRuleRequest.Builder,ModifyTrafficMirrorFilterRuleRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifyTrafficMirrorFilterRuleRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifyTrafficMirrorFilterRuleRequest.Builder
builder()
String
description()
The description to assign to the Traffic Mirror rule.String
destinationCidrBlock()
The destination CIDR block to assign to the Traffic Mirror rule.TrafficMirrorPortRangeRequest
destinationPortRange()
The destination ports that are associated with the Traffic Mirror rule.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasRemoveFields()
For responses, this returns true if the service returned a value for the RemoveFields property.Integer
protocol()
The protocol, for example TCP, to assign to the Traffic Mirror rule.List<TrafficMirrorFilterRuleField>
removeFields()
The properties that you want to remove from the Traffic Mirror filter rule.List<String>
removeFieldsAsStrings()
The properties that you want to remove from the Traffic Mirror filter rule.TrafficMirrorRuleAction
ruleAction()
The action to assign to the rule.String
ruleActionAsString()
The action to assign to the rule.Integer
ruleNumber()
The number of the Traffic Mirror rule.List<SdkField<?>>
sdkFields()
static Class<? extends ModifyTrafficMirrorFilterRuleRequest.Builder>
serializableBuilderClass()
String
sourceCidrBlock()
The source CIDR block to assign to the Traffic Mirror rule.TrafficMirrorPortRangeRequest
sourcePortRange()
The port range to assign to the Traffic Mirror rule.ModifyTrafficMirrorFilterRuleRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.TrafficDirection
trafficDirection()
The type of traffic to assign to the rule.String
trafficDirectionAsString()
The type of traffic to assign to the rule.String
trafficMirrorFilterRuleId()
The ID of the Traffic Mirror rule.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
trafficMirrorFilterRuleId
public final String trafficMirrorFilterRuleId()
The ID of the Traffic Mirror rule.
- Returns:
- The ID of the Traffic Mirror rule.
-
trafficDirection
public final TrafficDirection trafficDirection()
The type of traffic to assign to the rule.
If the service returns an enum value that is not available in the current SDK version,
trafficDirection
will returnTrafficDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrafficDirectionAsString()
.- Returns:
- The type of traffic to assign to the rule.
- See Also:
TrafficDirection
-
trafficDirectionAsString
public final String trafficDirectionAsString()
The type of traffic to assign to the rule.
If the service returns an enum value that is not available in the current SDK version,
trafficDirection
will returnTrafficDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrafficDirectionAsString()
.- Returns:
- The type of traffic to assign to the rule.
- See Also:
TrafficDirection
-
ruleNumber
public final Integer ruleNumber()
The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
- Returns:
- The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
-
ruleAction
public final TrafficMirrorRuleAction ruleAction()
The action to assign to the rule.
If the service returns an enum value that is not available in the current SDK version,
ruleAction
will returnTrafficMirrorRuleAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruleActionAsString()
.- Returns:
- The action to assign to the rule.
- See Also:
TrafficMirrorRuleAction
-
ruleActionAsString
public final String ruleActionAsString()
The action to assign to the rule.
If the service returns an enum value that is not available in the current SDK version,
ruleAction
will returnTrafficMirrorRuleAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruleActionAsString()
.- Returns:
- The action to assign to the rule.
- See Also:
TrafficMirrorRuleAction
-
destinationPortRange
public final TrafficMirrorPortRangeRequest destinationPortRange()
The destination ports that are associated with the Traffic Mirror rule.
- Returns:
- The destination ports that are associated with the Traffic Mirror rule.
-
sourcePortRange
public final TrafficMirrorPortRangeRequest sourcePortRange()
The port range to assign to the Traffic Mirror rule.
- Returns:
- The port range to assign to the Traffic Mirror rule.
-
protocol
public final Integer protocol()
The protocol, for example TCP, to assign to the Traffic Mirror rule.
- Returns:
- The protocol, for example TCP, to assign to the Traffic Mirror rule.
-
destinationCidrBlock
public final String destinationCidrBlock()
The destination CIDR block to assign to the Traffic Mirror rule.
- Returns:
- The destination CIDR block to assign to the Traffic Mirror rule.
-
sourceCidrBlock
public final String sourceCidrBlock()
The source CIDR block to assign to the Traffic Mirror rule.
- Returns:
- The source CIDR block to assign to the Traffic Mirror rule.
-
description
public final String description()
The description to assign to the Traffic Mirror rule.
- Returns:
- The description to assign to the Traffic Mirror rule.
-
removeFields
public final List<TrafficMirrorFilterRuleField> removeFields()
The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRemoveFields()
method.- Returns:
- The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
-
hasRemoveFields
public final boolean hasRemoveFields()
For responses, this returns true if the service returned a value for the RemoveFields property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
removeFieldsAsStrings
public final List<String> removeFieldsAsStrings()
The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRemoveFields()
method.- Returns:
- The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
toBuilder
public ModifyTrafficMirrorFilterRuleRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyTrafficMirrorFilterRuleRequest.Builder,ModifyTrafficMirrorFilterRuleRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ModifyTrafficMirrorFilterRuleRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyTrafficMirrorFilterRuleRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-