Package software.amazon.awssdk.services.codecatalyst.model

Class StartWorkflowRunRequest

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

  • Method Details

    • spaceName

      public final String spaceName()

      The name of the space.

      Returns:
      The name of the space.

    • projectName

      public final String projectName()

      The name of the project in the space.

      Returns:
      The name of the project in the space.

    • workflowId

      public final String workflowId()

      The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

      Returns:
      The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

    • clientToken

      public final String clientToken()

      A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

      Returns:
      A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

    • toBuilder

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

    • builder

      public static StartWorkflowRunRequest.Builder builder()

    • serializableBuilderClass

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