Package software.amazon.awssdk.services.omics.model

Class StartRunRequest

    • Method Detail

      • workflowId

        public final String workflowId()

        The run's workflow ID.

        Returns:
        The run's workflow ID.

      • 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:
        WorkflowType

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

      • 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 AWS 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 AWS HealthOmics User Guide.
        See Also:
        CacheBehavior

      • 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 AWS 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 AWS HealthOmics User Guide.
        See Also:
        CacheBehavior

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

      • 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:
        RunLogLevel

      • 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. The default value is RETAIN.

        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, 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 AWS 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.

        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, 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 AWS HealthOmics User Guide.

        See Also:
        RunRetentionMode

      • retentionModeAsString

        public final String retentionModeAsString()

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

        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, 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 AWS 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.

        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, 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 AWS HealthOmics User Guide.

        See Also:
        RunRetentionMode

      • 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:
        StorageType

      • 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:
        StorageType

      • workflowOwnerId

        public final String workflowOwnerId()

        The ID of the workflow owner.

        Returns:
        The ID of the workflow owner.

      • 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