Package software.amazon.awssdk.services.fms.model

Class RegionScope

java.lang.Object

software.amazon.awssdk.services.fms.model.RegionScope

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RegionScope.Builder,RegionScope>

@Generated("software.amazon.awssdk:codegen")
public final class RegionScope
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RegionScope.Builder,RegionScope>

Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can manage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegionScope.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allRegionsEnabled()	Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.
static RegionScope.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegions()	For responses, this returns true if the service returned a value for the Regions property.
List<String>	regions()	The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.
List<SdkField<?>>	sdkFields()
static Class<? extends RegionScope.Builder>	serializableBuilderClass()
RegionScope.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasRegions

public final boolean hasRegions()

For responses, this returns true if the service returned a value for the Regions 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.

regions

public final List<String> regions()

The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

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 hasRegions() method.

Returns:

The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

allRegionsEnabled

public final Boolean allRegionsEnabled()

Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.

Returns:

Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.

toBuilder

public RegionScope.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegionScope.Builder,RegionScope>

builder

public static RegionScope.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo