software.amazon.awssdk.services.cloudformation.model.SignalResourceRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudformation Show documentation
Show all versions of cloudformation Show documentation
The AWS Java SDK for AWS CloudFormation module holds the client classes that are used for communicating
with AWS CloudFormation Service
/*
* 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.cloudformation.model;
import java.util.Arrays;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The input for the SignalResource action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SignalResourceRequest extends CloudFormationRequest implements
ToCopyableBuilder {
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(SignalResourceRequest::stackName)).setter(setter(Builder::stackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackName").build()).build();
private static final SdkField LOGICAL_RESOURCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LogicalResourceId").getter(getter(SignalResourceRequest::logicalResourceId))
.setter(setter(Builder::logicalResourceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LogicalResourceId").build()).build();
private static final SdkField UNIQUE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UniqueId").getter(getter(SignalResourceRequest::uniqueId)).setter(setter(Builder::uniqueId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UniqueId").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(SignalResourceRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STACK_NAME_FIELD,
LOGICAL_RESOURCE_ID_FIELD, UNIQUE_ID_FIELD, STATUS_FIELD));
private final String stackName;
private final String logicalResourceId;
private final String uniqueId;
private final String status;
private SignalResourceRequest(BuilderImpl builder) {
super(builder);
this.stackName = builder.stackName;
this.logicalResourceId = builder.logicalResourceId;
this.uniqueId = builder.uniqueId;
this.status = builder.status;
}
/**
*
* The stack name or unique stack ID that includes the resource that you want to signal.
*
*
* @return The stack name or unique stack ID that includes the resource that you want to signal.
*/
public final String stackName() {
return stackName;
}
/**
*
* The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in
* the template.
*
*
* @return The logical ID of the resource that you want to signal. The logical ID is the name of the resource that
* given in the template.
*/
public final String logicalResourceId() {
return logicalResourceId;
}
/**
*
* A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID
* that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a
* wait condition), each signal requires a different unique ID.
*
*
* @return A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the
* instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource
* (such as signaling a wait condition), each signal requires a different unique ID.
*/
public final String uniqueId() {
return uniqueId;
}
/**
*
* The status of the signal, which is either success or failure. A failure signal causes CloudFormation to
* immediately fail the stack creation or update.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ResourceSignalStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The status of the signal, which is either success or failure. A failure signal causes CloudFormation to
* immediately fail the stack creation or update.
* @see ResourceSignalStatus
*/
public final ResourceSignalStatus status() {
return ResourceSignalStatus.fromValue(status);
}
/**
*
* The status of the signal, which is either success or failure. A failure signal causes CloudFormation to
* immediately fail the stack creation or update.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ResourceSignalStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The status of the signal, which is either success or failure. A failure signal causes CloudFormation to
* immediately fail the stack creation or update.
* @see ResourceSignalStatus
*/
public final String statusAsString() {
return status;
}
@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(stackName());
hashCode = 31 * hashCode + Objects.hashCode(logicalResourceId());
hashCode = 31 * hashCode + Objects.hashCode(uniqueId());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
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 SignalResourceRequest)) {
return false;
}
SignalResourceRequest other = (SignalResourceRequest) obj;
return Objects.equals(stackName(), other.stackName()) && Objects.equals(logicalResourceId(), other.logicalResourceId())
&& Objects.equals(uniqueId(), other.uniqueId()) && Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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("SignalResourceRequest").add("StackName", stackName())
.add("LogicalResourceId", logicalResourceId()).add("UniqueId", uniqueId()).add("Status", statusAsString())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
case "LogicalResourceId":
return Optional.ofNullable(clazz.cast(logicalResourceId()));
case "UniqueId":
return Optional.ofNullable(clazz.cast(uniqueId()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SignalResourceRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The stack name or unique stack ID that includes the resource that you want to signal.
*
*
* @param stackName
* The stack name or unique stack ID that includes the resource that you want to signal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given
* in the template.
*
*
* @param logicalResourceId
* The logical ID of the resource that you want to signal. The logical ID is the name of the resource
* that given in the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logicalResourceId(String logicalResourceId);
/**
*
* A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance
* ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as
* signaling a wait condition), each signal requires a different unique ID.
*
*
* @param uniqueId
* A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the
* instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource
* (such as signaling a wait condition), each signal requires a different unique ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder uniqueId(String uniqueId);
/**
*
* The status of the signal, which is either success or failure. A failure signal causes CloudFormation to
* immediately fail the stack creation or update.
*
*
* @param status
* The status of the signal, which is either success or failure. A failure signal causes CloudFormation
* to immediately fail the stack creation or update.
* @see ResourceSignalStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceSignalStatus
*/
Builder status(String status);
/**
*
* The status of the signal, which is either success or failure. A failure signal causes CloudFormation to
* immediately fail the stack creation or update.
*
*
* @param status
* The status of the signal, which is either success or failure. A failure signal causes CloudFormation
* to immediately fail the stack creation or update.
* @see ResourceSignalStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceSignalStatus
*/
Builder status(ResourceSignalStatus status);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudFormationRequest.BuilderImpl implements Builder {
private String stackName;
private String logicalResourceId;
private String uniqueId;
private String status;
private BuilderImpl() {
}
private BuilderImpl(SignalResourceRequest model) {
super(model);
stackName(model.stackName);
logicalResourceId(model.logicalResourceId);
uniqueId(model.uniqueId);
status(model.status);
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
public final Builder stackName(String stackName) {
this.stackName = stackName;
return this;
}
public final String getLogicalResourceId() {
return logicalResourceId;
}
public final void setLogicalResourceId(String logicalResourceId) {
this.logicalResourceId = logicalResourceId;
}
@Override
public final Builder logicalResourceId(String logicalResourceId) {
this.logicalResourceId = logicalResourceId;
return this;
}
public final String getUniqueId() {
return uniqueId;
}
public final void setUniqueId(String uniqueId) {
this.uniqueId = uniqueId;
}
@Override
public final Builder uniqueId(String uniqueId) {
this.uniqueId = uniqueId;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(ResourceSignalStatus status) {
this.status(status == null ? null : status.toString());
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 SignalResourceRequest build() {
return new SignalResourceRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy