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

java.lang.Object
- software.amazon.awssdk.services.wellarchitected.model.Workload

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Workload.Builder,Workload>

@Generated(value="software.amazon.awssdk:codegen")
public final class Workload
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Workload.Builder,Workload>

A workload return object.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Workload.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Workload.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 Workload.Builder`	`builder()`
`String`	`description()` Returns the value of the Description property for this object.
`WorkloadDiscoveryConfig`	`discoveryConfig()` Discovery configuration 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`	`hasPrioritizedRiskCounts()` For responses, this returns true if the service returned a value for the PrioritizedRiskCounts property.
`boolean`	`hasProfiles()` For responses, this returns true if the service returned a value for the Profiles property.
`boolean`	`hasRiskCounts()` For responses, this returns true if the service returned a value for the RiskCounts property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`WorkloadImprovementStatus`	`improvementStatus()` Returns the value of the ImprovementStatus property for this object.
`String`	`improvementStatusAsString()` Returns the value of the ImprovementStatus property for this object.
`String`	`industry()` Returns the value of the Industry property for this object.
`String`	`industryType()` Returns the value of the IndustryType property for this object.
`Boolean`	`isReviewOwnerUpdateAcknowledged()` Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
`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.
`String`	`owner()` Returns the value of the Owner property for this object.
`List<String>`	`pillarPriorities()` Returns the value of the PillarPriorities property for this object.
`Map<Risk,Integer>`	`prioritizedRiskCounts()` Returns the value of the PrioritizedRiskCounts property for this object.
`Map<String,Integer>`	`prioritizedRiskCountsAsStrings()` Returns the value of the PrioritizedRiskCounts property for this object.
`List<WorkloadProfile>`	`profiles()` Profile associated with a workload.
`String`	`reviewOwner()` Returns the value of the ReviewOwner property for this object.
`Instant`	`reviewRestrictionDate()` Returns the value of the ReviewRestrictionDate property for this object.
`Map<Risk,Integer>`	`riskCounts()` Returns the value of the RiskCounts property for this object.
`Map<String,Integer>`	`riskCountsAsStrings()` Returns the value of the RiskCounts property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Workload.Builder>`	`serializableBuilderClass()`
`String`	`shareInvitationId()` The ID assigned to the share invitation.
`Map<String,String>`	`tags()` The tags associated with the workload.
`Workload.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`updatedAt()` Returns the value of the UpdatedAt property for this object.
`String`	`workloadArn()` Returns the value of the WorkloadArn property for this object.
`String`	`workloadId()` Returns the value of the WorkloadId property for this object.
`String`	`workloadName()` Returns the value of the WorkloadName property for this object.

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
  - workloadId
```
public final String workloadId()
```
    Returns the value of the WorkloadId property for this object.
    
    Returns:
    
    The value of the WorkloadId property for this object.
  - workloadArn
```
public final String workloadArn()
```
    Returns the value of the WorkloadArn property for this object.
    
    Returns:
    
    The value of the WorkloadArn property for this object.
  - 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
  - updatedAt
```
public final Instant updatedAt()
```
    Returns the value of the UpdatedAt property for this object.
    
    Returns:
    
    The value of the UpdatedAt property for this object.
  - 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.
  - 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.
  - reviewRestrictionDate
```
public final Instant reviewRestrictionDate()
```
    Returns the value of the ReviewRestrictionDate property for this object.
    
    Returns:
    
    The value of the ReviewRestrictionDate property for this object.
  - isReviewOwnerUpdateAcknowledged
```
public final Boolean isReviewOwnerUpdateAcknowledged()
```
    Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
    
    If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
    
    Returns:
    
    Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
    
    If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
  - 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.
  - 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.
  - improvementStatus
```
public final WorkloadImprovementStatus improvementStatus()
```
    Returns the value of the ImprovementStatus property for this object.
    If the service returns an enum value that is not available in the current SDK version, improvementStatus will return WorkloadImprovementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from improvementStatusAsString().
    
    Returns:
    
    The value of the ImprovementStatus property for this object.
    
    See Also:
    
    WorkloadImprovementStatus
  - improvementStatusAsString
```
public final String improvementStatusAsString()
```
    Returns the value of the ImprovementStatus property for this object.
    If the service returns an enum value that is not available in the current SDK version, improvementStatus will return WorkloadImprovementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from improvementStatusAsString().
    
    Returns:
    
    The value of the ImprovementStatus property for this object.
    
    See Also:
    
    WorkloadImprovementStatus
  - riskCounts
```
public final Map<Risk,Integer> riskCounts()
```
    Returns the value of the RiskCounts 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 hasRiskCounts() method.
    
    Returns:
    
    The value of the RiskCounts property for this object.
  - hasRiskCounts
```
public final boolean hasRiskCounts()
```
    For responses, this returns true if the service returned a value for the RiskCounts 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.
  - riskCountsAsStrings
```
public final Map<String,Integer> riskCountsAsStrings()
```
    Returns the value of the RiskCounts 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 hasRiskCounts() method.
    
    Returns:
    
    The value of the RiskCounts 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.
  - 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.
  - owner
```
public final String owner()
```
    Returns the value of the Owner property for this object.
    
    Returns:
    
    The value of the Owner property for this object.
  - shareInvitationId
```
public final String shareInvitationId()
```
    The ID assigned to the share invitation.
    
    Returns:
    
    The ID assigned to the share invitation.
  - 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 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 associated with the workload.
  - discoveryConfig
```
public final WorkloadDiscoveryConfig discoveryConfig()
```
    Discovery configuration associated to the workload.
    
    Returns:
    
    Discovery configuration 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.
  - hasProfiles
```
public final boolean hasProfiles()
```
    For responses, this returns true if the service returned a value for the Profiles 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.
  - profiles
```
public final List<WorkloadProfile> profiles()
```
    Profile associated with a 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 hasProfiles() method.
    
    Returns:
    
    Profile associated with a workload.
  - prioritizedRiskCounts
```
public final Map<Risk,Integer> prioritizedRiskCounts()
```
    Returns the value of the PrioritizedRiskCounts 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 hasPrioritizedRiskCounts() method.
    
    Returns:
    
    The value of the PrioritizedRiskCounts property for this object.
  - hasPrioritizedRiskCounts
```
public final boolean hasPrioritizedRiskCounts()
```
    For responses, this returns true if the service returned a value for the PrioritizedRiskCounts 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.
  - prioritizedRiskCountsAsStrings
```
public final Map<String,Integer> prioritizedRiskCountsAsStrings()
```
    Returns the value of the PrioritizedRiskCounts 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 hasPrioritizedRiskCounts() method.
    
    Returns:
    
    The value of the PrioritizedRiskCounts property for this object.
  - toBuilder
```
public Workload.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Workload.Builder,Workload>
  - builder
```
public static Workload.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Workload.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Workload

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

workloadId

workloadArn

workloadName

description

environment

environmentAsString

updatedAt

hasAccountIds

accountIds

hasAwsRegions

awsRegions

hasNonAwsRegions

nonAwsRegions

architecturalDesign

reviewOwner

reviewRestrictionDate

isReviewOwnerUpdateAcknowledged

industryType

industry

notes

improvementStatus

improvementStatusAsString

riskCounts

hasRiskCounts

riskCountsAsStrings

hasPillarPriorities

pillarPriorities

hasLenses

lenses

owner

shareInvitationId

hasTags

tags

discoveryConfig

hasApplications

applications

hasProfiles

profiles

prioritizedRiskCounts

hasPrioritizedRiskCounts

prioritizedRiskCountsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields