software.amazon.awssdk.services.backup.model.ControlScope Maven / Gradle / Ivy
Show all versions of backup 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.backup.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A framework consists of one or more controls. Each control has its own control scope. The control scope can include
* one or more resource types, a combination of a tag key and value, or a combination of one resource type and one
* resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording
* group changes in configuration.
*
*
*
* To set a control scope that includes all of a particular resource, leave the ControlScope empty or do
* not pass it when calling CreateFramework.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ControlScope implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> COMPLIANCE_RESOURCE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ComplianceResourceIds")
.getter(getter(ControlScope::complianceResourceIds))
.setter(setter(Builder::complianceResourceIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ComplianceResourceIds").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> COMPLIANCE_RESOURCE_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ComplianceResourceTypes")
.getter(getter(ControlScope::complianceResourceTypes))
.setter(setter(Builder::complianceResourceTypes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ComplianceResourceTypes").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> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(ControlScope::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COMPLIANCE_RESOURCE_IDS_FIELD,
COMPLIANCE_RESOURCE_TYPES_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final List complianceResourceIds;
private final List complianceResourceTypes;
private final Map tags;
private ControlScope(BuilderImpl builder) {
this.complianceResourceIds = builder.complianceResourceIds;
this.complianceResourceTypes = builder.complianceResourceTypes;
this.tags = builder.tags;
}
/**
* For responses, this returns true if the service returned a value for the ComplianceResourceIds 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 hasComplianceResourceIds() {
return complianceResourceIds != null && !(complianceResourceIds instanceof SdkAutoConstructList);
}
/**
*
* The ID of the only Amazon Web Services resource that you want your control scope to contain.
*
*
* 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 #hasComplianceResourceIds} method.
*
*
* @return The ID of the only Amazon Web Services resource that you want your control scope to contain.
*/
public final List complianceResourceIds() {
return complianceResourceIds;
}
/**
* For responses, this returns true if the service returned a value for the ComplianceResourceTypes 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 hasComplianceResourceTypes() {
return complianceResourceTypes != null && !(complianceResourceTypes instanceof SdkAutoConstructList);
}
/**
*
* Describes whether the control scope includes one or more types of resources, such as EFS or
* RDS.
*
*
* 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 #hasComplianceResourceTypes} method.
*
*
* @return Describes whether the control scope includes one or more types of resources, such as EFS or
* RDS.
*/
public final List complianceResourceTypes() {
return complianceResourceTypes;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for
* a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty
* string if you are creating or editing a framework from the console (though the value can be an empty string when
* included in a CloudFormation template).
*
*
* The structure to assign a tag is: [{"Key":"string","Value":"string"}].
*
*
* 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 #hasTags} method.
*
*
* @return The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an
* evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it
* cannot be an empty string if you are creating or editing a framework from the console (though the value
* can be an empty string when included in a CloudFormation template).
*
* The structure to assign a tag is: [{"Key":"string","Value":"string"}].
*/
public final Map tags() {
return tags;
}
@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(hasComplianceResourceIds() ? complianceResourceIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasComplianceResourceTypes() ? complianceResourceTypes() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 ControlScope)) {
return false;
}
ControlScope other = (ControlScope) obj;
return hasComplianceResourceIds() == other.hasComplianceResourceIds()
&& Objects.equals(complianceResourceIds(), other.complianceResourceIds())
&& hasComplianceResourceTypes() == other.hasComplianceResourceTypes()
&& Objects.equals(complianceResourceTypes(), other.complianceResourceTypes()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("ControlScope")
.add("ComplianceResourceIds", hasComplianceResourceIds() ? complianceResourceIds() : null)
.add("ComplianceResourceTypes", hasComplianceResourceTypes() ? complianceResourceTypes() : null)
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ComplianceResourceIds":
return Optional.ofNullable(clazz.cast(complianceResourceIds()));
case "ComplianceResourceTypes":
return Optional.ofNullable(clazz.cast(complianceResourceTypes()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("ComplianceResourceIds", COMPLIANCE_RESOURCE_IDS_FIELD);
map.put("ComplianceResourceTypes", COMPLIANCE_RESOURCE_TYPES_FIELD);
map.put("Tags", TAGS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ControlScope) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of the only Amazon Web Services resource that you want your control scope to contain.
*
*
* @param complianceResourceIds
* The ID of the only Amazon Web Services resource that you want your control scope to contain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceResourceIds(Collection complianceResourceIds);
/**
*
* The ID of the only Amazon Web Services resource that you want your control scope to contain.
*
*
* @param complianceResourceIds
* The ID of the only Amazon Web Services resource that you want your control scope to contain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceResourceIds(String... complianceResourceIds);
/**
*
* Describes whether the control scope includes one or more types of resources, such as EFS or
* RDS.
*
*
* @param complianceResourceTypes
* Describes whether the control scope includes one or more types of resources, such as EFS
* or RDS.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceResourceTypes(Collection complianceResourceTypes);
/**
*
* Describes whether the control scope includes one or more types of resources, such as EFS or
* RDS.
*
*
* @param complianceResourceTypes
* Describes whether the control scope includes one or more types of resources, such as EFS
* or RDS.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceResourceTypes(String... complianceResourceTypes);
/**
*
* The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation
* for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an
* empty string if you are creating or editing a framework from the console (though the value can be an empty
* string when included in a CloudFormation template).
*
*
* The structure to assign a tag is: [{"Key":"string","Value":"string"}].
*
*
* @param tags
* The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an
* evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but
* it cannot be an empty string if you are creating or editing a framework from the console (though the
* value can be an empty string when included in a CloudFormation template).
*
* The structure to assign a tag is: [{"Key":"string","Value":"string"}].
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl implements Builder {
private List complianceResourceIds = DefaultSdkAutoConstructList.getInstance();
private List complianceResourceTypes = DefaultSdkAutoConstructList.getInstance();
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ControlScope model) {
complianceResourceIds(model.complianceResourceIds);
complianceResourceTypes(model.complianceResourceTypes);
tags(model.tags);
}
public final Collection getComplianceResourceIds() {
if (complianceResourceIds instanceof SdkAutoConstructList) {
return null;
}
return complianceResourceIds;
}
public final void setComplianceResourceIds(Collection complianceResourceIds) {
this.complianceResourceIds = ComplianceResourceIdListCopier.copy(complianceResourceIds);
}
@Override
public final Builder complianceResourceIds(Collection complianceResourceIds) {
this.complianceResourceIds = ComplianceResourceIdListCopier.copy(complianceResourceIds);
return this;
}
@Override
@SafeVarargs
public final Builder complianceResourceIds(String... complianceResourceIds) {
complianceResourceIds(Arrays.asList(complianceResourceIds));
return this;
}
public final Collection getComplianceResourceTypes() {
if (complianceResourceTypes instanceof SdkAutoConstructList) {
return null;
}
return complianceResourceTypes;
}
public final void setComplianceResourceTypes(Collection complianceResourceTypes) {
this.complianceResourceTypes = ResourceTypeListCopier.copy(complianceResourceTypes);
}
@Override
public final Builder complianceResourceTypes(Collection complianceResourceTypes) {
this.complianceResourceTypes = ResourceTypeListCopier.copy(complianceResourceTypes);
return this;
}
@Override
@SafeVarargs
public final Builder complianceResourceTypes(String... complianceResourceTypes) {
complianceResourceTypes(Arrays.asList(complianceResourceTypes));
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = _stringMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = _stringMapCopier.copy(tags);
return this;
}
@Override
public ControlScope build() {
return new ControlScope(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}