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

Class GetRunResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.omics.model.OmicsResponse

software.amazon.awssdk.services.omics.model.GetRunResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetRunResponse.Builder,GetRunResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetRunResponse
extends OmicsResponse
implements ToCopyableBuilder<GetRunResponse.Builder,GetRunResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetRunResponse.Builder

Method Summary

Modifier and Type	Method	Description
Accelerators	accelerators()	The computational accelerator used to run the workflow.
String	acceleratorsAsString()	The computational accelerator used to run the workflow.
String	arn()	The run's ARN.
static GetRunResponse.Builder	builder()
CacheBehavior	cacheBehavior()	The run cache behavior for the run.
String	cacheBehaviorAsString()	The run cache behavior for the run.
String	cacheId()	The run cache associated with the run.
Instant	creationTime()	When the run was created.
String	definition()	The run's definition.
String	digest()	The run's digest.
String	engineVersion()	The workflow engine version.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	The reason a run has failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceDigests()	For responses, this returns true if the service returned a value for the ResourceDigests property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	id()	The run's ID.
RunLogLevel	logLevel()	The run's log level.
String	logLevelAsString()	The run's log level.
RunLogLocation	logLocation()	The location of the run log.
String	name()	The run's name.
String	outputUri()	The run's output URI.
Document	parameters()	The run's parameters.
Integer	priority()	The run's priority.
Map<String,String>	resourceDigests()	The run's resource digests.
RunRetentionMode	retentionMode()	The run's retention mode.
String	retentionModeAsString()	The run's retention mode.
String	roleArn()	The run's service role ARN.
String	runGroupId()	The run's group ID.
String	runId()	The run's ID.
String	runOutputUri()	The destination for workflow outputs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetRunResponse.Builder>	serializableBuilderClass()
String	startedBy()	Who started the run.
Instant	startTime()	When the run started.
RunStatus	status()	The run's status.
String	statusAsString()	The run's status.
String	statusMessage()	The run's status message.
Instant	stopTime()	The run's stop time.
Integer	storageCapacity()	The run's storage capacity in gibibytes.
StorageType	storageType()	The run's storage type.
String	storageTypeAsString()	The run's storage type.
Map<String,String>	tags()	The run's tags.
GetRunResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	uuid()	The universally unique identifier for a run.
String	workflowId()	The run's workflow ID.
String	workflowOwnerId()	The ID of the workflow owner.
WorkflowType	workflowType()	The run's workflow type.
String	workflowTypeAsString()	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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

The run's ARN.

Returns:

The run's ARN.

id

public final String id()

The run's ID.

Returns:

The run's ID.

cacheId

public final String cacheId()

The run cache associated with the run.

Returns:

The run cache associated with the run.

cacheBehavior

public final CacheBehavior cacheBehavior()

The run cache behavior for the run.

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 run cache behavior for the run.

See Also:

CacheBehavior

cacheBehaviorAsString

public final String cacheBehaviorAsString()

The run cache behavior for the run.

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 run cache behavior for the run.

See Also:

CacheBehavior

engineVersion

public final String engineVersion()

The workflow engine version.

Returns:

The workflow engine version.

status

public final RunStatus status()

The run's status.

If the service returns an enum value that is not available in the current SDK version, status will return RunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The run's status.

See Also:

RunStatus

statusAsString

public final String statusAsString()

The run's status.

If the service returns an enum value that is not available in the current SDK version, status will return RunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The run's status.

See Also:

RunStatus

workflowId

public final String workflowId()

The run's workflow ID.

Returns:

The run's workflow ID.

workflowType

public final WorkflowType workflowType()

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

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 run's ID.

Returns:

The run's ID.

roleArn

public final String roleArn()

The run's service role ARN.

Returns:

The run's service role ARN.

name

public final String name()

The run's name.

Returns:

The run's name.

runGroupId

public final String runGroupId()

The run's group ID.

Returns:

The run's group ID.

priority

public final Integer priority()

The run's priority.

Returns:

The run's priority.

definition

public final String definition()

The run's definition.

Returns:

The run's definition.

digest

public final String digest()

The run's digest.

Returns:

The run's digest.

parameters

public final Document parameters()

The run's parameters.

Returns:

The run's parameters.

storageCapacity

public final Integer 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

public final String outputUri()

The run's output URI.

Returns:

The run's output URI.

logLevel

public final RunLogLevel logLevel()

The run's log level.

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:

The run's log level.

See Also:

RunLogLevel

logLevelAsString

public final String logLevelAsString()

The run's log level.

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:

The run's log level.

See Also:

RunLogLevel

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

resourceDigests

public final Map<String,String> 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

public final String startedBy()

Who started the run.

Returns:

Who started the run.

creationTime

public final Instant creationTime()

When the run was created.

Returns:

When the run was created.

startTime

public final Instant startTime()

When the run started.

Returns:

When the run started.

stopTime

public final Instant stopTime()

The run's stop time.

Returns:

The run's stop time.

statusMessage

public final String 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 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()

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

public final Accelerators 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 return Accelerators.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorsAsString().

Returns:

The computational accelerator used to run the workflow.

See Also:

Accelerators

acceleratorsAsString

public final String 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 return Accelerators.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorsAsString().

Returns:

The computational accelerator used to run the workflow.

See Also:

Accelerators

retentionMode

public final RunRetentionMode retentionMode()

The run's retention mode.

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 run's retention mode.

See Also:

RunRetentionMode

retentionModeAsString

public final String retentionModeAsString()

The run's retention mode.

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 run's retention mode.

See Also:

RunRetentionMode

failureReason

public final String failureReason()

The reason a run has failed.

Returns:

The reason a run has failed.

logLocation

public final RunLogLocation logLocation()

The location of the run log.

Returns:

The location of the run log.

uuid

public final String uuid()

The universally unique identifier for a run.

Returns:

The universally unique identifier for a run.

runOutputUri

public final String runOutputUri()

The destination for workflow outputs.

Returns:

The destination for workflow outputs.

storageType

public final StorageType storageType()

The run's storage type.

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.

See Also:

StorageType

storageTypeAsString

public final String storageTypeAsString()

The run's storage type.

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.

See Also:

StorageType

workflowOwnerId

public final String workflowOwnerId()

The ID of the workflow owner.

Returns:

The ID of the workflow owner.

toBuilder

public GetRunResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetRunResponse.Builder,GetRunResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetRunResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetRunResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo