software.amazon.awssdk.services.cloudformation.model.StackEvent Maven / Gradle / Ivy
Show all versions of cloudformation 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.cloudformation.model;
import java.beans.Transient;
import java.io.Serializable;
import java.time.Instant;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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 StackEvent data type.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StackEvent implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField STACK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackId").getter(getter(StackEvent::stackId)).setter(setter(Builder::stackId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackId").build()).build();
private static final SdkField EVENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EventId").getter(getter(StackEvent::eventId)).setter(setter(Builder::eventId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventId").build()).build();
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(StackEvent::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(StackEvent::logicalResourceId))
.setter(setter(Builder::logicalResourceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LogicalResourceId").build()).build();
private static final SdkField PHYSICAL_RESOURCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PhysicalResourceId").getter(getter(StackEvent::physicalResourceId))
.setter(setter(Builder::physicalResourceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PhysicalResourceId").build())
.build();
private static final SdkField RESOURCE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceType").getter(getter(StackEvent::resourceType)).setter(setter(Builder::resourceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceType").build()).build();
private static final SdkField TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("Timestamp").getter(getter(StackEvent::timestamp)).setter(setter(Builder::timestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Timestamp").build()).build();
private static final SdkField RESOURCE_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceStatus").getter(getter(StackEvent::resourceStatusAsString))
.setter(setter(Builder::resourceStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceStatus").build()).build();
private static final SdkField RESOURCE_STATUS_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceStatusReason").getter(getter(StackEvent::resourceStatusReason))
.setter(setter(Builder::resourceStatusReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceStatusReason").build())
.build();
private static final SdkField RESOURCE_PROPERTIES_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceProperties").getter(getter(StackEvent::resourceProperties))
.setter(setter(Builder::resourceProperties))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceProperties").build())
.build();
private static final SdkField CLIENT_REQUEST_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ClientRequestToken").getter(getter(StackEvent::clientRequestToken))
.setter(setter(Builder::clientRequestToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientRequestToken").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STACK_ID_FIELD,
EVENT_ID_FIELD, STACK_NAME_FIELD, LOGICAL_RESOURCE_ID_FIELD, PHYSICAL_RESOURCE_ID_FIELD, RESOURCE_TYPE_FIELD,
TIMESTAMP_FIELD, RESOURCE_STATUS_FIELD, RESOURCE_STATUS_REASON_FIELD, RESOURCE_PROPERTIES_FIELD,
CLIENT_REQUEST_TOKEN_FIELD));
private static final long serialVersionUID = 1L;
private final String stackId;
private final String eventId;
private final String stackName;
private final String logicalResourceId;
private final String physicalResourceId;
private final String resourceType;
private final Instant timestamp;
private final String resourceStatus;
private final String resourceStatusReason;
private final String resourceProperties;
private final String clientRequestToken;
private StackEvent(BuilderImpl builder) {
this.stackId = builder.stackId;
this.eventId = builder.eventId;
this.stackName = builder.stackName;
this.logicalResourceId = builder.logicalResourceId;
this.physicalResourceId = builder.physicalResourceId;
this.resourceType = builder.resourceType;
this.timestamp = builder.timestamp;
this.resourceStatus = builder.resourceStatus;
this.resourceStatusReason = builder.resourceStatusReason;
this.resourceProperties = builder.resourceProperties;
this.clientRequestToken = builder.clientRequestToken;
}
/**
*
* The unique ID name of the instance of the stack.
*
*
* @return The unique ID name of the instance of the stack.
*/
public final String stackId() {
return stackId;
}
/**
*
* The unique ID of this event.
*
*
* @return The unique ID of this event.
*/
public final String eventId() {
return eventId;
}
/**
*
* The name associated with a stack.
*
*
* @return The name associated with a stack.
*/
public final String stackName() {
return stackName;
}
/**
*
* The logical name of the resource specified in the template.
*
*
* @return The logical name of the resource specified in the template.
*/
public final String logicalResourceId() {
return logicalResourceId;
}
/**
*
* The name or unique identifier associated with the physical instance of the resource.
*
*
* @return The name or unique identifier associated with the physical instance of the resource.
*/
public final String physicalResourceId() {
return physicalResourceId;
}
/**
*
* Type of resource. (For more information, go to Amazon
* Web Services Resource Types Reference in the CloudFormation User Guide.)
*
*
* @return Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
*/
public final String resourceType() {
return resourceType;
}
/**
*
* Time the status was updated.
*
*
* @return Time the status was updated.
*/
public final Instant timestamp() {
return timestamp;
}
/**
*
* Current status of the resource.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resourceStatus}
* will return {@link ResourceStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #resourceStatusAsString}.
*
*
* @return Current status of the resource.
* @see ResourceStatus
*/
public final ResourceStatus resourceStatus() {
return ResourceStatus.fromValue(resourceStatus);
}
/**
*
* Current status of the resource.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resourceStatus}
* will return {@link ResourceStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #resourceStatusAsString}.
*
*
* @return Current status of the resource.
* @see ResourceStatus
*/
public final String resourceStatusAsString() {
return resourceStatus;
}
/**
*
* Success/failure message associated with the resource.
*
*
* @return Success/failure message associated with the resource.
*/
public final String resourceStatusReason() {
return resourceStatusReason;
}
/**
*
* BLOB of the properties used to create the resource.
*
*
* @return BLOB of the properties used to create the resource.
*/
public final String resourceProperties() {
return resourceProperties;
}
/**
*
* The token passed to the operation that generated this event.
*
*
* All events triggered by a given stack operation are assigned the same client request token, which you can use to
* track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that are
* initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
* the stack operation . For example, if you create a stack using the console, each stack event would be assigned
* the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*
*
* @return The token passed to the operation that generated this event.
*
* All events triggered by a given stack operation are assigned the same client request token, which you can
* use to track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations
* that are initiated from the console use the token format Console-StackOperation-ID, which helps
* you easily identify the stack operation . For example, if you create a stack using the console, each
* stack event would be assigned the same token in the following format:
* Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*/
public final String clientRequestToken() {
return clientRequestToken;
}
@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 + Objects.hashCode(stackId());
hashCode = 31 * hashCode + Objects.hashCode(eventId());
hashCode = 31 * hashCode + Objects.hashCode(stackName());
hashCode = 31 * hashCode + Objects.hashCode(logicalResourceId());
hashCode = 31 * hashCode + Objects.hashCode(physicalResourceId());
hashCode = 31 * hashCode + Objects.hashCode(resourceType());
hashCode = 31 * hashCode + Objects.hashCode(timestamp());
hashCode = 31 * hashCode + Objects.hashCode(resourceStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(resourceStatusReason());
hashCode = 31 * hashCode + Objects.hashCode(resourceProperties());
hashCode = 31 * hashCode + Objects.hashCode(clientRequestToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof StackEvent)) {
return false;
}
StackEvent other = (StackEvent) obj;
return Objects.equals(stackId(), other.stackId()) && Objects.equals(eventId(), other.eventId())
&& Objects.equals(stackName(), other.stackName())
&& Objects.equals(logicalResourceId(), other.logicalResourceId())
&& Objects.equals(physicalResourceId(), other.physicalResourceId())
&& Objects.equals(resourceType(), other.resourceType()) && Objects.equals(timestamp(), other.timestamp())
&& Objects.equals(resourceStatusAsString(), other.resourceStatusAsString())
&& Objects.equals(resourceStatusReason(), other.resourceStatusReason())
&& Objects.equals(resourceProperties(), other.resourceProperties())
&& Objects.equals(clientRequestToken(), other.clientRequestToken());
}
/**
* 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("StackEvent").add("StackId", stackId()).add("EventId", eventId()).add("StackName", stackName())
.add("LogicalResourceId", logicalResourceId()).add("PhysicalResourceId", physicalResourceId())
.add("ResourceType", resourceType()).add("Timestamp", timestamp())
.add("ResourceStatus", resourceStatusAsString()).add("ResourceStatusReason", resourceStatusReason())
.add("ResourceProperties", resourceProperties()).add("ClientRequestToken", clientRequestToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StackId":
return Optional.ofNullable(clazz.cast(stackId()));
case "EventId":
return Optional.ofNullable(clazz.cast(eventId()));
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
case "LogicalResourceId":
return Optional.ofNullable(clazz.cast(logicalResourceId()));
case "PhysicalResourceId":
return Optional.ofNullable(clazz.cast(physicalResourceId()));
case "ResourceType":
return Optional.ofNullable(clazz.cast(resourceType()));
case "Timestamp":
return Optional.ofNullable(clazz.cast(timestamp()));
case "ResourceStatus":
return Optional.ofNullable(clazz.cast(resourceStatusAsString()));
case "ResourceStatusReason":
return Optional.ofNullable(clazz.cast(resourceStatusReason()));
case "ResourceProperties":
return Optional.ofNullable(clazz.cast(resourceProperties()));
case "ClientRequestToken":
return Optional.ofNullable(clazz.cast(clientRequestToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StackEvent) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique ID name of the instance of the stack.
*
*
* @param stackId
* The unique ID name of the instance of the stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackId(String stackId);
/**
*
* The unique ID of this event.
*
*
* @param eventId
* The unique ID of this event.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventId(String eventId);
/**
*
* The name associated with a stack.
*
*
* @param stackName
* The name associated with a stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* The logical name of the resource specified in the template.
*
*
* @param logicalResourceId
* The logical name of the resource specified in the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logicalResourceId(String logicalResourceId);
/**
*
* The name or unique identifier associated with the physical instance of the resource.
*
*
* @param physicalResourceId
* The name or unique identifier associated with the physical instance of the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder physicalResourceId(String physicalResourceId);
/**
*
* Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
*
*
* @param resourceType
* Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceType(String resourceType);
/**
*
* Time the status was updated.
*
*
* @param timestamp
* Time the status was updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timestamp(Instant timestamp);
/**
*
* Current status of the resource.
*
*
* @param resourceStatus
* Current status of the resource.
* @see ResourceStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceStatus
*/
Builder resourceStatus(String resourceStatus);
/**
*
* Current status of the resource.
*
*
* @param resourceStatus
* Current status of the resource.
* @see ResourceStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceStatus
*/
Builder resourceStatus(ResourceStatus resourceStatus);
/**
*
* Success/failure message associated with the resource.
*
*
* @param resourceStatusReason
* Success/failure message associated with the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceStatusReason(String resourceStatusReason);
/**
*
* BLOB of the properties used to create the resource.
*
*
* @param resourceProperties
* BLOB of the properties used to create the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceProperties(String resourceProperties);
/**
*
* The token passed to the operation that generated this event.
*
*
* All events triggered by a given stack operation are assigned the same client request token, which you can use
* to track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that
* are initiated from the console use the token format Console-StackOperation-ID, which helps you easily
* identify the stack operation . For example, if you create a stack using the console, each stack event would
* be assigned the same token in the following format:
* Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*
*
* @param clientRequestToken
* The token passed to the operation that generated this event.
*
* All events triggered by a given stack operation are assigned the same client request token, which you
* can use to track operations. For example, if you execute a CreateStack operation with the
* token token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations
* that are initiated from the console use the token format Console-StackOperation-ID, which helps
* you easily identify the stack operation . For example, if you create a stack using the console, each
* stack event would be assigned the same token in the following format:
* Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientRequestToken(String clientRequestToken);
}
static final class BuilderImpl implements Builder {
private String stackId;
private String eventId;
private String stackName;
private String logicalResourceId;
private String physicalResourceId;
private String resourceType;
private Instant timestamp;
private String resourceStatus;
private String resourceStatusReason;
private String resourceProperties;
private String clientRequestToken;
private BuilderImpl() {
}
private BuilderImpl(StackEvent model) {
stackId(model.stackId);
eventId(model.eventId);
stackName(model.stackName);
logicalResourceId(model.logicalResourceId);
physicalResourceId(model.physicalResourceId);
resourceType(model.resourceType);
timestamp(model.timestamp);
resourceStatus(model.resourceStatus);
resourceStatusReason(model.resourceStatusReason);
resourceProperties(model.resourceProperties);
clientRequestToken(model.clientRequestToken);
}
public final String getStackId() {
return stackId;
}
public final void setStackId(String stackId) {
this.stackId = stackId;
}
@Override
@Transient
public final Builder stackId(String stackId) {
this.stackId = stackId;
return this;
}
public final String getEventId() {
return eventId;
}
public final void setEventId(String eventId) {
this.eventId = eventId;
}
@Override
@Transient
public final Builder eventId(String eventId) {
this.eventId = eventId;
return this;
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
@Transient
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
@Transient
public final Builder logicalResourceId(String logicalResourceId) {
this.logicalResourceId = logicalResourceId;
return this;
}
public final String getPhysicalResourceId() {
return physicalResourceId;
}
public final void setPhysicalResourceId(String physicalResourceId) {
this.physicalResourceId = physicalResourceId;
}
@Override
@Transient
public final Builder physicalResourceId(String physicalResourceId) {
this.physicalResourceId = physicalResourceId;
return this;
}
public final String getResourceType() {
return resourceType;
}
public final void setResourceType(String resourceType) {
this.resourceType = resourceType;
}
@Override
@Transient
public final Builder resourceType(String resourceType) {
this.resourceType = resourceType;
return this;
}
public final Instant getTimestamp() {
return timestamp;
}
public final void setTimestamp(Instant timestamp) {
this.timestamp = timestamp;
}
@Override
@Transient
public final Builder timestamp(Instant timestamp) {
this.timestamp = timestamp;
return this;
}
public final String getResourceStatus() {
return resourceStatus;
}
public final void setResourceStatus(String resourceStatus) {
this.resourceStatus = resourceStatus;
}
@Override
@Transient
public final Builder resourceStatus(String resourceStatus) {
this.resourceStatus = resourceStatus;
return this;
}
@Override
@Transient
public final Builder resourceStatus(ResourceStatus resourceStatus) {
this.resourceStatus(resourceStatus == null ? null : resourceStatus.toString());
return this;
}
public final String getResourceStatusReason() {
return resourceStatusReason;
}
public final void setResourceStatusReason(String resourceStatusReason) {
this.resourceStatusReason = resourceStatusReason;
}
@Override
@Transient
public final Builder resourceStatusReason(String resourceStatusReason) {
this.resourceStatusReason = resourceStatusReason;
return this;
}
public final String getResourceProperties() {
return resourceProperties;
}
public final void setResourceProperties(String resourceProperties) {
this.resourceProperties = resourceProperties;
}
@Override
@Transient
public final Builder resourceProperties(String resourceProperties) {
this.resourceProperties = resourceProperties;
return this;
}
public final String getClientRequestToken() {
return clientRequestToken;
}
public final void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
@Override
@Transient
public final Builder clientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
return this;
}
@Override
public StackEvent build() {
return new StackEvent(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}