Interface StartWorkflowRunRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeCatalystRequest.Builder, CopyableBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>, SdkBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartWorkflowRunRequest
@Mutable @NotThreadSafe public static interface StartWorkflowRunRequest.Builder extends CodeCatalystRequest.Builder, SdkPojo, CopyableBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>

  • Method Details

    • spaceName

      StartWorkflowRunRequest.Builder spaceName(String spaceName)

      The name of the space.

      Parameters:
      spaceName - The name of the space.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • projectName

      StartWorkflowRunRequest.Builder projectName(String projectName)

      The name of the project in the space.

      Parameters:
      projectName - The name of the project in the space.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowId

      StartWorkflowRunRequest.Builder workflowId(String workflowId)

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

      Parameters:
      workflowId - The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartWorkflowRunRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartWorkflowRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartWorkflowRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.