software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest Maven / Gradle / Ivy
Show all versions of autoscaling 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.autoscaling.model;
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.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 DescribePoliciesRequest extends AutoScalingRequest implements
ToCopyableBuilder {
private static final SdkField AUTO_SCALING_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AutoScalingGroupName").getter(getter(DescribePoliciesRequest::autoScalingGroupName))
.setter(setter(Builder::autoScalingGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AutoScalingGroupName").build())
.build();
private static final SdkField> POLICY_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PolicyNames")
.getter(getter(DescribePoliciesRequest::policyNames))
.setter(setter(Builder::policyNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyNames").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> POLICY_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PolicyTypes")
.getter(getter(DescribePoliciesRequest::policyTypes))
.setter(setter(Builder::policyTypes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyTypes").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(DescribePoliciesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribePoliciesRequest::maxRecords)).setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTO_SCALING_GROUP_NAME_FIELD,
POLICY_NAMES_FIELD, POLICY_TYPES_FIELD, NEXT_TOKEN_FIELD, MAX_RECORDS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("AutoScalingGroupName", AUTO_SCALING_GROUP_NAME_FIELD);
put("PolicyNames", POLICY_NAMES_FIELD);
put("PolicyTypes", POLICY_TYPES_FIELD);
put("NextToken", NEXT_TOKEN_FIELD);
put("MaxRecords", MAX_RECORDS_FIELD);
}
});
private final String autoScalingGroupName;
private final List policyNames;
private final List policyTypes;
private final String nextToken;
private final Integer maxRecords;
private DescribePoliciesRequest(BuilderImpl builder) {
super(builder);
this.autoScalingGroupName = builder.autoScalingGroupName;
this.policyNames = builder.policyNames;
this.policyTypes = builder.policyTypes;
this.nextToken = builder.nextToken;
this.maxRecords = builder.maxRecords;
}
/**
*
* The name of the Auto Scaling group.
*
*
* @return The name of the Auto Scaling group.
*/
public final String autoScalingGroupName() {
return autoScalingGroupName;
}
/**
* For responses, this returns true if the service returned a value for the PolicyNames 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 hasPolicyNames() {
return policyNames != null && !(policyNames instanceof SdkAutoConstructList);
}
/**
*
* The names of one or more policies. If you omit this property, all policies are described. If a group name is
* provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no
* error.
*
*
* Array Members: Maximum number of 50 items.
*
*
* 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 #hasPolicyNames} method.
*
*
* @return The names of one or more policies. If you omit this property, all policies are described. If a group name
* is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored
* with no error.
*
* Array Members: Maximum number of 50 items.
*/
public final List policyNames() {
return policyNames;
}
/**
* For responses, this returns true if the service returned a value for the PolicyTypes 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 hasPolicyTypes() {
return policyTypes != null && !(policyTypes instanceof SdkAutoConstructList);
}
/**
*
* One or more policy types. The valid values are SimpleScaling, StepScaling,
* TargetTrackingScaling, and PredictiveScaling.
*
*
* 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 #hasPolicyTypes} method.
*
*
* @return One or more policy types. The valid values are SimpleScaling, StepScaling,
* TargetTrackingScaling, and PredictiveScaling.
*/
public final List policyTypes() {
return policyTypes;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @return The token for the next set of items to return. (You received this token from a previous call.)
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of items to be returned with each call. The default value is 50 and the maximum
* value is 100.
*
*
* @return The maximum number of items to be returned with each call. The default value is 50 and the
* maximum value is 100.
*/
public final Integer maxRecords() {
return maxRecords;
}
@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(autoScalingGroupName());
hashCode = 31 * hashCode + Objects.hashCode(hasPolicyNames() ? policyNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasPolicyTypes() ? policyTypes() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
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 DescribePoliciesRequest)) {
return false;
}
DescribePoliciesRequest other = (DescribePoliciesRequest) obj;
return Objects.equals(autoScalingGroupName(), other.autoScalingGroupName()) && hasPolicyNames() == other.hasPolicyNames()
&& Objects.equals(policyNames(), other.policyNames()) && hasPolicyTypes() == other.hasPolicyTypes()
&& Objects.equals(policyTypes(), other.policyTypes()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxRecords(), other.maxRecords());
}
/**
* 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("DescribePoliciesRequest").add("AutoScalingGroupName", autoScalingGroupName())
.add("PolicyNames", hasPolicyNames() ? policyNames() : null)
.add("PolicyTypes", hasPolicyTypes() ? policyTypes() : null).add("NextToken", nextToken())
.add("MaxRecords", maxRecords()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AutoScalingGroupName":
return Optional.ofNullable(clazz.cast(autoScalingGroupName()));
case "PolicyNames":
return Optional.ofNullable(clazz.cast(policyNames()));
case "PolicyTypes":
return Optional.ofNullable(clazz.cast(policyTypes()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribePoliciesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the Auto Scaling group.
*
*
* @param autoScalingGroupName
* The name of the Auto Scaling group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder autoScalingGroupName(String autoScalingGroupName);
/**
*
* The names of one or more policies. If you omit this property, all policies are described. If a group name is
* provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no
* error.
*
*
* Array Members: Maximum number of 50 items.
*
*
* @param policyNames
* The names of one or more policies. If you omit this property, all policies are described. If a group
* name is provided, the results are limited to that group. If you specify an unknown policy name, it is
* ignored with no error.
*
* Array Members: Maximum number of 50 items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyNames(Collection policyNames);
/**
*
* The names of one or more policies. If you omit this property, all policies are described. If a group name is
* provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no
* error.
*
*
* Array Members: Maximum number of 50 items.
*
*
* @param policyNames
* The names of one or more policies. If you omit this property, all policies are described. If a group
* name is provided, the results are limited to that group. If you specify an unknown policy name, it is
* ignored with no error.
*
* Array Members: Maximum number of 50 items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyNames(String... policyNames);
/**
*
* One or more policy types. The valid values are SimpleScaling, StepScaling,
* TargetTrackingScaling, and PredictiveScaling.
*
*
* @param policyTypes
* One or more policy types. The valid values are SimpleScaling, StepScaling,
* TargetTrackingScaling, and PredictiveScaling.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyTypes(Collection policyTypes);
/**
*
* One or more policy types. The valid values are SimpleScaling, StepScaling,
* TargetTrackingScaling, and PredictiveScaling.
*
*
* @param policyTypes
* One or more policy types. The valid values are SimpleScaling, StepScaling,
* TargetTrackingScaling, and PredictiveScaling.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyTypes(String... policyTypes);
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @param nextToken
* The token for the next set of items to return. (You received this token from a previous call.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of items to be returned with each call. The default value is 50 and the
* maximum value is 100.
*
*
* @param maxRecords
* The maximum number of items to be returned with each call. The default value is 50 and
* the maximum value is 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(Integer maxRecords);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AutoScalingRequest.BuilderImpl implements Builder {
private String autoScalingGroupName;
private List policyNames = DefaultSdkAutoConstructList.getInstance();
private List policyTypes = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxRecords;
private BuilderImpl() {
}
private BuilderImpl(DescribePoliciesRequest model) {
super(model);
autoScalingGroupName(model.autoScalingGroupName);
policyNames(model.policyNames);
policyTypes(model.policyTypes);
nextToken(model.nextToken);
maxRecords(model.maxRecords);
}
public final String getAutoScalingGroupName() {
return autoScalingGroupName;
}
public final void setAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
}
@Override
public final Builder autoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
return this;
}
public final Collection getPolicyNames() {
if (policyNames instanceof SdkAutoConstructList) {
return null;
}
return policyNames;
}
public final void setPolicyNames(Collection policyNames) {
this.policyNames = PolicyNamesCopier.copy(policyNames);
}
@Override
public final Builder policyNames(Collection policyNames) {
this.policyNames = PolicyNamesCopier.copy(policyNames);
return this;
}
@Override
@SafeVarargs
public final Builder policyNames(String... policyNames) {
policyNames(Arrays.asList(policyNames));
return this;
}
public final Collection getPolicyTypes() {
if (policyTypes instanceof SdkAutoConstructList) {
return null;
}
return policyTypes;
}
public final void setPolicyTypes(Collection policyTypes) {
this.policyTypes = PolicyTypesCopier.copy(policyTypes);
}
@Override
public final Builder policyTypes(Collection policyTypes) {
this.policyTypes = PolicyTypesCopier.copy(policyTypes);
return this;
}
@Override
@SafeVarargs
public final Builder policyTypes(String... policyTypes) {
policyTypes(Arrays.asList(policyTypes));
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;
}
public final Integer getMaxRecords() {
return maxRecords;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
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 DescribePoliciesRequest build() {
return new DescribePoliciesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}