Class GetRunResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetRunResponse.Builder,
GetRunResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Accelerators
The computational accelerator used to run the workflow.final String
The computational accelerator used to run the workflow.final String
arn()
The run's ARN.static GetRunResponse.Builder
builder()
final Instant
When the run was created.final String
The run's definition.final String
digest()
The run's digest.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The reason a run has failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ResourceDigests property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The run's ID.final RunLogLevel
logLevel()
The run's log level.final String
The run's log level.final RunLogLocation
The location of the run log.final String
name()
The run's name.final String
The run's output URI.final Document
The run's parameters.final Integer
priority()
The run's priority.The run's resource digests.final RunRetentionMode
The run's retention mode.final String
The run's retention mode.final String
roleArn()
The run's service role ARN.final String
The run's group ID.final String
runId()
The run's ID.final String
The destination for workflow outputs.static Class
<? extends GetRunResponse.Builder> final String
Who started the run.final Instant
When the run started.final RunStatus
status()
The run's status.final String
The run's status.final String
The run's status message.final Instant
stopTime()
The run's stop time.final Integer
The run's storage capacity in gibibytes.final StorageType
The run's storage type.final String
The run's storage type.tags()
The run's tags.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
uuid()
The universally unique identifier for a run.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.Methods inherited from class software.amazon.awssdk.services.omics.model.OmicsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The run's ARN.
- Returns:
- The run's ARN.
-
id
The run's ID.
- Returns:
- The run's ID.
-
status
The run's status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The run's status.
- See Also:
-
statusAsString
The run's status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The run's status.
- See Also:
-
workflowId
The run's workflow ID.
- Returns:
- The run's workflow ID.
-
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
The run's ID.
- Returns:
- The run's ID.
-
roleArn
The run's service role ARN.
- Returns:
- The run's service role ARN.
-
name
The run's name.
- Returns:
- The run's name.
-
runGroupId
The run's group ID.
- Returns:
- The run's group ID.
-
priority
The run's priority.
- Returns:
- The run's priority.
-
definition
The run's definition.
- Returns:
- The run's definition.
-
digest
The run's digest.
- Returns:
- The run's digest.
-
parameters
The run's parameters.
- Returns:
- The run's parameters.
-
storageCapacity
The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
- Returns:
- The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
-
outputUri
The run's output URI.
- Returns:
- The run's output URI.
-
logLevel
The run's log level.
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:
- The run's log level.
- See Also:
-
logLevelAsString
The run's log level.
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:
- The run's log level.
- See Also:
-
hasResourceDigests
public final boolean hasResourceDigests()For responses, this returns true if the service returned a value for the ResourceDigests 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. -
resourceDigests
The run's resource digests.
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
hasResourceDigests()
method.- Returns:
- The run's resource digests.
-
startedBy
Who started the run.
- Returns:
- Who started the run.
-
creationTime
When the run was created.
- Returns:
- When the run was created.
-
startTime
When the run started.
- Returns:
- When the run started.
-
stopTime
The run's stop time.
- Returns:
- The run's stop time.
-
statusMessage
The run's status message.
- Returns:
- The run's status message.
-
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
The run's tags.
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:
- The run's tags.
-
accelerators
The computational accelerator used to run the workflow.
If the service returns an enum value that is not available in the current SDK version,
accelerators
will returnAccelerators.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceleratorsAsString()
.- Returns:
- The computational accelerator used to run the workflow.
- See Also:
-
acceleratorsAsString
The computational accelerator used to run the workflow.
If the service returns an enum value that is not available in the current SDK version,
accelerators
will returnAccelerators.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceleratorsAsString()
.- Returns:
- The computational accelerator used to run the workflow.
- See Also:
-
retentionMode
The run's retention mode.
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 run's retention mode.
- See Also:
-
retentionModeAsString
The run's retention mode.
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 run's retention mode.
- See Also:
-
failureReason
The reason a run has failed.
- Returns:
- The reason a run has failed.
-
logLocation
The location of the run log.
- Returns:
- The location of the run log.
-
uuid
The universally unique identifier for a run.
- Returns:
- The universally unique identifier for a run.
-
runOutputUri
The destination for workflow outputs.
- Returns:
- The destination for workflow outputs.
-
storageType
The run's storage type.
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 run's storage type.
- See Also:
-
storageTypeAsString
The run's storage type.
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 run's storage type.
- See Also:
-
workflowOwnerId
The ID of the workflow owner.
- Returns:
- The ID of the workflow owner.
-
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<GetRunResponse.Builder,
GetRunResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-