Package software.amazon.awssdk.services.swf.model

Class RegisterActivityTypeRequest

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.RegisterActivityTypeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterActivityTypeRequest.Builder,RegisterActivityTypeRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterActivityTypeRequest extends SwfRequest implements ToCopyableBuilder<RegisterActivityTypeRequest.Builder,RegisterActivityTypeRequest>

  • Method Details

    • domain

      public final String domain()

      The name of the domain in which this activity is to be registered.

      Returns:
      The name of the domain in which this activity is to be registered.

    • name

      public final String name()

      The name of the activity type within the domain.

      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 activity type within the domain.

      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 activity type.

      The activity type consists of the name and version, the combination of which must be unique within the domain.

      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 activity type.

      The activity type consists of the name and version, the combination of which must be unique within the domain.

      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()

      A textual description of the activity type.

      Returns:
      A textual description of the activity type.

    • defaultTaskStartToCloseTimeout

      public final String defaultTaskStartToCloseTimeout()

      If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask 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 that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • defaultTaskHeartbeatTimeout

      public final String defaultTaskHeartbeatTimeout()

      If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

      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 time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • defaultTaskList

      public final TaskList defaultTaskList()

      If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

      Returns:
      If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

    • defaultTaskPriority

      public final String defaultTaskPriority()

      The default task priority to assign to the activity 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 in the Amazon SWF Developer Guide..

      Returns:
      The default task priority to assign to the activity 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 in the Amazon SWF Developer Guide..

    • defaultTaskScheduleToStartTimeout

      public final String defaultTaskScheduleToStartTimeout()

      If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask 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 that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • defaultTaskScheduleToCloseTimeout

      public final String defaultTaskScheduleToCloseTimeout()

      If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask 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 for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • toBuilder

      public RegisterActivityTypeRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RegisterActivityTypeRequest.Builder,RegisterActivityTypeRequest>
      Specified by:
      toBuilder in class SwfRequest
      Returns:
      a builder for type T

    • builder

      public static RegisterActivityTypeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RegisterActivityTypeRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.