software.amazon.awssdk.services.fms.model.ResourceSet Maven / Gradle / Ivy
Show all versions of fms Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.fms.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A set of resources to include in a policy.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResourceSet implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(ResourceSet::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ResourceSet::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(ResourceSet::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField UPDATE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UpdateToken").getter(getter(ResourceSet::updateToken)).setter(setter(Builder::updateToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateToken").build()).build();
private static final SdkField> RESOURCE_TYPE_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ResourceTypeList")
.getter(getter(ResourceSet::resourceTypeList))
.setter(setter(Builder::resourceTypeList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceTypeList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField LAST_UPDATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastUpdateTime").getter(getter(ResourceSet::lastUpdateTime)).setter(setter(Builder::lastUpdateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdateTime").build()).build();
private static final SdkField RESOURCE_SET_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceSetStatus").getter(getter(ResourceSet::resourceSetStatusAsString))
.setter(setter(Builder::resourceSetStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceSetStatus").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, NAME_FIELD,
DESCRIPTION_FIELD, UPDATE_TOKEN_FIELD, RESOURCE_TYPE_LIST_FIELD, LAST_UPDATE_TIME_FIELD, RESOURCE_SET_STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String name;
private final String description;
private final String updateToken;
private final List resourceTypeList;
private final Instant lastUpdateTime;
private final String resourceSetStatus;
private ResourceSet(BuilderImpl builder) {
this.id = builder.id;
this.name = builder.name;
this.description = builder.description;
this.updateToken = builder.updateToken;
this.resourceTypeList = builder.resourceTypeList;
this.lastUpdateTime = builder.lastUpdateTime;
this.resourceSetStatus = builder.resourceSetStatus;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String id() {
return id;
}
/**
*
* The descriptive name of the resource set. You can't change the name of a resource set after you create it.
*
*
* @return The descriptive name of the resource set. You can't change the name of a resource set after you create
* it.
*/
public final String name() {
return name;
}
/**
*
* A description of the resource set.
*
*
* @return A description of the resource set.
*/
public final String description() {
return description;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String updateToken() {
return updateToken;
}
/**
* 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 {@code 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.
*/
public final boolean hasResourceTypeList() {
return resourceTypeList != null && !(resourceTypeList instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasResourceTypeList} method.
*
*
* @return 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.
*/
public final List resourceTypeList() {
return resourceTypeList;
}
/**
*
* The last time that the resource set was changed.
*
*
* @return The last time that the resource set was changed.
*/
public final Instant lastUpdateTime() {
return lastUpdateTime;
}
/**
*
* Indicates whether the resource set is in or out of an admin's Region scope.
*
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the
* resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
* be protected.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resourceSetStatus}
* will return {@link ResourceSetStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #resourceSetStatusAsString}.
*
*
* @return Indicates whether the resource set is in or out of an admin's Region scope.
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or
* delete the resource set. Existing protections stay in place. Any new resource that come into scope of the
* resource set won't be protected.
*
*
* @see ResourceSetStatus
*/
public final ResourceSetStatus resourceSetStatus() {
return ResourceSetStatus.fromValue(resourceSetStatus);
}
/**
*
* Indicates whether the resource set is in or out of an admin's Region scope.
*
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the
* resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
* be protected.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resourceSetStatus}
* will return {@link ResourceSetStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #resourceSetStatusAsString}.
*
*
* @return Indicates whether the resource set is in or out of an admin's Region scope.
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or
* delete the resource set. Existing protections stay in place. Any new resource that come into scope of the
* resource set won't be protected.
*
*
* @see ResourceSetStatus
*/
public final String resourceSetStatusAsString() {
return resourceSetStatus;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(updateToken());
hashCode = 31 * hashCode + Objects.hashCode(hasResourceTypeList() ? resourceTypeList() : null);
hashCode = 31 * hashCode + Objects.hashCode(lastUpdateTime());
hashCode = 31 * hashCode + Objects.hashCode(resourceSetStatusAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ResourceSet)) {
return false;
}
ResourceSet other = (ResourceSet) obj;
return Objects.equals(id(), other.id()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description()) && Objects.equals(updateToken(), other.updateToken())
&& hasResourceTypeList() == other.hasResourceTypeList()
&& Objects.equals(resourceTypeList(), other.resourceTypeList())
&& Objects.equals(lastUpdateTime(), other.lastUpdateTime())
&& Objects.equals(resourceSetStatusAsString(), other.resourceSetStatusAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ResourceSet").add("Id", id()).add("Name", name()).add("Description", description())
.add("UpdateToken", updateToken()).add("ResourceTypeList", hasResourceTypeList() ? resourceTypeList() : null)
.add("LastUpdateTime", lastUpdateTime()).add("ResourceSetStatus", resourceSetStatusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "UpdateToken":
return Optional.ofNullable(clazz.cast(updateToken()));
case "ResourceTypeList":
return Optional.ofNullable(clazz.cast(resourceTypeList()));
case "LastUpdateTime":
return Optional.ofNullable(clazz.cast(lastUpdateTime()));
case "ResourceSetStatus":
return Optional.ofNullable(clazz.cast(resourceSetStatusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResourceSet) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The descriptive name of the resource set. You can't change the name of a resource set after you create it.
*
*
* @param name
* The descriptive name of the resource set. You can't change the name of a resource set after you create
* it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A description of the resource set.
*
*
* @param description
* A description of the resource set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updateToken(String updateToken);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceTypeList(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceTypeList(String... resourceTypeList);
/**
*
* The last time that the resource set was changed.
*
*
* @param lastUpdateTime
* The last time that the resource set was changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdateTime(Instant lastUpdateTime);
/**
*
* Indicates whether the resource set is in or out of an admin's Region scope.
*
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete
* the resource set. Existing protections stay in place. Any new resource that come into scope of the resource
* set won't be protected.
*
*
*
*
* @param resourceSetStatus
* Indicates whether the resource set is in or out of an admin's Region scope.
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or
* delete the resource set. Existing protections stay in place. Any new resource that come into scope of
* the resource set won't be protected.
*
*
* @see ResourceSetStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceSetStatus
*/
Builder resourceSetStatus(String resourceSetStatus);
/**
*
* Indicates whether the resource set is in or out of an admin's Region scope.
*
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete
* the resource set. Existing protections stay in place. Any new resource that come into scope of the resource
* set won't be protected.
*
*
*
*
* @param resourceSetStatus
* Indicates whether the resource set is in or out of an admin's Region scope.
*
* -
*
* ACTIVE - The administrator can manage and delete the resource set.
*
*
* -
*
* OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or
* delete the resource set. Existing protections stay in place. Any new resource that come into scope of
* the resource set won't be protected.
*
*
* @see ResourceSetStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceSetStatus
*/
Builder resourceSetStatus(ResourceSetStatus resourceSetStatus);
}
static final class BuilderImpl implements Builder {
private String id;
private String name;
private String description;
private String updateToken;
private List resourceTypeList = DefaultSdkAutoConstructList.getInstance();
private Instant lastUpdateTime;
private String resourceSetStatus;
private BuilderImpl() {
}
private BuilderImpl(ResourceSet model) {
id(model.id);
name(model.name);
description(model.description);
updateToken(model.updateToken);
resourceTypeList(model.resourceTypeList);
lastUpdateTime(model.lastUpdateTime);
resourceSetStatus(model.resourceSetStatus);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getUpdateToken() {
return updateToken;
}
public final void setUpdateToken(String updateToken) {
this.updateToken = updateToken;
}
@Override
public final Builder updateToken(String updateToken) {
this.updateToken = updateToken;
return this;
}
public final Collection getResourceTypeList() {
if (resourceTypeList instanceof SdkAutoConstructList) {
return null;
}
return resourceTypeList;
}
public final void setResourceTypeList(Collection resourceTypeList) {
this.resourceTypeList = ResourceTypeListCopier.copy(resourceTypeList);
}
@Override
public final Builder resourceTypeList(Collection resourceTypeList) {
this.resourceTypeList = ResourceTypeListCopier.copy(resourceTypeList);
return this;
}
@Override
@SafeVarargs
public final Builder resourceTypeList(String... resourceTypeList) {
resourceTypeList(Arrays.asList(resourceTypeList));
return this;
}
public final Instant getLastUpdateTime() {
return lastUpdateTime;
}
public final void setLastUpdateTime(Instant lastUpdateTime) {
this.lastUpdateTime = lastUpdateTime;
}
@Override
public final Builder lastUpdateTime(Instant lastUpdateTime) {
this.lastUpdateTime = lastUpdateTime;
return this;
}
public final String getResourceSetStatus() {
return resourceSetStatus;
}
public final void setResourceSetStatus(String resourceSetStatus) {
this.resourceSetStatus = resourceSetStatus;
}
@Override
public final Builder resourceSetStatus(String resourceSetStatus) {
this.resourceSetStatus = resourceSetStatus;
return this;
}
@Override
public final Builder resourceSetStatus(ResourceSetStatus resourceSetStatus) {
this.resourceSetStatus(resourceSetStatus == null ? null : resourceSetStatus.toString());
return this;
}
@Override
public ResourceSet build() {
return new ResourceSet(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}