software.amazon.awssdk.services.opsworks.model.CreateDeploymentRequest Maven / Gradle / Ivy
Show all versions of opsworks 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.opsworks.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 CreateDeploymentRequest extends OpsWorksRequest implements
ToCopyableBuilder {
private static final SdkField STACK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackId").getter(getter(CreateDeploymentRequest::stackId)).setter(setter(Builder::stackId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackId").build()).build();
private static final SdkField APP_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("AppId")
.getter(getter(CreateDeploymentRequest::appId)).setter(setter(Builder::appId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AppId").build()).build();
private static final SdkField> INSTANCE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("InstanceIds")
.getter(getter(CreateDeploymentRequest::instanceIds))
.setter(setter(Builder::instanceIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceIds").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> LAYER_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("LayerIds")
.getter(getter(CreateDeploymentRequest::layerIds))
.setter(setter(Builder::layerIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LayerIds").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 COMMAND_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Command")
.getter(getter(CreateDeploymentRequest::command)).setter(setter(Builder::command))
.constructor(DeploymentCommand::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Command").build()).build();
private static final SdkField COMMENT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Comment")
.getter(getter(CreateDeploymentRequest::comment)).setter(setter(Builder::comment))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Comment").build()).build();
private static final SdkField CUSTOM_JSON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CustomJson").getter(getter(CreateDeploymentRequest::customJson)).setter(setter(Builder::customJson))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomJson").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STACK_ID_FIELD, APP_ID_FIELD,
INSTANCE_IDS_FIELD, LAYER_IDS_FIELD, COMMAND_FIELD, COMMENT_FIELD, CUSTOM_JSON_FIELD));
private final String stackId;
private final String appId;
private final List instanceIds;
private final List layerIds;
private final DeploymentCommand command;
private final String comment;
private final String customJson;
private CreateDeploymentRequest(BuilderImpl builder) {
super(builder);
this.stackId = builder.stackId;
this.appId = builder.appId;
this.instanceIds = builder.instanceIds;
this.layerIds = builder.layerIds;
this.command = builder.command;
this.comment = builder.comment;
this.customJson = builder.customJson;
}
/**
*
* The stack ID.
*
*
* @return The stack ID.
*/
public final String stackId() {
return stackId;
}
/**
*
* The app ID. This parameter is required for app deployments, but not for other deployment commands.
*
*
* @return The app ID. This parameter is required for app deployments, but not for other deployment commands.
*/
public final String appId() {
return appId;
}
/**
* For responses, this returns true if the service returned a value for the InstanceIds 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 hasInstanceIds() {
return instanceIds != null && !(instanceIds instanceof SdkAutoConstructList);
}
/**
*
* The instance IDs for the deployment targets.
*
*
* 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 #hasInstanceIds} method.
*
*
* @return The instance IDs for the deployment targets.
*/
public final List instanceIds() {
return instanceIds;
}
/**
* For responses, this returns true if the service returned a value for the LayerIds 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 hasLayerIds() {
return layerIds != null && !(layerIds instanceof SdkAutoConstructList);
}
/**
*
* The layer IDs for the deployment targets.
*
*
* 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 #hasLayerIds} method.
*
*
* @return The layer IDs for the deployment targets.
*/
public final List layerIds() {
return layerIds;
}
/**
*
* A DeploymentCommand object that specifies the deployment command and any associated arguments.
*
*
* @return A DeploymentCommand object that specifies the deployment command and any associated
* arguments.
*/
public final DeploymentCommand command() {
return command;
}
/**
*
* A user-defined comment.
*
*
* @return A user-defined comment.
*/
public final String comment() {
return comment;
}
/**
*
* A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding
* default stack configuration JSON values. The string should be in the following format:
*
*
* "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
*
*
* For more information about custom JSON, see Use Custom JSON to Modify
* the Stack Configuration Attributes and Overriding
* Attributes With Custom JSON.
*
*
* @return A string that contains user-defined, custom JSON. You can use this parameter to override some
* corresponding default stack configuration JSON values. The string should be in the following format:
*
* "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
*
*
* For more information about custom JSON, see Use Custom JSON to
* Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.
*/
public final String customJson() {
return customJson;
}
@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(stackId());
hashCode = 31 * hashCode + Objects.hashCode(appId());
hashCode = 31 * hashCode + Objects.hashCode(hasInstanceIds() ? instanceIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasLayerIds() ? layerIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(command());
hashCode = 31 * hashCode + Objects.hashCode(comment());
hashCode = 31 * hashCode + Objects.hashCode(customJson());
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 CreateDeploymentRequest)) {
return false;
}
CreateDeploymentRequest other = (CreateDeploymentRequest) obj;
return Objects.equals(stackId(), other.stackId()) && Objects.equals(appId(), other.appId())
&& hasInstanceIds() == other.hasInstanceIds() && Objects.equals(instanceIds(), other.instanceIds())
&& hasLayerIds() == other.hasLayerIds() && Objects.equals(layerIds(), other.layerIds())
&& Objects.equals(command(), other.command()) && Objects.equals(comment(), other.comment())
&& Objects.equals(customJson(), other.customJson());
}
/**
* 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("CreateDeploymentRequest").add("StackId", stackId()).add("AppId", appId())
.add("InstanceIds", hasInstanceIds() ? instanceIds() : null).add("LayerIds", hasLayerIds() ? layerIds() : null)
.add("Command", command()).add("Comment", comment()).add("CustomJson", customJson()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StackId":
return Optional.ofNullable(clazz.cast(stackId()));
case "AppId":
return Optional.ofNullable(clazz.cast(appId()));
case "InstanceIds":
return Optional.ofNullable(clazz.cast(instanceIds()));
case "LayerIds":
return Optional.ofNullable(clazz.cast(layerIds()));
case "Command":
return Optional.ofNullable(clazz.cast(command()));
case "Comment":
return Optional.ofNullable(clazz.cast(comment()));
case "CustomJson":
return Optional.ofNullable(clazz.cast(customJson()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateDeploymentRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OpsWorksRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The stack ID.
*
*
* @param stackId
* The stack ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackId(String stackId);
/**
*
* The app ID. This parameter is required for app deployments, but not for other deployment commands.
*
*
* @param appId
* The app ID. This parameter is required for app deployments, but not for other deployment commands.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder appId(String appId);
/**
*
* The instance IDs for the deployment targets.
*
*
* @param instanceIds
* The instance IDs for the deployment targets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(Collection instanceIds);
/**
*
* The instance IDs for the deployment targets.
*
*
* @param instanceIds
* The instance IDs for the deployment targets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(String... instanceIds);
/**
*
* The layer IDs for the deployment targets.
*
*
* @param layerIds
* The layer IDs for the deployment targets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder layerIds(Collection layerIds);
/**
*
* The layer IDs for the deployment targets.
*
*
* @param layerIds
* The layer IDs for the deployment targets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder layerIds(String... layerIds);
/**
*
* A DeploymentCommand object that specifies the deployment command and any associated arguments.
*
*
* @param command
* A DeploymentCommand object that specifies the deployment command and any associated
* arguments.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder command(DeploymentCommand command);
/**
*
* A DeploymentCommand object that specifies the deployment command and any associated arguments.
*
* This is a convenience method that creates an instance of the {@link DeploymentCommand.Builder} avoiding the
* need to create one manually via {@link DeploymentCommand#builder()}.
*
*
* When the {@link Consumer} completes, {@link DeploymentCommand.Builder#build()} is called immediately and its
* result is passed to {@link #command(DeploymentCommand)}.
*
* @param command
* a consumer that will call methods on {@link DeploymentCommand.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #command(DeploymentCommand)
*/
default Builder command(Consumer command) {
return command(DeploymentCommand.builder().applyMutation(command).build());
}
/**
*
* A user-defined comment.
*
*
* @param comment
* A user-defined comment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder comment(String comment);
/**
*
* A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding
* default stack configuration JSON values. The string should be in the following format:
*
*
* "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
*
*
* For more information about custom JSON, see Use Custom JSON to
* Modify the Stack Configuration Attributes and Overriding
* Attributes With Custom JSON.
*
*
* @param customJson
* A string that contains user-defined, custom JSON. You can use this parameter to override some
* corresponding default stack configuration JSON values. The string should be in the following
* format:
*
* "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
*
*
* For more information about custom JSON, see Use Custom JSON
* to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customJson(String customJson);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OpsWorksRequest.BuilderImpl implements Builder {
private String stackId;
private String appId;
private List instanceIds = DefaultSdkAutoConstructList.getInstance();
private List layerIds = DefaultSdkAutoConstructList.getInstance();
private DeploymentCommand command;
private String comment;
private String customJson;
private BuilderImpl() {
}
private BuilderImpl(CreateDeploymentRequest model) {
super(model);
stackId(model.stackId);
appId(model.appId);
instanceIds(model.instanceIds);
layerIds(model.layerIds);
command(model.command);
comment(model.comment);
customJson(model.customJson);
}
public final String getStackId() {
return stackId;
}
public final void setStackId(String stackId) {
this.stackId = stackId;
}
@Override
public final Builder stackId(String stackId) {
this.stackId = stackId;
return this;
}
public final String getAppId() {
return appId;
}
public final void setAppId(String appId) {
this.appId = appId;
}
@Override
public final Builder appId(String appId) {
this.appId = appId;
return this;
}
public final Collection getInstanceIds() {
if (instanceIds instanceof SdkAutoConstructList) {
return null;
}
return instanceIds;
}
public final void setInstanceIds(Collection instanceIds) {
this.instanceIds = StringsCopier.copy(instanceIds);
}
@Override
public final Builder instanceIds(Collection instanceIds) {
this.instanceIds = StringsCopier.copy(instanceIds);
return this;
}
@Override
@SafeVarargs
public final Builder instanceIds(String... instanceIds) {
instanceIds(Arrays.asList(instanceIds));
return this;
}
public final Collection getLayerIds() {
if (layerIds instanceof SdkAutoConstructList) {
return null;
}
return layerIds;
}
public final void setLayerIds(Collection layerIds) {
this.layerIds = StringsCopier.copy(layerIds);
}
@Override
public final Builder layerIds(Collection layerIds) {
this.layerIds = StringsCopier.copy(layerIds);
return this;
}
@Override
@SafeVarargs
public final Builder layerIds(String... layerIds) {
layerIds(Arrays.asList(layerIds));
return this;
}
public final DeploymentCommand.Builder getCommand() {
return command != null ? command.toBuilder() : null;
}
public final void setCommand(DeploymentCommand.BuilderImpl command) {
this.command = command != null ? command.build() : null;
}
@Override
public final Builder command(DeploymentCommand command) {
this.command = command;
return this;
}
public final String getComment() {
return comment;
}
public final void setComment(String comment) {
this.comment = comment;
}
@Override
public final Builder comment(String comment) {
this.comment = comment;
return this;
}
public final String getCustomJson() {
return customJson;
}
public final void setCustomJson(String customJson) {
this.customJson = customJson;
}
@Override
public final Builder customJson(String customJson) {
this.customJson = customJson;
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 CreateDeploymentRequest build() {
return new CreateDeploymentRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}