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.

      Returns:
      The run's workflow ID.

    • workflowType

      public final WorkflowType workflowType()

      The run's 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.
      See Also:

    • workflowTypeAsString

      public final String workflowTypeAsString()

      The run's 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.
      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.

      Returns:
      A service role for the run.

    • name

      public final String name()

      A name for the run.

      Returns:
      A name for the run.

    • runGroupId

      public final String runGroupId()

      The run's group ID.

      Returns:
      The run's group ID.

    • priority

      public final Integer priority()

      A priority for the run.

      Returns:
      A priority for the run.

    • parameters

      public final Document parameters()

      Parameters for the run.

      Returns:
      Parameters for the run.

    • storageCapacity

      public final Integer storageCapacity()

      A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

      Returns:
      A storage capacity for the run in gibibytes. 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 URI for the run.

      Returns:
      An output URI for the run.

    • 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.

      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.

    • requestId

      public final String requestId()

      To ensure that requests don't run multiple times, specify a unique ID for each request.

      Returns:
      To ensure that requests don't run multiple times, specify a unique ID for each request.

    • retentionMode

      public final RunRetentionMode retentionMode()

      The retention mode for the run.

      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.
      See Also:

    • retentionModeAsString

      public final String retentionModeAsString()

      The retention mode for the run.

      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.
      See Also:

    • storageType

      public final StorageType storageType()

      The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

      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 run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.
      See Also:

    • storageTypeAsString

      public final String storageTypeAsString()

      The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

      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 run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.
      See Also:

    • workflowOwnerId

      public final String workflowOwnerId()

      The ID of the workflow owner.

      Returns:
      The ID of the workflow owner.

    • 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.