Class CreateRunCacheRequest

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.CreateRunCacheRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRunCacheRequest.Builder,CreateRunCacheRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRunCacheRequest extends OmicsRequest implements ToCopyableBuilder<CreateRunCacheRequest.Builder,CreateRunCacheRequest>

  • Method Details

    • 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 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:
      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 Amazon Web Services HealthOmics User Guide.

      See Also:

    • 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 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:
      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 Amazon Web Services HealthOmics User Guide.

      See Also:

    • 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, Amazon Web Services 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, Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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.

    • toBuilder

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

    • builder

      public static CreateRunCacheRequest.Builder builder()

    • serializableBuilderClass

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