Class Workspace

java.lang.Object
software.amazon.awssdk.services.connect.model.Workspace
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Workspace.Builder,Workspace>
@Generated("software.amazon.awssdk:codegen") public final class Workspace extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Workspace.Builder,Workspace>

Contains information about a workspace, which defines the user experience by mapping views to pages.

See Also:

  • Method Details

    • visibility

      public final Visibility visibility()

      Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).

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

      Returns:
      Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).

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

      Returns:
      Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).
      See Also:

    • id

      public final String id()

      The unique identifier of the workspace.

      Returns:
      The unique identifier of the workspace.

    • name

      public final String name()

      The name of the workspace.

      Returns:
      The name of the workspace.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the workspace.

      Returns:
      The Amazon Resource Name (ARN) of the workspace.

    • description

      public final String description()

      The description of the workspace.

      Returns:
      The description of the workspace.

    • theme

      public final WorkspaceTheme theme()

      The theme configuration for the workspace, including colors and styling.

      Returns:
      The theme configuration for the workspace, including colors and styling.

    • title

      public final String title()

      The title displayed for the workspace.

      Returns:
      The title displayed for the workspace.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when the workspace was last modified.

      Returns:
      The timestamp when the workspace was last modified.

    • lastModifiedRegion

      public final String lastModifiedRegion()

      The AWS Region where the workspace was last modified.

      Returns:
      The AWS Region where the workspace was last modified.

    • 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 Map<String,String> tags()

      The tags used to organize, track, or control access for the workspace.

      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 tags used to organize, track, or control access for the workspace.

    • toBuilder

      public Workspace.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<Workspace.Builder,Workspace>
      Returns:
      a builder for type T

    • builder

      public static Workspace.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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