Class DefaultRunSetting

java.lang.Object
software.amazon.awssdk.services.omics.model.DefaultRunSetting
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DefaultRunSetting.Builder,DefaultRunSetting>
@Generated("software.amazon.awssdk:codegen") public final class DefaultRunSetting extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DefaultRunSetting.Builder,DefaultRunSetting>

Shared configuration applied to all runs in a batch. Fields specified in a per-run InlineSetting entry override the corresponding fields in this object for that run. The parameters and runTags fields are merged rather than replaced — run-specific values take precedence when keys overlap.

See Also:

  • Method Details

    • workflowId

      public final String workflowId()

      The identifier of the workflow to run.

      Returns:
      The identifier of the workflow to run.

    • workflowType

      public final WorkflowType workflowType()

      The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

      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 type of the originating workflow. Batch runs are not supported with READY2RUN workflows.
      See Also:

    • workflowTypeAsString

      public final String workflowTypeAsString()

      The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

      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 type of the originating workflow. Batch runs are not supported with READY2RUN workflows.
      See Also:

    • roleArn

      public final String roleArn()

      The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

      Returns:
      The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

    • name

      public final String name()

      An optional user-friendly name applied to each workflow run. Can be overridden per run.

      Returns:
      An optional user-friendly name applied to each workflow run. Can be overridden per run.

    • cacheId

      public final String cacheId()

      The identifier of the run cache to associate with the runs.

      Returns:
      The identifier of the run cache to associate with the runs.

    • cacheBehavior

      public final CacheBehavior cacheBehavior()

      The cache behavior for the runs. Requires cacheId to be set.

      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 runs. Requires cacheId to be set.
      See Also:

    • cacheBehaviorAsString

      public final String cacheBehaviorAsString()

      The cache behavior for the runs. Requires cacheId to be set.

      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 runs. Requires cacheId to be set.
      See Also:

    • runGroupId

      public final String runGroupId()

      The ID of the run group to contain all workflow runs in the batch.

      Returns:
      The ID of the run group to contain all workflow runs in the batch.

    • priority

      public final Integer priority()

      An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

      Returns:
      An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

    • parameters

      public final Document parameters()

      Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

      Returns:
      Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

    • storageCapacity

      public final Integer storageCapacity()

      The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

      Returns:
      The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

    • outputUri

      public final String outputUri()

      The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

      Returns:
      The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

    • logLevel

      public final RunLogLevel logLevel()

      The verbosity level for CloudWatch Logs emitted during each 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:
      The verbosity level for CloudWatch Logs emitted during each run.
      See Also:

    • logLevelAsString

      public final String logLevelAsString()

      The verbosity level for CloudWatch Logs emitted during each 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:
      The verbosity level for CloudWatch Logs emitted during each run.
      See Also:

    • hasRunTags

      public final boolean hasRunTags()
      For responses, this returns true if the service returned a value for the RunTags 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.

    • runTags

      public final Map<String,String> runTags()

      AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

      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 hasRunTags() method.

      Returns:
      AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

    • retentionMode

      public final RunRetentionMode retentionMode()

      The retention behavior for runs after completion.

      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 behavior for runs after completion.
      See Also:

    • retentionModeAsString

      public final String retentionModeAsString()

      The retention behavior for runs after completion.

      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 behavior for runs after completion.
      See Also:

    • storageType

      public final StorageType storageType()

      The storage type for the workflow runs.

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

    • storageTypeAsString

      public final String storageTypeAsString()

      The storage type for the workflow runs.

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

    • workflowOwnerId

      public final String workflowOwnerId()

      The AWS account ID of the workflow owner, used for cross-account workflow sharing.

      Returns:
      The AWS account ID of the workflow owner, used for cross-account workflow sharing.

    • outputBucketOwnerId

      public final String outputBucketOwnerId()

      The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

      Returns:
      The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

    • workflowVersionName

      public final String workflowVersionName()

      The version name of the specified workflow.

      Returns:
      The version name of the specified workflow.

    • toBuilder

      public DefaultRunSetting.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<DefaultRunSetting.Builder,DefaultRunSetting>
      Returns:
      a builder for type T

    • builder

      public static DefaultRunSetting.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DefaultRunSetting.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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