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

Class CreateRunCacheRequest

    • Method Detail

      • cacheBehavior

        public final CacheBehavior cacheBehavior()

        Default cache behavior for runs that use this cache. Supported values are:

        CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

        CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

        If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

        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:
        Default cache behavior for runs that use this cache. Supported values are:

        CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

        CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

        If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

        For more information, see Run cache behavior in the AWS HealthOmics User Guide.

        See Also:
        CacheBehavior

      • cacheBehaviorAsString

        public final String cacheBehaviorAsString()

        Default cache behavior for runs that use this cache. Supported values are:

        CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

        CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

        If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

        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:
        Default cache behavior for runs that use this cache. Supported values are:

        CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

        CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

        If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

        For more information, see Run cache behavior in the AWS HealthOmics User Guide.

        See Also:
        CacheBehavior

      • cacheS3Location

        public final String cacheS3Location()

        Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).

        Returns:
        Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).

      • description

        public final String description()

        Enter a description of the run cache.

        Returns:
        Enter a description of the run cache.

      • name

        public final String name()

        Enter a user-friendly name for the run cache.

        Returns:
        Enter a user-friendly name for the run cache.

      • requestId

        public final String requestId()

        A unique request token, to ensure idempotency. If you don't specify a token, HealthOmics automatically generates a universally unique identifier (UUID) for the request.

        Returns:
        A unique request token, to ensure idempotency. If you don't specify a token, HealthOmics automatically generates a universally unique identifier (UUID) for the request.

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

        Specify one or more tags to associate with this run cache.

        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:
        Specify one or more tags to associate with this run cache.

      • cacheBucketOwnerId

        public final String cacheBucketOwnerId()

        The AWS account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.

        Returns:
        The AWS account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.

      • 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