Class UpdateStepRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.deadline.model.DeadlineRequest
software.amazon.awssdk.services.deadline.model.UpdateStepRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateStepRequest.Builder,UpdateStepRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateStepRequest extends DeadlineRequest implements ToCopyableBuilder<UpdateStepRequest.Builder,UpdateStepRequest>

  • Method Details

    • targetTaskRunStatus

      public final StepTargetTaskRunStatus targetTaskRunStatus()

      The task status to update the step's tasks to.

      If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return StepTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().

      Returns:
      The task status to update the step's tasks to.
      See Also:

    • targetTaskRunStatusAsString

      public final String targetTaskRunStatusAsString()

      The task status to update the step's tasks to.

      If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return StepTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().

      Returns:
      The task status to update the step's tasks to.
      See Also:

    • clientToken

      public final String clientToken()

      The unique token which the server uses to recognize retries of the same request.

      Returns:
      The unique token which the server uses to recognize retries of the same request.

    • farmId

      public final String farmId()

      The farm ID to update.

      Returns:
      The farm ID to update.

    • queueId

      public final String queueId()

      The queue ID to update.

      Returns:
      The queue ID to update.

    • jobId

      public final String jobId()

      The job ID to update.

      Returns:
      The job ID to update.

    • stepId

      public final String stepId()

      The step ID to update.

      Returns:
      The step ID to update.

    • toBuilder

      public UpdateStepRequest.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<UpdateStepRequest.Builder,UpdateStepRequest>
      Specified by:
      toBuilder in class DeadlineRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateStepRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateStepRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.