software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest Maven / Gradle / Ivy
Show all versions of config 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.config.model;
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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetComplianceDetailsByConfigRuleRequest extends ConfigRequest implements
ToCopyableBuilder {
private static final SdkField CONFIG_RULE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConfigRuleName").getter(getter(GetComplianceDetailsByConfigRuleRequest::configRuleName))
.setter(setter(Builder::configRuleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConfigRuleName").build()).build();
private static final SdkField> COMPLIANCE_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ComplianceTypes")
.getter(getter(GetComplianceDetailsByConfigRuleRequest::complianceTypesAsStrings))
.setter(setter(Builder::complianceTypesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ComplianceTypes").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 LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Limit")
.getter(getter(GetComplianceDetailsByConfigRuleRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Limit").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(GetComplianceDetailsByConfigRuleRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONFIG_RULE_NAME_FIELD,
COMPLIANCE_TYPES_FIELD, LIMIT_FIELD, NEXT_TOKEN_FIELD));
private final String configRuleName;
private final List complianceTypes;
private final Integer limit;
private final String nextToken;
private GetComplianceDetailsByConfigRuleRequest(BuilderImpl builder) {
super(builder);
this.configRuleName = builder.configRuleName;
this.complianceTypes = builder.complianceTypes;
this.limit = builder.limit;
this.nextToken = builder.nextToken;
}
/**
*
* The name of the Config rule for which you want compliance information.
*
*
* @return The name of the Config rule for which you want compliance information.
*/
public final String configRuleName() {
return configRuleName;
}
/**
*
* Filters the results by compliance.
*
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot
* be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for
* filtering results.
*
*
* 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 #hasComplianceTypes} method.
*
*
* @return Filters the results by compliance.
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config
* rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a
* ComplianceType for filtering results.
*/
public final List complianceTypes() {
return ComplianceTypesCopier.copyStringToEnum(complianceTypes);
}
/**
* For responses, this returns true if the service returned a value for the ComplianceTypes 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 hasComplianceTypes() {
return complianceTypes != null && !(complianceTypes instanceof SdkAutoConstructList);
}
/**
*
* Filters the results by compliance.
*
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot
* be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for
* filtering results.
*
*
* 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 #hasComplianceTypes} method.
*
*
* @return Filters the results by compliance.
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config
* rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a
* ComplianceType for filtering results.
*/
public final List complianceTypesAsStrings() {
return complianceTypes;
}
/**
*
* The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number
* greater than 100. If you specify 0, Config uses the default.
*
*
* @return The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a
* number greater than 100. If you specify 0, Config uses the default.
*/
public final Integer limit() {
return limit;
}
/**
*
* The nextToken string returned on a previous page that you use to get the next page of results in a
* paginated response.
*
*
* @return The nextToken string returned on a previous page that you use to get the next page of
* results in a paginated response.
*/
public final String nextToken() {
return nextToken;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(configRuleName());
hashCode = 31 * hashCode + Objects.hashCode(hasComplianceTypes() ? complianceTypesAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(limit());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetComplianceDetailsByConfigRuleRequest)) {
return false;
}
GetComplianceDetailsByConfigRuleRequest other = (GetComplianceDetailsByConfigRuleRequest) obj;
return Objects.equals(configRuleName(), other.configRuleName()) && hasComplianceTypes() == other.hasComplianceTypes()
&& Objects.equals(complianceTypesAsStrings(), other.complianceTypesAsStrings())
&& Objects.equals(limit(), other.limit()) && Objects.equals(nextToken(), other.nextToken());
}
/**
* 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("GetComplianceDetailsByConfigRuleRequest").add("ConfigRuleName", configRuleName())
.add("ComplianceTypes", hasComplianceTypes() ? complianceTypesAsStrings() : null).add("Limit", limit())
.add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConfigRuleName":
return Optional.ofNullable(clazz.cast(configRuleName()));
case "ComplianceTypes":
return Optional.ofNullable(clazz.cast(complianceTypesAsStrings()));
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetComplianceDetailsByConfigRuleRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConfigRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the Config rule for which you want compliance information.
*
*
* @param configRuleName
* The name of the Config rule for which you want compliance information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configRuleName(String configRuleName);
/**
*
* Filters the results by compliance.
*
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule
* cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType
* for filtering results.
*
*
* @param complianceTypes
* Filters the results by compliance.
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config
* rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a
* ComplianceType for filtering results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceTypesWithStrings(Collection complianceTypes);
/**
*
* Filters the results by compliance.
*
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule
* cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType
* for filtering results.
*
*
* @param complianceTypes
* Filters the results by compliance.
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config
* rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a
* ComplianceType for filtering results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceTypesWithStrings(String... complianceTypes);
/**
*
* Filters the results by compliance.
*
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule
* cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType
* for filtering results.
*
*
* @param complianceTypes
* Filters the results by compliance.
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config
* rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a
* ComplianceType for filtering results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceTypes(Collection complianceTypes);
/**
*
* Filters the results by compliance.
*
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule
* cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType
* for filtering results.
*
*
* @param complianceTypes
* Filters the results by compliance.
*
* INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config
* rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a
* ComplianceType for filtering results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder complianceTypes(ComplianceType... complianceTypes);
/**
*
* The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a
* number greater than 100. If you specify 0, Config uses the default.
*
*
* @param limit
* The maximum number of evaluation results returned on each page. The default is 10. You cannot specify
* a number greater than 100. If you specify 0, Config uses the default.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
/**
*
* The nextToken string returned on a previous page that you use to get the next page of results in
* a paginated response.
*
*
* @param nextToken
* The nextToken string returned on a previous page that you use to get the next page of
* results in a paginated response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConfigRequest.BuilderImpl implements Builder {
private String configRuleName;
private List complianceTypes = DefaultSdkAutoConstructList.getInstance();
private Integer limit;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(GetComplianceDetailsByConfigRuleRequest model) {
super(model);
configRuleName(model.configRuleName);
complianceTypesWithStrings(model.complianceTypes);
limit(model.limit);
nextToken(model.nextToken);
}
public final String getConfigRuleName() {
return configRuleName;
}
public final void setConfigRuleName(String configRuleName) {
this.configRuleName = configRuleName;
}
@Override
public final Builder configRuleName(String configRuleName) {
this.configRuleName = configRuleName;
return this;
}
public final Collection getComplianceTypes() {
if (complianceTypes instanceof SdkAutoConstructList) {
return null;
}
return complianceTypes;
}
public final void setComplianceTypes(Collection complianceTypes) {
this.complianceTypes = ComplianceTypesCopier.copy(complianceTypes);
}
@Override
public final Builder complianceTypesWithStrings(Collection complianceTypes) {
this.complianceTypes = ComplianceTypesCopier.copy(complianceTypes);
return this;
}
@Override
@SafeVarargs
public final Builder complianceTypesWithStrings(String... complianceTypes) {
complianceTypesWithStrings(Arrays.asList(complianceTypes));
return this;
}
@Override
public final Builder complianceTypes(Collection complianceTypes) {
this.complianceTypes = ComplianceTypesCopier.copyEnumToString(complianceTypes);
return this;
}
@Override
@SafeVarargs
public final Builder complianceTypes(ComplianceType... complianceTypes) {
complianceTypes(Arrays.asList(complianceTypes));
return this;
}
public final Integer getLimit() {
return limit;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetComplianceDetailsByConfigRuleRequest build() {
return new GetComplianceDetailsByConfigRuleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}