Class WorkloadData

java.lang.Object
software.amazon.awssdk.services.launchwizard.model.WorkloadData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkloadData.Builder,WorkloadData>
@Generated("software.amazon.awssdk:codegen") public final class WorkloadData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkloadData.Builder,WorkloadData>

Describes a workload.

See Also:

  • Method Details

    • workloadName

      public final String workloadName()

      The name of the workload.

      Returns:
      The name of the workload.

    • displayName

      public final String displayName()

      The display name of a workload.

      Returns:
      The display name of a workload.

    • status

      public final WorkloadStatus status()

      The status of a workload.

      You can list deployments in the DISABLED status.

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

      Returns:
      The status of a workload.

      You can list deployments in the DISABLED status.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a workload.

      You can list deployments in the DISABLED status.

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

      Returns:
      The status of a workload.

      You can list deployments in the DISABLED status.

      See Also:

    • hasAccountConstraints

      public final boolean hasAccountConstraints()
      For responses, this returns true if the service returned a value for the AccountConstraints 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.

    • accountConstraints

      public final List<AccountConstraint> accountConstraints()

      Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

      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 hasAccountConstraints() method.

      Returns:
      Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

    • description

      public final String description()

      The description of a workload.

      Returns:
      The description of a workload.

    • documentationUrl

      public final String documentationUrl()

      The URL of a workload document.

      Returns:
      The URL of a workload document.

    • iconUrl

      public final String iconUrl()

      The URL of a workload icon.

      Returns:
      The URL of a workload icon.

    • statusMessage

      public final String statusMessage()

      The message about a workload's status.

      Returns:
      The message about a workload's status.

    • toBuilder

      public WorkloadData.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WorkloadData.Builder,WorkloadData>
      Returns:
      a builder for type T

    • builder

      public static WorkloadData.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WorkloadData.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.