software.amazon.awssdk.services.swf.model.StartChildWorkflowExecutionFailedEventAttributes Maven / Gradle / Ivy
Show all versions of swf 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.swf.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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 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;
/**
*
* Provides the details of the StartChildWorkflowExecutionFailed event.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StartChildWorkflowExecutionFailedEventAttributes
implements
SdkPojo,
Serializable,
ToCopyableBuilder {
private static final SdkField WORKFLOW_TYPE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("workflowType").getter(getter(StartChildWorkflowExecutionFailedEventAttributes::workflowType))
.setter(setter(Builder::workflowType)).constructor(WorkflowType::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("workflowType").build()).build();
private static final SdkField CAUSE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("cause")
.getter(getter(StartChildWorkflowExecutionFailedEventAttributes::causeAsString)).setter(setter(Builder::cause))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("cause").build()).build();
private static final SdkField WORKFLOW_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("workflowId").getter(getter(StartChildWorkflowExecutionFailedEventAttributes::workflowId))
.setter(setter(Builder::workflowId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("workflowId").build()).build();
private static final SdkField INITIATED_EVENT_ID_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("initiatedEventId").getter(getter(StartChildWorkflowExecutionFailedEventAttributes::initiatedEventId))
.setter(setter(Builder::initiatedEventId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("initiatedEventId").build()).build();
private static final SdkField DECISION_TASK_COMPLETED_EVENT_ID_FIELD = SdkField
. builder(MarshallingType.LONG)
.memberName("decisionTaskCompletedEventId")
.getter(getter(StartChildWorkflowExecutionFailedEventAttributes::decisionTaskCompletedEventId))
.setter(setter(Builder::decisionTaskCompletedEventId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("decisionTaskCompletedEventId")
.build()).build();
private static final SdkField CONTROL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("control")
.getter(getter(StartChildWorkflowExecutionFailedEventAttributes::control)).setter(setter(Builder::control))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("control").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(WORKFLOW_TYPE_FIELD,
CAUSE_FIELD, WORKFLOW_ID_FIELD, INITIATED_EVENT_ID_FIELD, DECISION_TASK_COMPLETED_EVENT_ID_FIELD, CONTROL_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("workflowType", WORKFLOW_TYPE_FIELD);
put("cause", CAUSE_FIELD);
put("workflowId", WORKFLOW_ID_FIELD);
put("initiatedEventId", INITIATED_EVENT_ID_FIELD);
put("decisionTaskCompletedEventId", DECISION_TASK_COMPLETED_EVENT_ID_FIELD);
put("control", CONTROL_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final WorkflowType workflowType;
private final String causeValue;
private final String workflowId;
private final Long initiatedEventId;
private final Long decisionTaskCompletedEventId;
private final String control;
private StartChildWorkflowExecutionFailedEventAttributes(BuilderImpl builder) {
this.workflowType = builder.workflowType;
this.causeValue = builder.causeValue;
this.workflowId = builder.workflowId;
this.initiatedEventId = builder.initiatedEventId;
this.decisionTaskCompletedEventId = builder.decisionTaskCompletedEventId;
this.control = builder.control;
}
/**
*
* The workflow type provided in the StartChildWorkflowExecution Decision that failed.
*
*
* @return The workflow type provided in the StartChildWorkflowExecution Decision that failed.
*/
public final WorkflowType workflowType() {
return workflowType;
}
/**
*
* The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
*
*
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks
* sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access
* to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #cause} will return
* {@link StartChildWorkflowExecutionFailedCause#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #causeAsString}.
*
*
* @return The cause of the failure. This information is generated by the system and can be useful for diagnostic
* purposes.
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it
* lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage
* Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
* @see StartChildWorkflowExecutionFailedCause
*/
public final StartChildWorkflowExecutionFailedCause cause() {
return StartChildWorkflowExecutionFailedCause.fromValue(causeValue);
}
/**
*
* The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
*
*
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks
* sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access
* to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #cause} will return
* {@link StartChildWorkflowExecutionFailedCause#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #causeAsString}.
*
*
* @return The cause of the failure. This information is generated by the system and can be useful for diagnostic
* purposes.
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it
* lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage
* Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
* @see StartChildWorkflowExecutionFailedCause
*/
public final String causeAsString() {
return causeValue;
}
/**
*
* The workflowId of the child workflow execution.
*
*
* @return The workflowId of the child workflow execution.
*/
public final String workflowId() {
return workflowId;
}
/**
*
* When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of
* the StartChildWorkflowExecutionInitiated event that corresponds to the
* StartChildWorkflowExecution Decision to start the workflow execution. You can use this
* information to diagnose problems by tracing back the chain of events leading up to this event.
*
*
* When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to
* 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.
*
*
* @return When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is
* the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the
* StartChildWorkflowExecution Decision to start the workflow execution. You can use
* this information to diagnose problems by tracing back the chain of events leading up to this event.
*
* When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is
* set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.
*/
public final Long initiatedEventId() {
return initiatedEventId;
}
/**
*
* The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the
* StartChildWorkflowExecution Decision to request this child workflow execution. This
* information can be useful for diagnosing problems by tracing back the chain of events.
*
*
* @return The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted
* in the StartChildWorkflowExecution Decision to request this child workflow execution.
* This information can be useful for diagnosing problems by tracing back the chain of events.
*/
public final Long decisionTaskCompletedEventId() {
return decisionTaskCompletedEventId;
}
/**
*
* The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the
* child workflow execution.
*
*
* @return The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't
* sent to the child workflow execution.
*/
public final String control() {
return control;
}
@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(workflowType());
hashCode = 31 * hashCode + Objects.hashCode(causeAsString());
hashCode = 31 * hashCode + Objects.hashCode(workflowId());
hashCode = 31 * hashCode + Objects.hashCode(initiatedEventId());
hashCode = 31 * hashCode + Objects.hashCode(decisionTaskCompletedEventId());
hashCode = 31 * hashCode + Objects.hashCode(control());
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 StartChildWorkflowExecutionFailedEventAttributes)) {
return false;
}
StartChildWorkflowExecutionFailedEventAttributes other = (StartChildWorkflowExecutionFailedEventAttributes) obj;
return Objects.equals(workflowType(), other.workflowType()) && Objects.equals(causeAsString(), other.causeAsString())
&& Objects.equals(workflowId(), other.workflowId())
&& Objects.equals(initiatedEventId(), other.initiatedEventId())
&& Objects.equals(decisionTaskCompletedEventId(), other.decisionTaskCompletedEventId())
&& Objects.equals(control(), other.control());
}
/**
* 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("StartChildWorkflowExecutionFailedEventAttributes").add("WorkflowType", workflowType())
.add("Cause", causeAsString()).add("WorkflowId", workflowId()).add("InitiatedEventId", initiatedEventId())
.add("DecisionTaskCompletedEventId", decisionTaskCompletedEventId()).add("Control", control()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "workflowType":
return Optional.ofNullable(clazz.cast(workflowType()));
case "cause":
return Optional.ofNullable(clazz.cast(causeAsString()));
case "workflowId":
return Optional.ofNullable(clazz.cast(workflowId()));
case "initiatedEventId":
return Optional.ofNullable(clazz.cast(initiatedEventId()));
case "decisionTaskCompletedEventId":
return Optional.ofNullable(clazz.cast(decisionTaskCompletedEventId()));
case "control":
return Optional.ofNullable(clazz.cast(control()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((StartChildWorkflowExecutionFailedEventAttributes) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The workflow type provided in the StartChildWorkflowExecution Decision that failed.
*
*
* @param workflowType
* The workflow type provided in the StartChildWorkflowExecution Decision that
* failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workflowType(WorkflowType workflowType);
/**
*
* The workflow type provided in the StartChildWorkflowExecution Decision that failed.
*
* This is a convenience method that creates an instance of the {@link WorkflowType.Builder} avoiding the need
* to create one manually via {@link WorkflowType#builder()}.
*
*
* When the {@link Consumer} completes, {@link WorkflowType.Builder#build()} is called immediately and its
* result is passed to {@link #workflowType(WorkflowType)}.
*
* @param workflowType
* a consumer that will call methods on {@link WorkflowType.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #workflowType(WorkflowType)
*/
default Builder workflowType(Consumer workflowType) {
return workflowType(WorkflowType.builder().applyMutation(workflowType).build());
}
/**
*
* The cause of the failure. This information is generated by the system and can be useful for diagnostic
* purposes.
*
*
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks
* sufficient permissions. For details and example IAM policies, see Using IAM to Manage
* Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
*
* @param causeValue
* The cause of the failure. This information is generated by the system and can be useful for diagnostic
* purposes.
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it
* lacks sufficient permissions. For details and example IAM policies, see Using IAM to
* Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
* @see StartChildWorkflowExecutionFailedCause
* @return Returns a reference to this object so that method calls can be chained together.
* @see StartChildWorkflowExecutionFailedCause
*/
Builder cause(String causeValue);
/**
*
* The cause of the failure. This information is generated by the system and can be useful for diagnostic
* purposes.
*
*
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks
* sufficient permissions. For details and example IAM policies, see Using IAM to Manage
* Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
*
* @param causeValue
* The cause of the failure. This information is generated by the system and can be useful for diagnostic
* purposes.
*
* When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it
* lacks sufficient permissions. For details and example IAM policies, see Using IAM to
* Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
* @see StartChildWorkflowExecutionFailedCause
* @return Returns a reference to this object so that method calls can be chained together.
* @see StartChildWorkflowExecutionFailedCause
*/
Builder cause(StartChildWorkflowExecutionFailedCause causeValue);
/**
*
* The workflowId of the child workflow execution.
*
*
* @param workflowId
* The workflowId of the child workflow execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workflowId(String workflowId);
/**
*
* When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID
* of the StartChildWorkflowExecutionInitiated event that corresponds to the
* StartChildWorkflowExecution Decision to start the workflow execution. You can use this
* information to diagnose problems by tracing back the chain of events leading up to this event.
*
*
* When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set
* to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.
*
*
* @param initiatedEventId
* When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is
* the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the
* StartChildWorkflowExecution Decision to start the workflow execution. You can use
* this information to diagnose problems by tracing back the chain of events leading up to this
* event.
*
* When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId
* is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't
* exist.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder initiatedEventId(Long initiatedEventId);
/**
*
* The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in
* the StartChildWorkflowExecution Decision to request this child workflow execution. This
* information can be useful for diagnosing problems by tracing back the chain of events.
*
*
* @param decisionTaskCompletedEventId
* The ID of the DecisionTaskCompleted event corresponding to the decision task that
* resulted in the StartChildWorkflowExecution Decision to request this child
* workflow execution. This information can be useful for diagnosing problems by tracing back the chain
* of events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder decisionTaskCompletedEventId(Long decisionTaskCompletedEventId);
/**
*
* The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to
* the child workflow execution.
*
*
* @param control
* The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't
* sent to the child workflow execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder control(String control);
}
static final class BuilderImpl implements Builder {
private WorkflowType workflowType;
private String causeValue;
private String workflowId;
private Long initiatedEventId;
private Long decisionTaskCompletedEventId;
private String control;
private BuilderImpl() {
}
private BuilderImpl(StartChildWorkflowExecutionFailedEventAttributes model) {
workflowType(model.workflowType);
cause(model.causeValue);
workflowId(model.workflowId);
initiatedEventId(model.initiatedEventId);
decisionTaskCompletedEventId(model.decisionTaskCompletedEventId);
control(model.control);
}
public final WorkflowType.Builder getWorkflowType() {
return workflowType != null ? workflowType.toBuilder() : null;
}
public final void setWorkflowType(WorkflowType.BuilderImpl workflowType) {
this.workflowType = workflowType != null ? workflowType.build() : null;
}
@Override
public final Builder workflowType(WorkflowType workflowType) {
this.workflowType = workflowType;
return this;
}
public final String getCause() {
return causeValue;
}
public final void setCause(String causeValue) {
this.causeValue = causeValue;
}
@Override
public final Builder cause(String causeValue) {
this.causeValue = causeValue;
return this;
}
@Override
public final Builder cause(StartChildWorkflowExecutionFailedCause causeValue) {
this.cause(causeValue == null ? null : causeValue.toString());
return this;
}
public final String getWorkflowId() {
return workflowId;
}
public final void setWorkflowId(String workflowId) {
this.workflowId = workflowId;
}
@Override
public final Builder workflowId(String workflowId) {
this.workflowId = workflowId;
return this;
}
public final Long getInitiatedEventId() {
return initiatedEventId;
}
public final void setInitiatedEventId(Long initiatedEventId) {
this.initiatedEventId = initiatedEventId;
}
@Override
public final Builder initiatedEventId(Long initiatedEventId) {
this.initiatedEventId = initiatedEventId;
return this;
}
public final Long getDecisionTaskCompletedEventId() {
return decisionTaskCompletedEventId;
}
public final void setDecisionTaskCompletedEventId(Long decisionTaskCompletedEventId) {
this.decisionTaskCompletedEventId = decisionTaskCompletedEventId;
}
@Override
public final Builder decisionTaskCompletedEventId(Long decisionTaskCompletedEventId) {
this.decisionTaskCompletedEventId = decisionTaskCompletedEventId;
return this;
}
public final String getControl() {
return control;
}
public final void setControl(String control) {
this.control = control;
}
@Override
public final Builder control(String control) {
this.control = control;
return this;
}
@Override
public StartChildWorkflowExecutionFailedEventAttributes build() {
return new StartChildWorkflowExecutionFailedEventAttributes(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}