software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest Maven / Gradle / Ivy
Show all versions of cloudformation 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.cloudformation.model;
import java.beans.Transient;
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 DescribeStackResourceDriftsRequest extends CloudFormationRequest implements
ToCopyableBuilder {
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(DescribeStackResourceDriftsRequest::stackName))
.setter(setter(Builder::stackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackName").build()).build();
private static final SdkField> STACK_RESOURCE_DRIFT_STATUS_FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StackResourceDriftStatusFilters")
.getter(getter(DescribeStackResourceDriftsRequest::stackResourceDriftStatusFiltersAsStrings))
.setter(setter(Builder::stackResourceDriftStatusFiltersWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackResourceDriftStatusFilters")
.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 NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeStackResourceDriftsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(DescribeStackResourceDriftsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STACK_NAME_FIELD,
STACK_RESOURCE_DRIFT_STATUS_FILTERS_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String stackName;
private final List stackResourceDriftStatusFilters;
private final String nextToken;
private final Integer maxResults;
private DescribeStackResourceDriftsRequest(BuilderImpl builder) {
super(builder);
this.stackName = builder.stackName;
this.stackResourceDriftStatusFilters = builder.stackResourceDriftStatusFilters;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The name of the stack for which you want drift information.
*
*
* @return The name of the stack for which you want drift information.
*/
public final String stackName() {
return stackName;
}
/**
*
* The resource drift status values to use as filters for the resource drift results returned.
*
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource has been
* deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*
*
* 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 #hasStackResourceDriftStatusFilters}
* method.
*
*
* @return The resource drift status values to use as filters for the resource drift results returned.
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource
* has been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*/
public final List stackResourceDriftStatusFilters() {
return StackResourceDriftStatusFiltersCopier.copyStringToEnum(stackResourceDriftStatusFilters);
}
/**
* For responses, this returns true if the service returned a value for the StackResourceDriftStatusFilters
* 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 hasStackResourceDriftStatusFilters() {
return stackResourceDriftStatusFilters != null && !(stackResourceDriftStatusFilters instanceof SdkAutoConstructList);
}
/**
*
* The resource drift status values to use as filters for the resource drift results returned.
*
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource has been
* deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*
*
* 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 #hasStackResourceDriftStatusFilters}
* method.
*
*
* @return The resource drift status values to use as filters for the resource drift results returned.
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource
* has been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*/
public final List stackResourceDriftStatusFiltersAsStrings() {
return stackResourceDriftStatusFilters;
}
/**
*
* A string that identifies the next page of stack resource drift results.
*
*
* @return A string that identifies the next page of stack resource drift results.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of results to be returned with a single call. If the number of available results exceeds this
* maximum, the response includes a NextToken value that you can assign to the NextToken
* request parameter to get the next set of results.
*
*
* @return The maximum number of results to be returned with a single call. If the number of available results
* exceeds this maximum, the response includes a NextToken value that you can assign to the
* NextToken request parameter to get the next set of results.
*/
public final Integer maxResults() {
return maxResults;
}
@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(stackName());
hashCode = 31 * hashCode
+ Objects.hashCode(hasStackResourceDriftStatusFilters() ? stackResourceDriftStatusFiltersAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 DescribeStackResourceDriftsRequest)) {
return false;
}
DescribeStackResourceDriftsRequest other = (DescribeStackResourceDriftsRequest) obj;
return Objects.equals(stackName(), other.stackName())
&& hasStackResourceDriftStatusFilters() == other.hasStackResourceDriftStatusFilters()
&& Objects.equals(stackResourceDriftStatusFiltersAsStrings(), other.stackResourceDriftStatusFiltersAsStrings())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("DescribeStackResourceDriftsRequest")
.add("StackName", stackName())
.add("StackResourceDriftStatusFilters",
hasStackResourceDriftStatusFilters() ? stackResourceDriftStatusFiltersAsStrings() : null)
.add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
case "StackResourceDriftStatusFilters":
return Optional.ofNullable(clazz.cast(stackResourceDriftStatusFiltersAsStrings()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeStackResourceDriftsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudFormationRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the stack for which you want drift information.
*
*
* @param stackName
* The name of the stack for which you want drift information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* The resource drift status values to use as filters for the resource drift results returned.
*
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource has
* been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*
*
* @param stackResourceDriftStatusFilters
* The resource drift status values to use as filters for the resource drift results returned.
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the
* resource has been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template
* configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackResourceDriftStatusFiltersWithStrings(Collection stackResourceDriftStatusFilters);
/**
*
* The resource drift status values to use as filters for the resource drift results returned.
*
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource has
* been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*
*
* @param stackResourceDriftStatusFilters
* The resource drift status values to use as filters for the resource drift results returned.
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the
* resource has been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template
* configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackResourceDriftStatusFiltersWithStrings(String... stackResourceDriftStatusFilters);
/**
*
* The resource drift status values to use as filters for the resource drift results returned.
*
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource has
* been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*
*
* @param stackResourceDriftStatusFilters
* The resource drift status values to use as filters for the resource drift results returned.
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the
* resource has been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template
* configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackResourceDriftStatusFilters(Collection stackResourceDriftStatusFilters);
/**
*
* The resource drift status values to use as filters for the resource drift results returned.
*
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the resource has
* been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
*
*
* @param stackResourceDriftStatusFilters
* The resource drift status values to use as filters for the resource drift results returned.
*
* -
*
* DELETED: The resource differs from its expected template configuration in that the
* resource has been deleted.
*
*
* -
*
* MODIFIED: One or more resource properties differ from their expected template values.
*
*
* -
*
* IN_SYNC: The resources's actual configuration matches its expected template
* configuration.
*
*
* -
*
* NOT_CHECKED: CloudFormation does not currently return this value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackResourceDriftStatusFilters(StackResourceDriftStatus... stackResourceDriftStatusFilters);
/**
*
* A string that identifies the next page of stack resource drift results.
*
*
* @param nextToken
* A string that identifies the next page of stack resource drift results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of results to be returned with a single call. If the number of available results exceeds
* this maximum, the response includes a NextToken value that you can assign to the
* NextToken request parameter to get the next set of results.
*
*
* @param maxResults
* The maximum number of results to be returned with a single call. If the number of available results
* exceeds this maximum, the response includes a NextToken value that you can assign to the
* NextToken request parameter to get the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudFormationRequest.BuilderImpl implements Builder {
private String stackName;
private List stackResourceDriftStatusFilters = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(DescribeStackResourceDriftsRequest model) {
super(model);
stackName(model.stackName);
stackResourceDriftStatusFiltersWithStrings(model.stackResourceDriftStatusFilters);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
@Transient
public final Builder stackName(String stackName) {
this.stackName = stackName;
return this;
}
public final Collection getStackResourceDriftStatusFilters() {
if (stackResourceDriftStatusFilters instanceof SdkAutoConstructList) {
return null;
}
return stackResourceDriftStatusFilters;
}
public final void setStackResourceDriftStatusFilters(Collection stackResourceDriftStatusFilters) {
this.stackResourceDriftStatusFilters = StackResourceDriftStatusFiltersCopier.copy(stackResourceDriftStatusFilters);
}
@Override
@Transient
public final Builder stackResourceDriftStatusFiltersWithStrings(Collection stackResourceDriftStatusFilters) {
this.stackResourceDriftStatusFilters = StackResourceDriftStatusFiltersCopier.copy(stackResourceDriftStatusFilters);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder stackResourceDriftStatusFiltersWithStrings(String... stackResourceDriftStatusFilters) {
stackResourceDriftStatusFiltersWithStrings(Arrays.asList(stackResourceDriftStatusFilters));
return this;
}
@Override
@Transient
public final Builder stackResourceDriftStatusFilters(Collection stackResourceDriftStatusFilters) {
this.stackResourceDriftStatusFilters = StackResourceDriftStatusFiltersCopier
.copyEnumToString(stackResourceDriftStatusFilters);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder stackResourceDriftStatusFilters(StackResourceDriftStatus... stackResourceDriftStatusFilters) {
stackResourceDriftStatusFilters(Arrays.asList(stackResourceDriftStatusFilters));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
@Transient
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
@Transient
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
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 DescribeStackResourceDriftsRequest build() {
return new DescribeStackResourceDriftsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}