StartRunRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartRunRequest.Builder,StartRunRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartRunRequest
extends OmicsRequest
implements ToCopyableBuilder<StartRunRequest.Builder,StartRunRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartRunRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartRunRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartRunRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`RunLogLevel`	`logLevel()` A log level for the run.
`String`	`logLevelAsString()` A log level for the run.
`String`	`name()` A name for the run.
`String`	`outputUri()` An output URI for the run.
`Document`	`parameters()` Parameters for the run.
`Integer`	`priority()` A priority for the run.
`String`	`requestId()` To ensure that requests don't run multiple times, specify a unique ID for each request.
`String`	`roleArn()` A service role for the run.
`String`	`runGroupId()` The run's group ID.
`String`	`runId()` The run's ID.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartRunRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`storageCapacity()` A storage capacity for the run in gigabytes.
`Map<String,String>`	`tags()` Tags for the run.
`StartRunRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`workflowId()` The run's workflow ID.
`WorkflowType`	`workflowType()` The run's workflows type.
`String`	`workflowTypeAsString()` The run's workflows type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - workflowId
```
public final String workflowId()
```
    The run's workflow ID.
    
    Returns:
    
    The run's workflow ID.
  - workflowType
```
public final WorkflowType workflowType()
```
    The run's workflows 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 workflows type.
    
    See Also:
    
    WorkflowType
  - workflowTypeAsString
```
public final String workflowTypeAsString()
```
    The run's workflows 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 workflows type.
    
    See Also:
    
    WorkflowType
  - runId
```
public final String runId()
```
    The run's ID.
    
    Returns:
    
    The run's ID.
  - roleArn
```
public final String roleArn()
```
    A service role for the run.
    
    Returns:
    
    A service role for the run.
  - name
```
public final String name()
```
    A name for the run.
    
    Returns:
    
    A name for the run.
  - runGroupId
```
public final String runGroupId()
```
    The run's group ID.
    
    Returns:
    
    The run's group ID.
  - priority
```
public final Integer priority()
```
    A priority for the run.
    
    Returns:
    
    A priority for the run.
  - parameters
```
public final Document parameters()
```
    Parameters for the run.
    
    Returns:
    
    Parameters for the run.
  - storageCapacity
```
public final Integer storageCapacity()
```
    A storage capacity for the run in gigabytes.
    
    Returns:
    
    A storage capacity for the run in gigabytes.
  - outputUri
```
public final String outputUri()
```
    An output URI for the run.
    
    Returns:
    
    An output URI for the run.
  - logLevel
```
public final RunLogLevel 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 return RunLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().
    
    Returns:
    
    A log level for the run.
    
    See Also:
    
    RunLogLevel
  - logLevelAsString
```
public final String 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 return RunLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().
    
    Returns:
    
    A log level for the run.
    
    See Also:
    
    RunLogLevel
  - 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()
```
    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
```
public final String 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.
  - toBuilder
```
public StartRunRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartRunRequest.Builder,StartRunRequest>
    
    Specified by:
    
    toBuilder in class OmicsRequest
  - builder
```
public static StartRunRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartRunRequest.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)
```
    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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartRunRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

workflowId

workflowType

workflowTypeAsString

runId

roleArn

name

runGroupId

priority

parameters

storageCapacity

outputUri

logLevel

logLevelAsString

hasTags

tags

requestId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields