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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateWorkflowRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Accelerators`	`accelerators()` The computational accelerator specified to run the workflow.
`String`	`acceleratorsAsString()` The computational accelerator specified to run the workflow.
`static CreateWorkflowRequest.Builder`	`builder()`
`String`	`definitionUri()` The URI of a definition for the workflow.
`SdkBytes`	`definitionZip()` A ZIP archive for the workflow.
`String`	`description()` A description for the workflow.
`WorkflowEngine`	`engine()` An engine for the workflow.
`String`	`engineAsString()` An engine for the workflow.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameterTemplate()` For responses, this returns true if the service returned a value for the ParameterTemplate property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`main()` The path of the main definition file for the workflow.
`String`	`name()` A name for the workflow.
`Map<String,WorkflowParameter>`	`parameterTemplate()` A parameter template for the workflow.
`String`	`requestId()` To ensure that requests don't run multiple times, specify a unique ID for each request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateWorkflowRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`storageCapacity()` A storage capacity for the workflow in gigabytes.
`Map<String,String>`	`tags()` Tags for the workflow.
`CreateWorkflowRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - name
```
public final String name()
```
    A name for the workflow.
    
    Returns:
    
    A name for the workflow.
  - description
```
public final String description()
```
    A description for the workflow.
    
    Returns:
    
    A description for the workflow.
  - engine
```
public final WorkflowEngine engine()
```
    An engine for the workflow.
    
    If the service returns an enum value that is not available in the current SDK version, engine will return WorkflowEngine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineAsString().
    
    Returns:
    
    An engine for the workflow.
    
    See Also:
    
    WorkflowEngine
  - engineAsString
```
public final String engineAsString()
```
    An engine for the workflow.
    
    If the service returns an enum value that is not available in the current SDK version, engine will return WorkflowEngine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineAsString().
    
    Returns:
    
    An engine for the workflow.
    
    See Also:
    
    WorkflowEngine
  - definitionZip
```
public final SdkBytes definitionZip()
```
    A ZIP archive for the workflow.
    
    Returns:
    
    A ZIP archive for the workflow.
  - definitionUri
```
public final String definitionUri()
```
    The URI of a definition for the workflow.
    
    Returns:
    
    The URI of a definition for the workflow.
  - main
```
public final String main()
```
    The path of the main definition file for the workflow.
    
    Returns:
    
    The path of the main definition file for the workflow.
  - hasParameterTemplate
```
public final boolean hasParameterTemplate()
```
    For responses, this returns true if the service returned a value for the ParameterTemplate 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.
  - parameterTemplate
```
public final Map<String,WorkflowParameter> parameterTemplate()
```
    A parameter template for the workflow.
    
    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 hasParameterTemplate() method.
    
    Returns:
    
    A parameter template for the workflow.
  - storageCapacity
```
public final Integer storageCapacity()
```
    A storage capacity for the workflow in gigabytes.
    
    Returns:
    
    A storage capacity for the workflow in gigabytes.
  - 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 workflow.
    
    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 workflow.
  - 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.
  - accelerators
```
public final Accelerators accelerators()
```
    The computational accelerator specified 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 specified to run the workflow.
    
    See Also:
    
    Accelerators
  - acceleratorsAsString
```
public final String acceleratorsAsString()
```
    The computational accelerator specified 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 specified to run the workflow.
    
    See Also:
    
    Accelerators
  - toBuilder
```
public CreateWorkflowRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>
    
    Specified by:
    
    toBuilder in class OmicsRequest
  - builder
```
public static CreateWorkflowRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateWorkflowRequest.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 CreateWorkflowRequest

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

name

description

engine

engineAsString

definitionZip

definitionUri

main

hasParameterTemplate

parameterTemplate

storageCapacity

hasTags

tags

requestId

accelerators

acceleratorsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields