RegisterWorkflowTypeRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.swf.model.SwfRequest
    - - software.amazon.awssdk.services.swf.model.RegisterWorkflowTypeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RegisterWorkflowTypeRequest.Builder,RegisterWorkflowTypeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterWorkflowTypeRequest
extends SwfRequest
implements ToCopyableBuilder<RegisterWorkflowTypeRequest.Builder,RegisterWorkflowTypeRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RegisterWorkflowTypeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RegisterWorkflowTypeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RegisterWorkflowTypeRequest.Builder`	`builder()`
`ChildPolicy`	`defaultChildPolicy()` If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
`String`	`defaultChildPolicyAsString()` If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
`String`	`defaultExecutionStartToCloseTimeout()` If set, specifies the default maximum duration for executions of this workflow type.
`String`	`defaultLambdaRole()` The default IAM role attached to this workflow type.
`TaskList`	`defaultTaskList()` If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.
`String`	`defaultTaskPriority()` The default task priority to assign to the workflow type.
`String`	`defaultTaskStartToCloseTimeout()` If set, specifies the default maximum duration of decision tasks for this workflow type.
`String`	`description()` Textual description of the workflow type.
`String`	`domain()` The name of the domain in which to register the workflow type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()` The name of the workflow type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegisterWorkflowTypeRequest.Builder>`	`serializableBuilderClass()`
`RegisterWorkflowTypeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The version of the workflow type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - domain
```
public final String domain()
```
    The name of the domain in which to register the workflow type.
    
    Returns:
    
    The name of the domain in which to register the workflow type.
  - name
```
public final String name()
```
    The name of the workflow type.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
    
    Returns:
    
    The name of the workflow type.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
  - version
```
public final String version()
```
    The version of the workflow type.
    
    The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
    
    Returns:
    
    The version of the workflow type.
    
    The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
  - description
```
public final String description()
```
    Textual description of the workflow type.
    
    Returns:
    
    Textual description of the workflow type.
  - defaultTaskStartToCloseTimeout
```
public final String defaultTaskStartToCloseTimeout()
```
    If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    Returns:
    
    If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
  - defaultExecutionStartToCloseTimeout
```
public final String defaultExecutionStartToCloseTimeout()
```
    If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
    
    The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.
    
    Returns:
    
    If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
    
    The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.
  - defaultTaskList
```
public final TaskList defaultTaskList()
```
    If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
    
    Returns:
    
    If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
  - defaultTaskPriority
```
public final String defaultTaskPriority()
```
    The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
    
    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
    
    Returns:
    
    The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
    
    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
  - defaultChildPolicy
```
public final ChildPolicy defaultChildPolicy()
```
    If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
    
    The supported child policies are:
    - TERMINATE – The child executions are terminated.
    - REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
    - ABANDON – No action is taken. The child executions continue to run.
    If the service returns an enum value that is not available in the current SDK version, defaultChildPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultChildPolicyAsString().
    Returns:
    If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
    
    The supported child policies are:
    
    TERMINATE – The child executions are terminated.
    
    REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
    
    ABANDON – No action is taken. The child executions continue to run.
    See Also:
    
    ChildPolicy
  - defaultChildPolicyAsString
```
public final String defaultChildPolicyAsString()
```
    If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
    
    The supported child policies are:
    - TERMINATE – The child executions are terminated.
    - REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
    - ABANDON – No action is taken. The child executions continue to run.
    If the service returns an enum value that is not available in the current SDK version, defaultChildPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultChildPolicyAsString().
    Returns:
    If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
    
    The supported child policies are:
    
    TERMINATE – The child executions are terminated.
    
    REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
    
    ABANDON – No action is taken. The child executions continue to run.
    See Also:
    
    ChildPolicy
  - defaultLambdaRole
```
public final String defaultLambdaRole()
```
    The default IAM role attached to this workflow type.
    
    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/ amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
    
    Returns:
    
    The default IAM role attached to this workflow type.
    
    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https ://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
  - toBuilder
```
public RegisterWorkflowTypeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterWorkflowTypeRequest.Builder,RegisterWorkflowTypeRequest>
    
    Specified by:
    
    toBuilder in class SwfRequest
  - builder
```
public static RegisterWorkflowTypeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterWorkflowTypeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegisterWorkflowTypeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

domain

name

version

description

defaultTaskStartToCloseTimeout

defaultExecutionStartToCloseTimeout

defaultTaskList

defaultTaskPriority

defaultChildPolicy

defaultChildPolicyAsString

defaultLambdaRole

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields