Package software.amazon.awssdk.services.workspaces.model

Class CreateWorkspaceImageResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.workspaces.model.WorkSpacesResponse
software.amazon.awssdk.services.workspaces.model.CreateWorkspaceImageResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWorkspaceImageResponse.Builder,CreateWorkspaceImageResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateWorkspaceImageResponse extends WorkSpacesResponse implements ToCopyableBuilder<CreateWorkspaceImageResponse.Builder,CreateWorkspaceImageResponse>

  • Method Details

    • imageId

      public final String imageId()

      The identifier of the new WorkSpace image.

      Returns:
      The identifier of the new WorkSpace image.

    • name

      public final String name()

      The name of the image.

      Returns:
      The name of the image.

    • description

      public final String description()

      The description of the image.

      Returns:
      The description of the image.

    • operatingSystem

      public final OperatingSystem operatingSystem()

      The operating system that the image is running.

      Returns:
      The operating system that the image is running.

    • state

      public final WorkspaceImageState state()

      The availability status of the image.

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

      Returns:
      The availability status of the image.
      See Also:

    • stateAsString

      public final String stateAsString()

      The availability status of the image.

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

      Returns:
      The availability status of the image.
      See Also:

    • requiredTenancy

      public final WorkspaceImageRequiredTenancy requiredTenancy()

      Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..

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

      Returns:
      Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
      See Also:

    • requiredTenancyAsString

      public final String requiredTenancyAsString()

      Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..

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

      Returns:
      Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
      See Also:

    • created

      public final Instant created()

      The date when the image was created.

      Returns:
      The date when the image was created.

    • ownerAccountId

      public final String ownerAccountId()

      The identifier of the Amazon Web Services account that owns the image.

      Returns:
      The identifier of the Amazon Web Services account that owns the image.

    • toBuilder

      public CreateWorkspaceImageResponse.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<CreateWorkspaceImageResponse.Builder,CreateWorkspaceImageResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateWorkspaceImageResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWorkspaceImageResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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