Class ImportCustomWorkspaceImageRequest

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

  • Method Details

    • imageName

      public final String imageName()

      The name of the WorkSpace image.

      Returns:
      The name of the WorkSpace image.

    • imageDescription

      public final String imageDescription()

      The description of the WorkSpace image.

      Returns:
      The description of the WorkSpace image.

    • computeType

      public final ImageComputeType computeType()

      The supported compute type for the WorkSpace image.

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

      Returns:
      The supported compute type for the WorkSpace image.
      See Also:

    • computeTypeAsString

      public final String computeTypeAsString()

      The supported compute type for the WorkSpace image.

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

      Returns:
      The supported compute type for the WorkSpace image.
      See Also:

    • protocol

      public final CustomImageProtocol protocol()

      The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.

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

      Returns:
      The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.

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

      Returns:
      The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.
      See Also:

    • imageSource

      public final ImageSourceIdentifier imageSource()

      The options for image import source.

      Returns:
      The options for image import source.

    • infrastructureConfigurationArn

      public final String infrastructureConfigurationArn()

      The infrastructure configuration ARN that specifies how the WorkSpace image is built.

      Returns:
      The infrastructure configuration ARN that specifies how the WorkSpace image is built.

    • platform

      public final Platform platform()

      The platform for the WorkSpace image source.

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

      Returns:
      The platform for the WorkSpace image source.
      See Also:

    • platformAsString

      public final String platformAsString()

      The platform for the WorkSpace image source.

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

      Returns:
      The platform for the WorkSpace image source.
      See Also:

    • osVersion

      public final OSVersion osVersion()

      The OS version for the WorkSpace image source.

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

      Returns:
      The OS version for the WorkSpace image source.
      See Also:

    • osVersionAsString

      public final String osVersionAsString()

      The OS version for the WorkSpace image source.

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

      Returns:
      The OS version for the WorkSpace image source.
      See Also:

    • 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 List<Tag> tags()

      The resource tags. Each WorkSpaces resource can have a maximum of 50 tags.

      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 resource tags. Each WorkSpaces resource can have a maximum of 50 tags.

    • toBuilder

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

    • builder

      public static ImportCustomWorkspaceImageRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImportCustomWorkspaceImageRequest.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)
      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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.

    • sdkFieldNameToField

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