java.lang.Object
- software.amazon.awssdk.services.amp.model.WorkspaceDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
```
@Generated("software.amazon.awssdk:codegen")
public final class WorkspaceDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
```
The full details about one Amazon Managed Service for Prometheus workspace in your account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WorkspaceDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`alias()`	The alias that is assigned to this workspace to help identify it.
`String`	`arn()`	The ARN of the workspace.
`static WorkspaceDescription.Builder`	`builder()`
`Instant`	`createdAt()`	The date and time that the workspace was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyArn()`	(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
`String`	`prometheusEndpoint()`	The Prometheus endpoint available for this workspace.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkspaceDescription.Builder>`	`serializableBuilderClass()`
`WorkspaceStatus`	`status()`	The current status of the workspace.
`Map<String,String>`	`tags()`	The list of tag keys and values that are associated with the workspace.
`WorkspaceDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`workspaceId()`	The unique ID for the workspace.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - alias
```
public final String alias()
```
    The alias that is assigned to this workspace to help identify it. It does not need to be unique.
    
    Returns:
    
    The alias that is assigned to this workspace to help identify it. It does not need to be unique.
  - arn
```
public final String arn()
```
    The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.
    
    Returns:
    
    The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.
  - createdAt
```
public final Instant createdAt()
```
    The date and time that the workspace was created.
    
    Returns:
    
    The date and time that the workspace was created.
  - kmsKeyArn
```
public final String kmsKeyArn()
```
    (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
    
    Returns:
    
    (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
  - prometheusEndpoint
```
public final String prometheusEndpoint()
```
    The Prometheus endpoint available for this workspace. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/ .
    
    Returns:
    
    The Prometheus endpoint available for this workspace. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/ .
  - status
```
public final WorkspaceStatus status()
```
    The current status of the workspace.
    
    Returns:
    
    The current status of the workspace.
  - 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 list of tag keys and values that are associated with 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 list of tag keys and values that are associated with the workspace.
  - workspaceId
```
public final String workspaceId()
```
    The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
    
    Returns:
    
    The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
  - toBuilder
```
public WorkspaceDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
  - builder
```
public static WorkspaceDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkspaceDescription.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class WorkspaceDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

alias

arn

createdAt

kmsKeyArn

prometheusEndpoint

status

hasTags

tags

workspaceId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField