Class SetSubnetsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request
-
- software.amazon.awssdk.services.elasticloadbalancingv2.model.SetSubnetsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SetSubnetsRequest.Builder,SetSubnetsRequest>
@Generated("software.amazon.awssdk:codegen") public final class SetSubnetsRequest extends ElasticLoadBalancingV2Request implements ToCopyableBuilder<SetSubnetsRequest.Builder,SetSubnetsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SetSubnetsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SetSubnetsRequest.Builder
builder()
EnablePrefixForIpv6SourceNatEnum
enablePrefixForIpv6SourceNat()
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.String
enablePrefixForIpv6SourceNatAsString()
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasSubnetMappings()
For responses, this returns true if the service returned a value for the SubnetMappings property.boolean
hasSubnets()
For responses, this returns true if the service returned a value for the Subnets property.IpAddressType
ipAddressType()
The IP address type.String
ipAddressTypeAsString()
The IP address type.String
loadBalancerArn()
The Amazon Resource Name (ARN) of the load balancer.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends SetSubnetsRequest.Builder>
serializableBuilderClass()
List<SubnetMapping>
subnetMappings()
The IDs of the public subnets.List<String>
subnets()
The IDs of the public subnets.SetSubnetsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
loadBalancerArn
public final String loadBalancerArn()
The Amazon Resource Name (ARN) of the load balancer.
- Returns:
- The Amazon Resource Name (ARN) of the load balancer.
-
hasSubnets
public final boolean hasSubnets()
For responses, this returns true if the service returned a value for the Subnets 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.
-
subnets
public final List<String> subnets()
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
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
hasSubnets()
method.- Returns:
- The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify
either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
-
hasSubnetMappings
public final boolean hasSubnetMappings()
For responses, this returns true if the service returned a value for the SubnetMappings 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.
-
subnetMappings
public final List<SubnetMapping> subnetMappings()
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
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
hasSubnetMappings()
method.- Returns:
- The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify
either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
-
ipAddressType
public final IpAddressType ipAddressType()
The IP address type.
[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses).If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type.
[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses). - See Also:
IpAddressType
-
ipAddressTypeAsString
public final String ipAddressTypeAsString()
The IP address type.
[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses).If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type.
[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses). - See Also:
IpAddressType
-
enablePrefixForIpv6SourceNat
public final EnablePrefixForIpv6SourceNatEnum enablePrefixForIpv6SourceNat()
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be
dualstack
. The default value isoff
.If the service returns an enum value that is not available in the current SDK version,
enablePrefixForIpv6SourceNat
will returnEnablePrefixForIpv6SourceNatEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromenablePrefixForIpv6SourceNatAsString()
.- Returns:
- [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for
source NAT. The IP address type must be
dualstack
. The default value isoff
. - See Also:
EnablePrefixForIpv6SourceNatEnum
-
enablePrefixForIpv6SourceNatAsString
public final String enablePrefixForIpv6SourceNatAsString()
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be
dualstack
. The default value isoff
.If the service returns an enum value that is not available in the current SDK version,
enablePrefixForIpv6SourceNat
will returnEnablePrefixForIpv6SourceNatEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromenablePrefixForIpv6SourceNatAsString()
.- Returns:
- [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for
source NAT. The IP address type must be
dualstack
. The default value isoff
. - See Also:
EnablePrefixForIpv6SourceNatEnum
-
toBuilder
public SetSubnetsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SetSubnetsRequest.Builder,SetSubnetsRequest>
- Specified by:
toBuilder
in classElasticLoadBalancingV2Request
-
builder
public static SetSubnetsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends SetSubnetsRequest.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
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-