Class GetWorkspaceInstanceResponse

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

Provides comprehensive details about the requested WorkSpaces Instance.

  • Method Details

    • hasWorkspaceInstanceErrors

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

    • workspaceInstanceErrors

      public final List<WorkspaceInstanceError> workspaceInstanceErrors()

      Captures any errors specific to the WorkSpace Instance lifecycle.

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

      Returns:
      Captures any errors specific to the WorkSpace Instance lifecycle.

    • hasEc2InstanceErrors

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

    • ec2InstanceErrors

      public final List<EC2InstanceError> ec2InstanceErrors()

      Includes any underlying EC2 instance errors encountered.

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

      Returns:
      Includes any underlying EC2 instance errors encountered.

    • provisionState

      public final ProvisionStateEnum provisionState()

      Current provisioning state of the WorkSpaces Instance.

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

      Returns:
      Current provisioning state of the WorkSpaces Instance.
      See Also:

    • provisionStateAsString

      public final String provisionStateAsString()

      Current provisioning state of the WorkSpaces Instance.

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

      Returns:
      Current provisioning state of the WorkSpaces Instance.
      See Also:

    • workspaceInstanceId

      public final String workspaceInstanceId()

      Unique identifier of the retrieved WorkSpaces Instance.

      Returns:
      Unique identifier of the retrieved WorkSpaces Instance.

    • ec2ManagedInstance

      public final EC2ManagedInstance ec2ManagedInstance()

      Details of the associated EC2 managed instance.

      Returns:
      Details of the associated EC2 managed instance.

    • toBuilder

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

    • builder

      public static GetWorkspaceInstanceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetWorkspaceInstanceResponse.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.

    • sdkFieldNameToField

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