CreateWorkloadRequest (AWS Java SDK :: Services :: Well Architected 2.20.112 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.wellarchitected.model.WellArchitectedRequest
    - - software.amazon.awssdk.services.wellarchitected.model.CreateWorkloadRequest

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

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

Input for workload creation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateWorkloadRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`accountIds()` Returns the value of the AccountIds property for this object.
`List<String>`	`applications()` List of AppRegistry application ARNs associated to the workload.
`String`	`architecturalDesign()` Returns the value of the ArchitecturalDesign property for this object.
`List<String>`	`awsRegions()` Returns the value of the AwsRegions property for this object.
`static CreateWorkloadRequest.Builder`	`builder()`
`String`	`clientRequestToken()` Returns the value of the ClientRequestToken property for this object.
`String`	`description()` Returns the value of the Description property for this object.
`WorkloadDiscoveryConfig`	`discoveryConfig()` Well-Architected discovery configuration settings associated to the workload.
`WorkloadEnvironment`	`environment()` Returns the value of the Environment property for this object.
`String`	`environmentAsString()` Returns the value of the Environment property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccountIds()` For responses, this returns true if the service returned a value for the AccountIds property.
`boolean`	`hasApplications()` For responses, this returns true if the service returned a value for the Applications property.
`boolean`	`hasAwsRegions()` For responses, this returns true if the service returned a value for the AwsRegions property.
`int`	`hashCode()`
`boolean`	`hasLenses()` For responses, this returns true if the service returned a value for the Lenses property.
`boolean`	`hasNonAwsRegions()` For responses, this returns true if the service returned a value for the NonAwsRegions property.
`boolean`	`hasPillarPriorities()` For responses, this returns true if the service returned a value for the PillarPriorities property.
`boolean`	`hasProfileArns()` For responses, this returns true if the service returned a value for the ProfileArns property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`industry()` Returns the value of the Industry property for this object.
`String`	`industryType()` Returns the value of the IndustryType property for this object.
`List<String>`	`lenses()` Returns the value of the Lenses property for this object.
`List<String>`	`nonAwsRegions()` Returns the value of the NonAwsRegions property for this object.
`String`	`notes()` Returns the value of the Notes property for this object.
`List<String>`	`pillarPriorities()` Returns the value of the PillarPriorities property for this object.
`List<String>`	`profileArns()` The list of profile ARNs associated with the workload.
`String`	`reviewOwner()` Returns the value of the ReviewOwner property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateWorkloadRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags to be associated with the workload.
`CreateWorkloadRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`workloadName()` Returns the value of the WorkloadName property for 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
  - workloadName
```
public final String workloadName()
```
    Returns the value of the WorkloadName property for this object.
    
    Returns:
    
    The value of the WorkloadName property for this object.
  - description
```
public final String description()
```
    Returns the value of the Description property for this object.
    
    Returns:
    
    The value of the Description property for this object.
  - environment
```
public final WorkloadEnvironment environment()
```
    Returns the value of the Environment property for this object.
    If the service returns an enum value that is not available in the current SDK version, environment will return WorkloadEnvironment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from environmentAsString().
    
    Returns:
    
    The value of the Environment property for this object.
    
    See Also:
    
    WorkloadEnvironment
  - environmentAsString
```
public final String environmentAsString()
```
    Returns the value of the Environment property for this object.
    If the service returns an enum value that is not available in the current SDK version, environment will return WorkloadEnvironment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from environmentAsString().
    
    Returns:
    
    The value of the Environment property for this object.
    
    See Also:
    
    WorkloadEnvironment
  - hasAccountIds
```
public final boolean hasAccountIds()
```
    For responses, this returns true if the service returned a value for the AccountIds 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.
  - accountIds
```
public final List<String> accountIds()
```
    Returns the value of the AccountIds property for this object.
    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 hasAccountIds() method.
    
    Returns:
    
    The value of the AccountIds property for this object.
  - hasAwsRegions
```
public final boolean hasAwsRegions()
```
    For responses, this returns true if the service returned a value for the AwsRegions 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.
  - awsRegions
```
public final List<String> awsRegions()
```
    Returns the value of the AwsRegions property for this object.
    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 hasAwsRegions() method.
    
    Returns:
    
    The value of the AwsRegions property for this object.
  - hasNonAwsRegions
```
public final boolean hasNonAwsRegions()
```
    For responses, this returns true if the service returned a value for the NonAwsRegions 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.
  - nonAwsRegions
```
public final List<String> nonAwsRegions()
```
    Returns the value of the NonAwsRegions property for this object.
    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 hasNonAwsRegions() method.
    
    Returns:
    
    The value of the NonAwsRegions property for this object.
  - hasPillarPriorities
```
public final boolean hasPillarPriorities()
```
    For responses, this returns true if the service returned a value for the PillarPriorities 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.
  - pillarPriorities
```
public final List<String> pillarPriorities()
```
    Returns the value of the PillarPriorities property for this object.
    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 hasPillarPriorities() method.
    
    Returns:
    
    The value of the PillarPriorities property for this object.
  - architecturalDesign
```
public final String architecturalDesign()
```
    Returns the value of the ArchitecturalDesign property for this object.
    
    Returns:
    
    The value of the ArchitecturalDesign property for this object.
  - reviewOwner
```
public final String reviewOwner()
```
    Returns the value of the ReviewOwner property for this object.
    
    Returns:
    
    The value of the ReviewOwner property for this object.
  - industryType
```
public final String industryType()
```
    Returns the value of the IndustryType property for this object.
    
    Returns:
    
    The value of the IndustryType property for this object.
  - industry
```
public final String industry()
```
    Returns the value of the Industry property for this object.
    
    Returns:
    
    The value of the Industry property for this object.
  - hasLenses
```
public final boolean hasLenses()
```
    For responses, this returns true if the service returned a value for the Lenses 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.
  - lenses
```
public final List<String> lenses()
```
    Returns the value of the Lenses property for this object.
    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 hasLenses() method.
    
    Returns:
    
    The value of the Lenses property for this object.
  - notes
```
public final String notes()
```
    Returns the value of the Notes property for this object.
    
    Returns:
    
    The value of the Notes property for this object.
  - clientRequestToken
```
public final String clientRequestToken()
```
    Returns the value of the ClientRequestToken property for this object.
    
    Returns:
    
    The value of the ClientRequestToken property for this object.
  - 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 tags to be associated with the workload.
    
    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 tags to be associated with the workload.
  - discoveryConfig
```
public final WorkloadDiscoveryConfig discoveryConfig()
```
    Well-Architected discovery configuration settings associated to the workload.
    
    Returns:
    
    Well-Architected discovery configuration settings associated to the workload.
  - hasApplications
```
public final boolean hasApplications()
```
    For responses, this returns true if the service returned a value for the Applications 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.
  - applications
```
public final List<String> applications()
```
    List of AppRegistry application ARNs associated to the workload.
    
    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 hasApplications() method.
    
    Returns:
    
    List of AppRegistry application ARNs associated to the workload.
  - hasProfileArns
```
public final boolean hasProfileArns()
```
    For responses, this returns true if the service returned a value for the ProfileArns 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.
  - profileArns
```
public final List<String> profileArns()
```
    The list of profile ARNs associated with the workload.
    
    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 hasProfileArns() method.
    
    Returns:
    
    The list of profile ARNs associated with the workload.
  - toBuilder
```
public CreateWorkloadRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateWorkloadRequest.Builder,CreateWorkloadRequest>
    
    Specified by:
    
    toBuilder in class WellArchitectedRequest
  - builder
```
public static CreateWorkloadRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateWorkloadRequest.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 CreateWorkloadRequest

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

workloadName

description

environment

environmentAsString

hasAccountIds

accountIds

hasAwsRegions

awsRegions

hasNonAwsRegions

nonAwsRegions

hasPillarPriorities

pillarPriorities

architecturalDesign

reviewOwner

industryType

industry

hasLenses

lenses

notes

clientRequestToken

hasTags

tags

discoveryConfig

hasApplications

applications

hasProfileArns

profileArns

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields