software.amazon.awssdk.services.fis.model.CreateExperimentTemplateRequest Maven / Gradle / Ivy
Show all versions of fis 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.fis.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
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 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.DefaultValueTrait;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 CreateExperimentTemplateRequest extends FisRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateExperimentTemplateRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateExperimentTemplateRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField> STOP_CONDITIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("stopConditions")
.getter(getter(CreateExperimentTemplateRequest::stopConditions))
.setter(setter(Builder::stopConditions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("stopConditions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CreateExperimentTemplateStopConditionInput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TARGETS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("targets")
.getter(getter(CreateExperimentTemplateRequest::targets))
.setter(setter(Builder::targets))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("targets").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CreateExperimentTemplateTargetInput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> ACTIONS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("actions")
.getter(getter(CreateExperimentTemplateRequest::actions))
.setter(setter(Builder::actions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("actions").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CreateExperimentTemplateActionInput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("roleArn").getter(getter(CreateExperimentTemplateRequest::roleArn)).setter(setter(Builder::roleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("roleArn").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateExperimentTemplateRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField LOG_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("logConfiguration")
.getter(getter(CreateExperimentTemplateRequest::logConfiguration)).setter(setter(Builder::logConfiguration))
.constructor(CreateExperimentTemplateLogConfigurationInput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("logConfiguration").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
DESCRIPTION_FIELD, STOP_CONDITIONS_FIELD, TARGETS_FIELD, ACTIONS_FIELD, ROLE_ARN_FIELD, TAGS_FIELD,
LOG_CONFIGURATION_FIELD));
private final String clientToken;
private final String description;
private final List stopConditions;
private final Map targets;
private final Map actions;
private final String roleArn;
private final Map tags;
private final CreateExperimentTemplateLogConfigurationInput logConfiguration;
private CreateExperimentTemplateRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.description = builder.description;
this.stopConditions = builder.stopConditions;
this.targets = builder.targets;
this.actions = builder.actions;
this.roleArn = builder.roleArn;
this.tags = builder.tags;
this.logConfiguration = builder.logConfiguration;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* A description for the experiment template.
*
*
* @return A description for the experiment template.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the StopConditions 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 hasStopConditions() {
return stopConditions != null && !(stopConditions instanceof SdkAutoConstructList);
}
/**
*
* The stop conditions.
*
*
* 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 #hasStopConditions} method.
*
*
* @return The stop conditions.
*/
public final List stopConditions() {
return stopConditions;
}
/**
* For responses, this returns true if the service returned a value for the Targets 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 hasTargets() {
return targets != null && !(targets instanceof SdkAutoConstructMap);
}
/**
*
* The targets for the experiment.
*
*
* 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 #hasTargets} method.
*
*
* @return The targets for the experiment.
*/
public final Map targets() {
return targets;
}
/**
* For responses, this returns true if the service returned a value for the Actions 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 hasActions() {
return actions != null && !(actions instanceof SdkAutoConstructMap);
}
/**
*
* The actions for the experiment.
*
*
* 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 #hasActions} method.
*
*
* @return The actions for the experiment.
*/
public final Map actions() {
return actions;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions
* on your behalf.
*
*
* @return The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service
* actions on your behalf.
*/
public final String roleArn() {
return roleArn;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The tags to apply to the experiment template.
*
*
* 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 #hasTags} method.
*
*
* @return The tags to apply to the experiment template.
*/
public final Map tags() {
return tags;
}
/**
*
* The configuration for experiment logging.
*
*
* @return The configuration for experiment logging.
*/
public final CreateExperimentTemplateLogConfigurationInput logConfiguration() {
return logConfiguration;
}
@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(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasStopConditions() ? stopConditions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTargets() ? targets() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasActions() ? actions() : null);
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(logConfiguration());
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 CreateExperimentTemplateRequest)) {
return false;
}
CreateExperimentTemplateRequest other = (CreateExperimentTemplateRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(description(), other.description())
&& hasStopConditions() == other.hasStopConditions() && Objects.equals(stopConditions(), other.stopConditions())
&& hasTargets() == other.hasTargets() && Objects.equals(targets(), other.targets())
&& hasActions() == other.hasActions() && Objects.equals(actions(), other.actions())
&& Objects.equals(roleArn(), other.roleArn()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(logConfiguration(), other.logConfiguration());
}
/**
* 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("CreateExperimentTemplateRequest").add("ClientToken", clientToken())
.add("Description", description()).add("StopConditions", hasStopConditions() ? stopConditions() : null)
.add("Targets", hasTargets() ? targets() : null).add("Actions", hasActions() ? actions() : null)
.add("RoleArn", roleArn()).add("Tags", hasTags() ? tags() : null).add("LogConfiguration", logConfiguration())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "stopConditions":
return Optional.ofNullable(clazz.cast(stopConditions()));
case "targets":
return Optional.ofNullable(clazz.cast(targets()));
case "actions":
return Optional.ofNullable(clazz.cast(actions()));
case "roleArn":
return Optional.ofNullable(clazz.cast(roleArn()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "logConfiguration":
return Optional.ofNullable(clazz.cast(logConfiguration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateExperimentTemplateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FisRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* A description for the experiment template.
*
*
* @param description
* A description for the experiment template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The stop conditions.
*
*
* @param stopConditions
* The stop conditions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stopConditions(Collection stopConditions);
/**
*
* The stop conditions.
*
*
* @param stopConditions
* The stop conditions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stopConditions(CreateExperimentTemplateStopConditionInput... stopConditions);
/**
*
* The stop conditions.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fis.model.CreateExperimentTemplateStopConditionInput.Builder} avoiding
* the need to create one manually via
* {@link software.amazon.awssdk.services.fis.model.CreateExperimentTemplateStopConditionInput#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.fis.model.CreateExperimentTemplateStopConditionInput.Builder#build()}
* is called immediately and its result is passed to {@link
* #stopConditions(List)}.
*
* @param stopConditions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.fis.model.CreateExperimentTemplateStopConditionInput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #stopConditions(java.util.Collection)
*/
Builder stopConditions(Consumer... stopConditions);
/**
*
* The targets for the experiment.
*
*
* @param targets
* The targets for the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targets(Map targets);
/**
*
* The actions for the experiment.
*
*
* @param actions
* The actions for the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(Map actions);
/**
*
* The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service
* actions on your behalf.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform
* service actions on your behalf.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleArn(String roleArn);
/**
*
* The tags to apply to the experiment template.
*
*
* @param tags
* The tags to apply to the experiment template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The configuration for experiment logging.
*
*
* @param logConfiguration
* The configuration for experiment logging.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logConfiguration(CreateExperimentTemplateLogConfigurationInput logConfiguration);
/**
*
* The configuration for experiment logging.
*
* This is a convenience method that creates an instance of the
* {@link CreateExperimentTemplateLogConfigurationInput.Builder} avoiding the need to create one manually via
* {@link CreateExperimentTemplateLogConfigurationInput#builder()}.
*
*
* When the {@link Consumer} completes, {@link CreateExperimentTemplateLogConfigurationInput.Builder#build()} is
* called immediately and its result is passed to
* {@link #logConfiguration(CreateExperimentTemplateLogConfigurationInput)}.
*
* @param logConfiguration
* a consumer that will call methods on {@link CreateExperimentTemplateLogConfigurationInput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #logConfiguration(CreateExperimentTemplateLogConfigurationInput)
*/
default Builder logConfiguration(Consumer logConfiguration) {
return logConfiguration(CreateExperimentTemplateLogConfigurationInput.builder().applyMutation(logConfiguration)
.build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends FisRequest.BuilderImpl implements Builder {
private String clientToken;
private String description;
private List stopConditions = DefaultSdkAutoConstructList.getInstance();
private Map targets = DefaultSdkAutoConstructMap.getInstance();
private Map actions = DefaultSdkAutoConstructMap.getInstance();
private String roleArn;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private CreateExperimentTemplateLogConfigurationInput logConfiguration;
private BuilderImpl() {
}
private BuilderImpl(CreateExperimentTemplateRequest model) {
super(model);
clientToken(model.clientToken);
description(model.description);
stopConditions(model.stopConditions);
targets(model.targets);
actions(model.actions);
roleArn(model.roleArn);
tags(model.tags);
logConfiguration(model.logConfiguration);
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final List getStopConditions() {
List result = CreateExperimentTemplateStopConditionInputListCopier
.copyToBuilder(this.stopConditions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setStopConditions(Collection stopConditions) {
this.stopConditions = CreateExperimentTemplateStopConditionInputListCopier.copyFromBuilder(stopConditions);
}
@Override
public final Builder stopConditions(Collection stopConditions) {
this.stopConditions = CreateExperimentTemplateStopConditionInputListCopier.copy(stopConditions);
return this;
}
@Override
@SafeVarargs
public final Builder stopConditions(CreateExperimentTemplateStopConditionInput... stopConditions) {
stopConditions(Arrays.asList(stopConditions));
return this;
}
@Override
@SafeVarargs
public final Builder stopConditions(Consumer... stopConditions) {
stopConditions(Stream.of(stopConditions)
.map(c -> CreateExperimentTemplateStopConditionInput.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Map getTargets() {
Map result = CreateExperimentTemplateTargetInputMapCopier
.copyToBuilder(this.targets);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setTargets(Map targets) {
this.targets = CreateExperimentTemplateTargetInputMapCopier.copyFromBuilder(targets);
}
@Override
public final Builder targets(Map targets) {
this.targets = CreateExperimentTemplateTargetInputMapCopier.copy(targets);
return this;
}
public final Map getActions() {
Map result = CreateExperimentTemplateActionInputMapCopier
.copyToBuilder(this.actions);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setActions(Map actions) {
this.actions = CreateExperimentTemplateActionInputMapCopier.copyFromBuilder(actions);
}
@Override
public final Builder actions(Map actions) {
this.actions = CreateExperimentTemplateActionInputMapCopier.copy(actions);
return this;
}
public final String getRoleArn() {
return roleArn;
}
public final void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
@Override
public final Builder roleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
public final CreateExperimentTemplateLogConfigurationInput.Builder getLogConfiguration() {
return logConfiguration != null ? logConfiguration.toBuilder() : null;
}
public final void setLogConfiguration(CreateExperimentTemplateLogConfigurationInput.BuilderImpl logConfiguration) {
this.logConfiguration = logConfiguration != null ? logConfiguration.build() : null;
}
@Override
public final Builder logConfiguration(CreateExperimentTemplateLogConfigurationInput logConfiguration) {
this.logConfiguration = logConfiguration;
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 CreateExperimentTemplateRequest build() {
return new CreateExperimentTemplateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}