com.amazonaws.services.simpleworkflow.model

Class DescribeWorkflowTypeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.DescribeWorkflowTypeRequest

All Implemented Interfaces:

Serializable

public class DescribeWorkflowTypeRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeWorkflowType operation.

Returns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

Access Control

You can use IAM policies to control this action'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.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • workflowType.name : String constraint. The key is swf:workflowType.name .
  • workflowType.version : String constraint. The key is swf:workflowType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.describeWorkflowType(DescribeWorkflowTypeRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeWorkflowTypeRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomain() The name of the domain in which this workflow type is registered.
WorkflowType	getWorkflowType() The workflow type to describe.
int	hashCode()
void	setDomain(String domain) The name of the domain in which this workflow type is registered.
void	setWorkflowType(WorkflowType workflowType) The workflow type to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeWorkflowTypeRequest	withDomain(String domain) The name of the domain in which this workflow type is registered.
DescribeWorkflowTypeRequest	withWorkflowType(WorkflowType workflowType) The workflow type to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeWorkflowTypeRequest

public DescribeWorkflowTypeRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain in which this workflow type is registered.

Constraints:
Length: 1 - 256

Returns:

The name of the domain in which this workflow type is registered.

setDomain

public void setDomain(String domain)

The name of the domain in which this workflow type is registered.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain in which this workflow type is registered.

withDomain

public DescribeWorkflowTypeRequest withDomain(String domain)

The name of the domain in which this workflow type is registered.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain in which this workflow type is registered.

Returns:

A reference to this updated object so that method calls can be chained together.

getWorkflowType

public WorkflowType getWorkflowType()

The workflow type to describe.

Returns:

The workflow type to describe.

setWorkflowType

public void setWorkflowType(WorkflowType workflowType)

The workflow type to describe.

Parameters:

workflowType - The workflow type to describe.

withWorkflowType

public DescribeWorkflowTypeRequest withWorkflowType(WorkflowType workflowType)

The workflow type to describe.

Returns a reference to this object so that method calls can be chained together.

Parameters:

workflowType - The workflow type to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object