software.amazon.awssdk.services.outposts.model.StartCapacityTaskRequest Maven / Gradle / Ivy
Show all versions of outposts 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.outposts.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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 StartCapacityTaskRequest extends OutpostsRequest implements
ToCopyableBuilder {
private static final SdkField OUTPOST_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutpostIdentifier").getter(getter(StartCapacityTaskRequest::outpostIdentifier))
.setter(setter(Builder::outpostIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("OutpostId").build()).build();
private static final SdkField ORDER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OrderId").getter(getter(StartCapacityTaskRequest::orderId)).setter(setter(Builder::orderId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrderId").build()).build();
private static final SdkField> INSTANCE_POOLS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("InstancePools")
.getter(getter(StartCapacityTaskRequest::instancePools))
.setter(setter(Builder::instancePools))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstancePools").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(InstanceTypeCapacity::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DRY_RUN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DryRun").getter(getter(StartCapacityTaskRequest::dryRun)).setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OUTPOST_IDENTIFIER_FIELD,
ORDER_ID_FIELD, INSTANCE_POOLS_FIELD, DRY_RUN_FIELD));
private final String outpostIdentifier;
private final String orderId;
private final List instancePools;
private final Boolean dryRun;
private StartCapacityTaskRequest(BuilderImpl builder) {
super(builder);
this.outpostIdentifier = builder.outpostIdentifier;
this.orderId = builder.orderId;
this.instancePools = builder.instancePools;
this.dryRun = builder.dryRun;
}
/**
*
* The ID or ARN of the Outposts associated with the specified capacity task.
*
*
* @return The ID or ARN of the Outposts associated with the specified capacity task.
*/
public final String outpostIdentifier() {
return outpostIdentifier;
}
/**
*
* The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*
*
* @return The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*/
public final String orderId() {
return orderId;
}
/**
* For responses, this returns true if the service returned a value for the InstancePools 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 hasInstancePools() {
return instancePools != null && !(instancePools instanceof SdkAutoConstructList);
}
/**
*
* The instance pools specified in the capacity task.
*
*
* 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 #hasInstancePools} method.
*
*
* @return The instance pools specified in the capacity task.
*/
public final List instancePools() {
return instancePools;
}
/**
*
* You can request a dry run to determine if the instance type and instance size changes is above or below available
* instance capacity. Requesting a dry run does not make any changes to your plan.
*
*
* @return You can request a dry run to determine if the instance type and instance size changes is above or below
* available instance capacity. Requesting a dry run does not make any changes to your plan.
*/
public final Boolean dryRun() {
return dryRun;
}
@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(outpostIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(orderId());
hashCode = 31 * hashCode + Objects.hashCode(hasInstancePools() ? instancePools() : null);
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
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 StartCapacityTaskRequest)) {
return false;
}
StartCapacityTaskRequest other = (StartCapacityTaskRequest) obj;
return Objects.equals(outpostIdentifier(), other.outpostIdentifier()) && Objects.equals(orderId(), other.orderId())
&& hasInstancePools() == other.hasInstancePools() && Objects.equals(instancePools(), other.instancePools())
&& Objects.equals(dryRun(), other.dryRun());
}
/**
* 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("StartCapacityTaskRequest").add("OutpostIdentifier", outpostIdentifier())
.add("OrderId", orderId()).add("InstancePools", hasInstancePools() ? instancePools() : null)
.add("DryRun", dryRun()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OutpostIdentifier":
return Optional.ofNullable(clazz.cast(outpostIdentifier()));
case "OrderId":
return Optional.ofNullable(clazz.cast(orderId()));
case "InstancePools":
return Optional.ofNullable(clazz.cast(instancePools()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StartCapacityTaskRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OutpostsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID or ARN of the Outposts associated with the specified capacity task.
*
*
* @param outpostIdentifier
* The ID or ARN of the Outposts associated with the specified capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outpostIdentifier(String outpostIdentifier);
/**
*
* The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
*
*
* @param orderId
* The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder orderId(String orderId);
/**
*
* The instance pools specified in the capacity task.
*
*
* @param instancePools
* The instance pools specified in the capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instancePools(Collection instancePools);
/**
*
* The instance pools specified in the capacity task.
*
*
* @param instancePools
* The instance pools specified in the capacity task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instancePools(InstanceTypeCapacity... instancePools);
/**
*
* The instance pools specified in the capacity task.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.outposts.model.InstanceTypeCapacity.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.outposts.model.InstanceTypeCapacity#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.outposts.model.InstanceTypeCapacity.Builder#build()} is called
* immediately and its result is passed to {@link #instancePools(List)}.
*
* @param instancePools
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.outposts.model.InstanceTypeCapacity.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #instancePools(java.util.Collection)
*/
Builder instancePools(Consumer... instancePools);
/**
*
* You can request a dry run to determine if the instance type and instance size changes is above or below
* available instance capacity. Requesting a dry run does not make any changes to your plan.
*
*
* @param dryRun
* You can request a dry run to determine if the instance type and instance size changes is above or
* below available instance capacity. Requesting a dry run does not make any changes to your plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OutpostsRequest.BuilderImpl implements Builder {
private String outpostIdentifier;
private String orderId;
private List instancePools = DefaultSdkAutoConstructList.getInstance();
private Boolean dryRun;
private BuilderImpl() {
}
private BuilderImpl(StartCapacityTaskRequest model) {
super(model);
outpostIdentifier(model.outpostIdentifier);
orderId(model.orderId);
instancePools(model.instancePools);
dryRun(model.dryRun);
}
public final String getOutpostIdentifier() {
return outpostIdentifier;
}
public final void setOutpostIdentifier(String outpostIdentifier) {
this.outpostIdentifier = outpostIdentifier;
}
@Override
public final Builder outpostIdentifier(String outpostIdentifier) {
this.outpostIdentifier = outpostIdentifier;
return this;
}
public final String getOrderId() {
return orderId;
}
public final void setOrderId(String orderId) {
this.orderId = orderId;
}
@Override
public final Builder orderId(String orderId) {
this.orderId = orderId;
return this;
}
public final List getInstancePools() {
List result = RequestedInstancePoolsCopier.copyToBuilder(this.instancePools);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setInstancePools(Collection instancePools) {
this.instancePools = RequestedInstancePoolsCopier.copyFromBuilder(instancePools);
}
@Override
public final Builder instancePools(Collection instancePools) {
this.instancePools = RequestedInstancePoolsCopier.copy(instancePools);
return this;
}
@Override
@SafeVarargs
public final Builder instancePools(InstanceTypeCapacity... instancePools) {
instancePools(Arrays.asList(instancePools));
return this;
}
@Override
@SafeVarargs
public final Builder instancePools(Consumer... instancePools) {
instancePools(Stream.of(instancePools).map(c -> InstanceTypeCapacity.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
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 StartCapacityTaskRequest build() {
return new StartCapacityTaskRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}