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

Class AssociateSubnetsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest

software.amazon.awssdk.services.networkfirewall.model.AssociateSubnetsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateSubnetsRequest.Builder,AssociateSubnetsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AssociateSubnetsRequest
extends NetworkFirewallRequest
implements ToCopyableBuilder<AssociateSubnetsRequest.Builder,AssociateSubnetsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssociateSubnetsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AssociateSubnetsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firewallArn()	The Amazon Resource Name (ARN) of the firewall.
String	firewallName()	The descriptive name of the firewall.
<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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AssociateSubnetsRequest.Builder>	serializableBuilderClass()
List<SubnetMapping>	subnetMappings()	The IDs of the subnets that you want to associate with the firewall.
AssociateSubnetsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	updateToken()	An optional token that you can use for optimistic locking.

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

updateToken

public final String updateToken()

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

Returns:

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

firewallArn

public final String firewallArn()

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

Returns:

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

firewallName

public final String firewallName()

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

Returns:

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

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 the isEmpty() 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 subnets that you want to associate with the firewall.

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 subnets that you want to associate with the firewall.

toBuilder

public AssociateSubnetsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateSubnetsRequest.Builder,AssociateSubnetsRequest>

Specified by:

toBuilder in class NetworkFirewallRequest

builder

public static AssociateSubnetsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssociateSubnetsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo