Class StartRunRequest

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

  • Method Details

    • workflowId

      public final String workflowId()

      The run's workflow ID. The workflowId is not the UUID.

      Returns:
      The run's workflow ID. The workflowId is not the UUID.

    • workflowType

      public final WorkflowType workflowType()

      The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.

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

      Returns:
      The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.
      See Also:

    • workflowTypeAsString

      public final String workflowTypeAsString()

      The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.

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

      Returns:
      The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.
      See Also:

    • runId

      public final String runId()

      The ID of a run to duplicate.

      Returns:
      The ID of a run to duplicate.

    • roleArn

      public final String roleArn()

      A service role for the run. The roleArn requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.

      Returns:
      A service role for the run. The roleArn requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.

    • name

      public final String name()

      A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.

      Returns:
      A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.

    • cacheId

      public final String cacheId()

      Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.

      Returns:
      Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.

    • cacheBehavior

      public final CacheBehavior cacheBehavior()

      The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

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

      Returns:
      The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.
      See Also:

    • cacheBehaviorAsString

      public final String cacheBehaviorAsString()

      The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

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

      Returns:
      The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.
      See Also:

    • runGroupId

      public final String runGroupId()

      The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.

      Returns:
      The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.

    • priority

      public final Integer priority()

      Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the Amazon Web Services HealthOmics User Guide.

      Returns:
      Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the Amazon Web Services HealthOmics User Guide.

    • parameters

      public final Document parameters()

      Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.

      Returns:
      Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.

    • storageCapacity

      public final Integer storageCapacity()

      The STATIC storage capacity (in gibibytes, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. This field is not required if the storage type is DYNAMIC (the system ignores any value that you enter).

      Returns:
      The STATIC storage capacity (in gibibytes, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. This field is not required if the storage type is DYNAMIC (the system ignores any value that you enter).

    • outputUri

      public final String outputUri()

      An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.

      Returns:
      An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.

    • logLevel

      public final RunLogLevel logLevel()

      A log level for the run.

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

      Returns:
      A log level for the run.
      See Also:

    • logLevelAsString

      public final String logLevelAsString()

      A log level for the run.

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

      Returns:
      A log level for the run.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      Tags for the run. You can add up to 50 tags per run. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Tags for the run. You can add up to 50 tags per run. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.

    • requestId

      public final String requestId()

      An idempotency token used to dedupe retry requests so that duplicate runs are not created.

      Returns:
      An idempotency token used to dedupe retry requests so that duplicate runs are not created.

    • retentionMode

      public final RunRetentionMode retentionMode()

      The retention mode for the run. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

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

      Returns:
      The retention mode for the run. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

      See Also:

    • retentionModeAsString

      public final String retentionModeAsString()

      The retention mode for the run. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

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

      Returns:
      The retention mode for the run. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

      See Also:

    • storageType

      public final StorageType storageType()

      The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.

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

      Returns:
      The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.
      See Also:

    • storageTypeAsString

      public final String storageTypeAsString()

      The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.

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

      Returns:
      The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.
      See Also:

    • workflowOwnerId

      public final String workflowOwnerId()

      The 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

      Returns:
      The 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

    • workflowVersionName

      public final String workflowVersionName()

      The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the Amazon Web Services HealthOmics User Guide.

      Returns:
      The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the Amazon Web Services HealthOmics User Guide.

    • toBuilder

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

    • builder

      public static StartRunRequest.Builder builder()

    • serializableBuilderClass

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