Interface WorkspaceImage.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkspaceImage.Builder,WorkspaceImage>, SdkBuilder<WorkspaceImage.Builder,WorkspaceImage>, SdkPojo
Enclosing class:
WorkspaceImage
public static interface WorkspaceImage.Builder extends SdkPojo, CopyableBuilder<WorkspaceImage.Builder,WorkspaceImage>

  • Method Details

    • imageId

      WorkspaceImage.Builder imageId(String imageId)

      The identifier of the image.

      Parameters:
      imageId - The identifier of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      WorkspaceImage.Builder name(String name)

      The name of the image.

      Parameters:
      name - The name of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      WorkspaceImage.Builder description(String description)

      The description of the image.

      Parameters:
      description - The description of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operatingSystem

      WorkspaceImage.Builder operatingSystem(OperatingSystem operatingSystem)

      The operating system that the image is running.

      Parameters:
      operatingSystem - The operating system that the image is running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operatingSystem

      default WorkspaceImage.Builder operatingSystem(Consumer<OperatingSystem.Builder> operatingSystem)

      The operating system that the image is running.

      This is a convenience method that creates an instance of the OperatingSystem.Builder avoiding the need to create one manually via OperatingSystem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to operatingSystem(OperatingSystem).

      Parameters:
      operatingSystem - a consumer that will call methods on OperatingSystem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      WorkspaceImage.Builder state(String state)

      The status of the image.

      Parameters:
      state - The status of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      WorkspaceImage.Builder state(WorkspaceImageState state)

      The status of the image.

      Parameters:
      state - The status of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requiredTenancy

      WorkspaceImage.Builder requiredTenancy(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requiredTenancy

      WorkspaceImage.Builder requiredTenancy(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorCode

      WorkspaceImage.Builder errorCode(String errorCode)

      The error code that is returned for the image.

      Parameters:
      errorCode - The error code that is returned for the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorMessage

      WorkspaceImage.Builder errorMessage(String errorMessage)

      The text of the error message that is returned for the image.

      Parameters:
      errorMessage - The text of the error message that is returned for the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • created

      WorkspaceImage.Builder created(Instant created)

      The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

      Parameters:
      created - The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ownerAccountId

      WorkspaceImage.Builder ownerAccountId(String ownerAccountId)

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

      Parameters:
      ownerAccountId - The identifier of the Amazon Web Services account that owns the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updates

      WorkspaceImage.Builder updates(UpdateResult updates)

      The updates (if any) that are available for the specified image.

      Parameters:
      updates - The updates (if any) that are available for the specified image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updates

      default WorkspaceImage.Builder updates(Consumer<UpdateResult.Builder> updates)

      The updates (if any) that are available for the specified image.

      This is a convenience method that creates an instance of the UpdateResult.Builder avoiding the need to create one manually via UpdateResult.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to updates(UpdateResult).

      Parameters:
      updates - a consumer that will call methods on UpdateResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorDetails

      WorkspaceImage.Builder errorDetails(Collection<ErrorDetails> errorDetails)

      Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.

      Parameters:
      errorDetails - Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorDetails

      WorkspaceImage.Builder errorDetails(ErrorDetails... errorDetails)

      Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.

      Parameters:
      errorDetails - Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorDetails

      WorkspaceImage.Builder errorDetails(Consumer<ErrorDetails.Builder>... errorDetails)

      Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.

      This is a convenience method that creates an instance of the ErrorDetails.Builder avoiding the need to create one manually via ErrorDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errorDetails(List<ErrorDetails>).

      Parameters:
      errorDetails - a consumer that will call methods on ErrorDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: