Class StartRunRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartRunRequest.Builder,
StartRunRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic StartRunRequest.Builder
builder()
final CacheBehavior
The cache behavior for the run.final String
The cache behavior for the run.final String
cacheId()
Identifier of the cache associated with this run.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final RunLogLevel
logLevel()
A log level for the run.final String
A log level for the run.final String
name()
A name for the run.final String
An output URI for the run.final Document
Parameters for the run.final Integer
priority()
A priority for the run.final String
To ensure that requests don't run multiple times, specify a unique ID for each request.final RunRetentionMode
The retention mode for the run.final String
The retention mode for the run.final String
roleArn()
A service role for the run.final String
The run's group ID.final String
runId()
The ID of a run to duplicate.static Class
<? extends StartRunRequest.Builder> final Integer
The static storage capacity (in gibibytes) for this run.final StorageType
The storage type for the run.final String
The storage type for the run.tags()
Tags for the run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The run's workflow ID.final String
The ID of the workflow owner.final WorkflowType
The run's workflow type.final String
The run's workflow type.final String
The name of the workflow version.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
workflowId
-
workflowType
The run's workflow type.
If the service returns an enum value that is not available in the current SDK version,
workflowType
will returnWorkflowType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromworkflowTypeAsString()
.- Returns:
- The run's workflow type.
- See Also:
-
workflowTypeAsString
The run's workflow type.
If the service returns an enum value that is not available in the current SDK version,
workflowType
will returnWorkflowType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromworkflowTypeAsString()
.- Returns:
- The run's workflow type.
- See Also:
-
runId
-
roleArn
-
name
-
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
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 Amazon Web Services HealthOmics User Guide.
If the service returns an enum value that is not available in the current SDK version,
cacheBehavior
will returnCacheBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcacheBehaviorAsString()
.- 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 Amazon Web Services HealthOmics User Guide.
- See Also:
-
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 Amazon Web Services HealthOmics User Guide.
If the service returns an enum value that is not available in the current SDK version,
cacheBehavior
will returnCacheBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcacheBehaviorAsString()
.- 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 Amazon Web Services HealthOmics User Guide.
- See Also:
-
runGroupId
-
priority
-
parameters
-
storageCapacity
The static storage capacity (in gibibytes) for this run. This field is not required if the storage type is dynamic (the system ignores any value that you enter).
- Returns:
- The static storage capacity (in gibibytes) for this run. This field is not required if the storage type is dynamic (the system ignores any value that you enter).
-
outputUri
-
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 returnRunLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogLevelAsString()
.- Returns:
- A log level for the run.
- See Also:
-
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 returnRunLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogLevelAsString()
.- 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 theisEmpty()
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
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
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
The retention mode for the run. The default value is RETAIN.
Amazon Web Services 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
, Amazon Web Services 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 Amazon Web Services HealthOmics User Guide.
If the service returns an enum value that is not available in the current SDK version,
retentionMode
will returnRunRetentionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromretentionModeAsString()
.- Returns:
- The retention mode for the run. The default value is RETAIN.
Amazon Web Services 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
, Amazon Web Services 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 Amazon Web Services HealthOmics User Guide.
- See Also:
-
retentionModeAsString
The retention mode for the run. The default value is RETAIN.
Amazon Web Services 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
, Amazon Web Services 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 Amazon Web Services HealthOmics User Guide.
If the service returns an enum value that is not available in the current SDK version,
retentionMode
will returnRunRetentionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromretentionModeAsString()
.- Returns:
- The retention mode for the run. The default value is RETAIN.
Amazon Web Services 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
, Amazon Web Services 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 Amazon Web Services HealthOmics User Guide.
- See Also:
-
storageType
The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
If the service returns an enum value that is not available in the current SDK version,
storageType
will returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
- See Also:
-
storageTypeAsString
The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
If the service returns an enum value that is not available in the current SDK version,
storageType
will returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
- See Also:
-
workflowOwnerId
The ID of the workflow owner.
- Returns:
- The ID of the workflow owner.
-
workflowVersionName
The name of the workflow version.
- Returns:
- The name of the workflow version.
-
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 interfaceToCopyableBuilder<StartRunRequest.Builder,
StartRunRequest> - Specified by:
toBuilder
in classOmicsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-