software.amazon.awssdk.services.fms.model

Class ResourceSet

java.lang.Object

software.amazon.awssdk.services.fms.model.ResourceSet

All Implemented Interfaces:

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

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

A set of resources to include in a policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResourceSet.Builder

Method Summary

Modifier and Type	Method and Description
static ResourceSet.Builder	builder()
String	description() A description of the resource set.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceTypeList() For responses, this returns true if the service returned a value for the ResourceTypeList property.
String	id() A unique identifier for the resource set.
Instant	lastUpdateTime() The last time that the resource set was changed.
String	name() The descriptive name of the resource set.
List<String>	resourceTypeList() Determines the resources that can be associated to the resource set.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceSet.Builder>	serializableBuilderClass()
ResourceSet.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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

name

public final String name()

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

Returns:

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

description

public final String description()

A description of the resource set.

Returns:

A description of the resource set.

updateToken

public final String updateToken()

An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

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

To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set 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. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

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

To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set 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.

hasResourceTypeList

public final boolean hasResourceTypeList()

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

resourceTypeList

public final List<String> resourceTypeList()

Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

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

Returns:

Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

lastUpdateTime

public final Instant lastUpdateTime()

The last time that the resource set was changed.

Returns:

The last time that the resource set was changed.

toBuilder

public ResourceSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceSet.Builder,ResourceSet>

builder

public static ResourceSet.Builder builder()

serializableBuilderClass

public static Class<? extends ResourceSet.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