software.amazon.awssdk.services.iot.model.CreateMitigationActionRequest Maven / Gradle / Ivy
/*
* 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.iot.model;
import java.beans.Transient;
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 CreateMitigationActionRequest extends IotRequest implements
ToCopyableBuilder {
private static final SdkField ACTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("actionName").getter(getter(CreateMitigationActionRequest::actionName))
.setter(setter(Builder::actionName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("actionName").build()).build();
private static final SdkField ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("roleArn").getter(getter(CreateMitigationActionRequest::roleArn)).setter(setter(Builder::roleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("roleArn").build()).build();
private static final SdkField ACTION_PARAMS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("actionParams")
.getter(getter(CreateMitigationActionRequest::actionParams)).setter(setter(Builder::actionParams))
.constructor(MitigationActionParams::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("actionParams").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateMitigationActionRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACTION_NAME_FIELD,
ROLE_ARN_FIELD, ACTION_PARAMS_FIELD, TAGS_FIELD));
private final String actionName;
private final String roleArn;
private final MitigationActionParams actionParams;
private final List tags;
private CreateMitigationActionRequest(BuilderImpl builder) {
super(builder);
this.actionName = builder.actionName;
this.roleArn = builder.roleArn;
this.actionParams = builder.actionParams;
this.tags = builder.tags;
}
/**
*
* A friendly name for the action. Choose a friendly name that accurately describes the action (for example,
* EnableLoggingAction).
*
*
* @return A friendly name for the action. Choose a friendly name that accurately describes the action (for example,
* EnableLoggingAction).
*/
public final String actionName() {
return actionName;
}
/**
*
* The ARN of the IAM role that is used to apply the mitigation action.
*
*
* @return The ARN of the IAM role that is used to apply the mitigation action.
*/
public final String roleArn() {
return roleArn;
}
/**
*
* Defines the type of action and the parameters for that action.
*
*
* @return Defines the type of action and the parameters for that action.
*/
public final MitigationActionParams actionParams() {
return actionParams;
}
/**
* 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 SdkAutoConstructList);
}
/**
*
* Metadata that can be used to manage the mitigation action.
*
*
* 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 Metadata that can be used to manage the mitigation action.
*/
public final List tags() {
return tags;
}
@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(actionName());
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
hashCode = 31 * hashCode + Objects.hashCode(actionParams());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateMitigationActionRequest)) {
return false;
}
CreateMitigationActionRequest other = (CreateMitigationActionRequest) obj;
return Objects.equals(actionName(), other.actionName()) && Objects.equals(roleArn(), other.roleArn())
&& Objects.equals(actionParams(), other.actionParams()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateMitigationActionRequest").add("ActionName", actionName()).add("RoleArn", roleArn())
.add("ActionParams", actionParams()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "actionName":
return Optional.ofNullable(clazz.cast(actionName()));
case "roleArn":
return Optional.ofNullable(clazz.cast(roleArn()));
case "actionParams":
return Optional.ofNullable(clazz.cast(actionParams()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateMitigationActionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A friendly name for the action. Choose a friendly name that accurately describes the action (for example,
* EnableLoggingAction).
*
*
* @param actionName
* A friendly name for the action. Choose a friendly name that accurately describes the action (for
* example, EnableLoggingAction).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actionName(String actionName);
/**
*
* The ARN of the IAM role that is used to apply the mitigation action.
*
*
* @param roleArn
* The ARN of the IAM role that is used to apply the mitigation action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleArn(String roleArn);
/**
*
* Defines the type of action and the parameters for that action.
*
*
* @param actionParams
* Defines the type of action and the parameters for that action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actionParams(MitigationActionParams actionParams);
/**
*
* Defines the type of action and the parameters for that action.
*
* This is a convenience that creates an instance of the {@link MitigationActionParams.Builder} avoiding the
* need to create one manually via {@link MitigationActionParams#builder()}.
*
* When the {@link Consumer} completes, {@link MitigationActionParams.Builder#build()} is called immediately and
* its result is passed to {@link #actionParams(MitigationActionParams)}.
*
* @param actionParams
* a consumer that will call methods on {@link MitigationActionParams.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #actionParams(MitigationActionParams)
*/
default Builder actionParams(Consumer actionParams) {
return actionParams(MitigationActionParams.builder().applyMutation(actionParams).build());
}
/**
*
* Metadata that can be used to manage the mitigation action.
*
*
* @param tags
* Metadata that can be used to manage the mitigation action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Metadata that can be used to manage the mitigation action.
*
*
* @param tags
* Metadata that can be used to manage the mitigation action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Metadata that can be used to manage the mitigation action.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IotRequest.BuilderImpl implements Builder {
private String actionName;
private String roleArn;
private MitigationActionParams actionParams;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateMitigationActionRequest model) {
super(model);
actionName(model.actionName);
roleArn(model.roleArn);
actionParams(model.actionParams);
tags(model.tags);
}
public final String getActionName() {
return actionName;
}
public final void setActionName(String actionName) {
this.actionName = actionName;
}
@Override
@Transient
public final Builder actionName(String actionName) {
this.actionName = actionName;
return this;
}
public final String getRoleArn() {
return roleArn;
}
public final void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
@Override
@Transient
public final Builder roleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
public final MitigationActionParams.Builder getActionParams() {
return actionParams != null ? actionParams.toBuilder() : null;
}
public final void setActionParams(MitigationActionParams.BuilderImpl actionParams) {
this.actionParams = actionParams != null ? actionParams.build() : null;
}
@Override
@Transient
public final Builder actionParams(MitigationActionParams actionParams) {
this.actionParams = actionParams;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
@Transient
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 CreateMitigationActionRequest build() {
return new CreateMitigationActionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy