software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest 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.util.Arrays;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The input for DescribeStacks action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeStacksRequest extends CloudFormationRequest implements
ToCopyableBuilder {
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(DescribeStacksRequest::stackName)).setter(setter(Builder::stackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackName").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeStacksRequest::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(STACK_NAME_FIELD,
NEXT_TOKEN_FIELD));
private final String stackName;
private final String nextToken;
private DescribeStacksRequest(BuilderImpl builder) {
super(builder);
this.stackName = builder.stackName;
this.nextToken = builder.nextToken;
}
/**
*
* The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
*
*
* -
*
* Running stacks: You can specify either the stack's name or its unique stack ID.
*
*
* -
*
* Deleted stacks: You must specify the unique stack ID.
*
*
*
*
* Default: There is no default value.
*
*
* @return The name or the unique stack ID that's associated with the stack, which aren't always
* interchangeable:
*
* -
*
* Running stacks: You can specify either the stack's name or its unique stack ID.
*
*
* -
*
* Deleted stacks: You must specify the unique stack ID.
*
*
*
*
* Default: There is no default value.
*/
public final String stackName() {
return stackName;
}
/**
*
* A string that identifies the next page of stacks that you want to retrieve.
*
*
* @return A string that identifies the next page of stacks that you want to retrieve.
*/
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(stackName());
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 DescribeStacksRequest)) {
return false;
}
DescribeStacksRequest other = (DescribeStacksRequest) obj;
return Objects.equals(stackName(), other.stackName()) && 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("DescribeStacksRequest").add("StackName", stackName()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
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((DescribeStacksRequest) 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 or the unique stack ID that's associated with the stack, which aren't always interchangeable:
*
*
* -
*
* Running stacks: You can specify either the stack's name or its unique stack ID.
*
*
* -
*
* Deleted stacks: You must specify the unique stack ID.
*
*
*
*
* Default: There is no default value.
*
*
* @param stackName
* The name or the unique stack ID that's associated with the stack, which aren't always
* interchangeable:
*
* -
*
* Running stacks: You can specify either the stack's name or its unique stack ID.
*
*
* -
*
* Deleted stacks: You must specify the unique stack ID.
*
*
*
*
* Default: There is no default value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* A string that identifies the next page of stacks that you want to retrieve.
*
*
* @param nextToken
* A string that identifies the next page of stacks that you want to retrieve.
* @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 CloudFormationRequest.BuilderImpl implements Builder {
private String stackName;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeStacksRequest model) {
super(model);
stackName(model.stackName);
nextToken(model.nextToken);
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
public final Builder stackName(String stackName) {
this.stackName = stackName;
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 DescribeStacksRequest build() {
return new DescribeStacksRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}