com.amazonaws.services.simpleworkflow.model.StartTimerDecisionAttributes Maven / Gradle / Ivy
Show all versions of aws-java-sdk-simpleworkflow Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.simpleworkflow.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides the details of the StartTimer decision.
*
*
* Access Control
*
*
* You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* You cannot use an IAM policy to constrain this action's parameters.
*
*
*
*
* If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the
* specified constraints, the action fails. The associated event attribute's cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartTimerDecisionAttributes implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique ID of the timer.
*
*
* The specified string must not contain a : (colon), / (slash), | (vertical
* bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must
* not be the literal string arn.
*
*/
private String timerId;
/**
*
* The data attached to the event that can be used by the decider in subsequent workflow tasks.
*
*/
private String control;
/**
*
* The duration to wait before firing the timer.
*
*
* The duration is specified in seconds, an integer greater than or equal to 0.
*
*/
private String startToFireTimeout;
/**
*
* The unique ID of the timer.
*
*
* The specified string must not contain a : (colon), / (slash), | (vertical
* bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must
* not be the literal string arn.
*
*
* @param timerId
* The unique ID of the timer.
*
* The specified string must not contain a : (colon), / (slash), |
* (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also,
* it must not be the literal string arn.
*/
public void setTimerId(String timerId) {
this.timerId = timerId;
}
/**
*
* The unique ID of the timer.
*
*
* The specified string must not contain a : (colon), / (slash), | (vertical
* bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must
* not be the literal string arn.
*
*
* @return The unique ID of the timer.
*
* The specified string must not contain a : (colon), / (slash), |
* (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f).
* Also, it must not be the literal string arn.
*/
public String getTimerId() {
return this.timerId;
}
/**
*
* The unique ID of the timer.
*
*
* The specified string must not contain a : (colon), / (slash), | (vertical
* bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must
* not be the literal string arn.
*
*
* @param timerId
* The unique ID of the timer.
*
* The specified string must not contain a : (colon), / (slash), |
* (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also,
* it must not be the literal string arn.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTimerDecisionAttributes withTimerId(String timerId) {
setTimerId(timerId);
return this;
}
/**
*
* The data attached to the event that can be used by the decider in subsequent workflow tasks.
*
*
* @param control
* The data attached to the event that can be used by the decider in subsequent workflow tasks.
*/
public void setControl(String control) {
this.control = control;
}
/**
*
* The data attached to the event that can be used by the decider in subsequent workflow tasks.
*
*
* @return The data attached to the event that can be used by the decider in subsequent workflow tasks.
*/
public String getControl() {
return this.control;
}
/**
*
* The data attached to the event that can be used by the decider in subsequent workflow tasks.
*
*
* @param control
* The data attached to the event that can be used by the decider in subsequent workflow tasks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTimerDecisionAttributes withControl(String control) {
setControl(control);
return this;
}
/**
*
* The duration to wait before firing the timer.
*
*
* The duration is specified in seconds, an integer greater than or equal to 0.
*
*
* @param startToFireTimeout
* The duration to wait before firing the timer.
*
* The duration is specified in seconds, an integer greater than or equal to 0.
*/
public void setStartToFireTimeout(String startToFireTimeout) {
this.startToFireTimeout = startToFireTimeout;
}
/**
*
* The duration to wait before firing the timer.
*
*
* The duration is specified in seconds, an integer greater than or equal to 0.
*
*
* @return The duration to wait before firing the timer.
*
* The duration is specified in seconds, an integer greater than or equal to 0.
*/
public String getStartToFireTimeout() {
return this.startToFireTimeout;
}
/**
*
* The duration to wait before firing the timer.
*
*
* The duration is specified in seconds, an integer greater than or equal to 0.
*
*
* @param startToFireTimeout
* The duration to wait before firing the timer.
*
* The duration is specified in seconds, an integer greater than or equal to 0.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTimerDecisionAttributes withStartToFireTimeout(String startToFireTimeout) {
setStartToFireTimeout(startToFireTimeout);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTimerId() != null)
sb.append("TimerId: ").append(getTimerId()).append(",");
if (getControl() != null)
sb.append("Control: ").append(getControl()).append(",");
if (getStartToFireTimeout() != null)
sb.append("StartToFireTimeout: ").append(getStartToFireTimeout());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartTimerDecisionAttributes == false)
return false;
StartTimerDecisionAttributes other = (StartTimerDecisionAttributes) obj;
if (other.getTimerId() == null ^ this.getTimerId() == null)
return false;
if (other.getTimerId() != null && other.getTimerId().equals(this.getTimerId()) == false)
return false;
if (other.getControl() == null ^ this.getControl() == null)
return false;
if (other.getControl() != null && other.getControl().equals(this.getControl()) == false)
return false;
if (other.getStartToFireTimeout() == null ^ this.getStartToFireTimeout() == null)
return false;
if (other.getStartToFireTimeout() != null && other.getStartToFireTimeout().equals(this.getStartToFireTimeout()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTimerId() == null) ? 0 : getTimerId().hashCode());
hashCode = prime * hashCode + ((getControl() == null) ? 0 : getControl().hashCode());
hashCode = prime * hashCode + ((getStartToFireTimeout() == null) ? 0 : getStartToFireTimeout().hashCode());
return hashCode;
}
@Override
public StartTimerDecisionAttributes clone() {
try {
return (StartTimerDecisionAttributes) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.simpleworkflow.model.transform.StartTimerDecisionAttributesMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}