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

Class DescribeWorkspacesRequest

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.DescribeWorkspacesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeWorkspacesRequest extends WorkSpacesRequest implements ToCopyableBuilder<DescribeWorkspacesRequest.Builder,DescribeWorkspacesRequest>

  • Method Details

    • hasWorkspaceIds

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

    • workspaceIds

      public final List<String> workspaceIds()

      The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

      Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

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

      Returns:
      The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

      Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    • directoryId

      public final String directoryId()

      The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

      Returns:
      The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

    • userName

      public final String userName()

      The name of the directory user. You must specify this parameter with DirectoryId.

      Returns:
      The name of the directory user. You must specify this parameter with DirectoryId.

    • bundleId

      public final String bundleId()

      The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

      Returns:
      The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

    • limit

      public final Integer limit()

      The maximum number of items to return.

      Returns:
      The maximum number of items to return.

    • nextToken

      public final String nextToken()

      If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

      Returns:
      If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    • workspaceName

      public final String workspaceName()

      The name of the user-decoupled WorkSpace.

      Returns:
      The name of the user-decoupled WorkSpace.

    • toBuilder

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

    • builder

      public static DescribeWorkspacesRequest.Builder builder()

    • serializableBuilderClass

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