/*************************************************************************
* Copyright 2014 Eucalyptus Systems, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*
* Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta
* CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you
* need additional information or have any questions.
*
* This file may incorporate work covered under the following copyright
* and permission notice:
* Copyright 2010-2015 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.eucalyptus.simpleworkflow.common.model;
import static com.eucalyptus.simpleworkflow.common.model.SimpleWorkflowMessage.FieldRegex;
import static com.eucalyptus.simpleworkflow.common.model.SimpleWorkflowMessage.FieldRegexValue;
import java.io.Serializable;
import javax.annotation.Nonnull;
/**
* <p>
* Provides details of the <code>StartTimer</code> decision.
* </p>
* <p>
* <b>Access Control</b>
* </p>
* <p>
* You can use IAM policies to control this decision's access to Amazon
* SWF resources as follows:
* </p>
*
* <ul>
* <li>Use a <code>Resource</code> element with the domain name to limit
* the action to only specified domains.</li>
* <li>Use an <code>Action</code> element to allow or deny permission to
* call this action.</li>
* <li>You cannot use an IAM policy to constrain this action's
* parameters.</li>
*
* </ul>
* <p>
* If the caller does not have sufficient permissions to invoke the
* action, or the parameter values fall outside the specified
* constraints, the action fails. The associated event attribute's
* <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For
* details and example IAM policies, see
* <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html"> Using IAM to Manage Access to Amazon SWF Workflows </a>
* .
* </p>
*/
public class StartTimerDecisionAttributes implements Serializable {
/**
* <b>Required.</b> The unique ID of the timer. <p>The specified string
* must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*/
@Nonnull
@FieldRegex( FieldRegexValue.NAME_256 )
private String timerId;
/**
* <i>Optional.</i> Data attached to the event that can be used by the
* decider in subsequent workflow tasks.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*/
@FieldRegex( FieldRegexValue.OPT_STRING_32768 )
private String control;
/**
* <b>Required.</b> The duration to wait before firing the timer. <p>The
* duration is specified in seconds; an integer greater than or equal to
* 0.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 8<br/>
*/
@Nonnull
@FieldRegex( FieldRegexValue.DURATION_8 )
private String startToFireTimeout;
/**
* <b>Required.</b> The unique ID of the timer. <p>The specified string
* must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @return <b>Required.</b> The unique ID of the timer. <p>The specified string
* must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*/
public String getTimerId() {
return timerId;
}
/**
* <b>Required.</b> The unique ID of the timer. <p>The specified string
* must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param timerId <b>Required.</b> The unique ID of the timer. <p>The specified string
* must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*/
public void setTimerId(String timerId) {
this.timerId = timerId;
}
/**
* <b>Required.</b> The unique ID of the timer. <p>The specified string
* must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param timerId <b>Required.</b> The unique ID of the timer. <p>The specified string
* must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartTimerDecisionAttributes withTimerId(String timerId) {
this.timerId = timerId;
return this;
}
/**
* <i>Optional.</i> Data attached to the event that can be used by the
* decider in subsequent workflow tasks.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*
* @return <i>Optional.</i> Data attached to the event that can be used by the
* decider in subsequent workflow tasks.
*/
public String getControl() {
return control;
}
/**
* <i>Optional.</i> Data attached to the event that can be used by the
* decider in subsequent workflow tasks.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*
* @param control <i>Optional.</i> Data attached to the event that can be used by the
* decider in subsequent workflow tasks.
*/
public void setControl(String control) {
this.control = control;
}
/**
* <i>Optional.</i> Data attached to the event that can be used by the
* decider in subsequent workflow tasks.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*
* @param control <i>Optional.</i> Data attached to the event that can be used by the
* decider in subsequent workflow tasks.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartTimerDecisionAttributes withControl(String control) {
this.control = control;
return this;
}
/**
* <b>Required.</b> The duration to wait before firing the timer. <p>The
* duration is specified in seconds; an integer greater than or equal to
* 0.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 8<br/>
*
* @return <b>Required.</b> The duration to wait before firing the timer. <p>The
* duration is specified in seconds; an integer greater than or equal to
* 0.
*/
public String getStartToFireTimeout() {
return startToFireTimeout;
}
/**
* <b>Required.</b> The duration to wait before firing the timer. <p>The
* duration is specified in seconds; an integer greater than or equal to
* 0.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 8<br/>
*
* @param startToFireTimeout <b>Required.</b> The duration to wait before firing the timer. <p>The
* duration is specified in seconds; an integer greater than or equal to
* 0.
*/
public void setStartToFireTimeout(String startToFireTimeout) {
this.startToFireTimeout = startToFireTimeout;
}
/**
* <b>Required.</b> The duration to wait before firing the timer. <p>The
* duration is specified in seconds; an integer greater than or equal to
* 0.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 8<br/>
*
* @param startToFireTimeout <b>Required.</b> The duration to wait before firing the timer. <p>The
* duration is specified in seconds; an integer greater than or equal to
* 0.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartTimerDecisionAttributes withStartToFireTimeout(String startToFireTimeout) {
this.startToFireTimeout = startToFireTimeout;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getTimerId() + ",");
if (getControl() != null) sb.append("Control: " + getControl() + ",");
if (getStartToFireTimeout() != null) sb.append("StartToFireTimeout: " + getStartToFireTimeout() );
sb.append("}");
return sb.toString();
}
@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 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;
}
}