WorkspaceSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.grafana.model.WorkspaceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkspaceSummary.Builder,WorkspaceSummary>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class WorkspaceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceSummary.Builder,WorkspaceSummary>
```
A structure that contains some information about one workspace in the account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WorkspaceSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WorkspaceSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationSummary`	`authentication()` A structure containing information about the authentication methods used in the workspace.
`static WorkspaceSummary.Builder`	`builder()`
`Instant`	`created()` The date that the workspace was created.
`String`	`description()` The customer-entered description of the workspace.
`String`	`endpoint()` The URL endpoint to use to access the Grafana console in the workspace.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`grafanaVersion()` The Grafana version that the workspace is running.
`int`	`hashCode()`
`boolean`	`hasNotificationDestinations()` For responses, this returns true if the service returned a value for the NotificationDestinations property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`id()` The unique ID of the workspace.
`Instant`	`modified()` The most recent date that the workspace was modified.
`String`	`name()` The name of the workspace.
`List<NotificationDestinationType>`	`notificationDestinations()` The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
`List<String>`	`notificationDestinationsAsStrings()` The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkspaceSummary.Builder>`	`serializableBuilderClass()`
`WorkspaceStatus`	`status()` The current status of the workspace.
`String`	`statusAsString()` The current status of the workspace.
`Map<String,String>`	`tags()` The list of tags associated with the workspace.
`WorkspaceSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - authentication
```
public final AuthenticationSummary authentication()
```
    A structure containing information about the authentication methods used in the workspace.
    
    Returns:
    
    A structure containing information about the authentication methods used in the workspace.
  - created
```
public final Instant created()
```
    The date that the workspace was created.
    
    Returns:
    
    The date that the workspace was created.
  - description
```
public final String description()
```
    The customer-entered description of the workspace.
    
    Returns:
    
    The customer-entered description of the workspace.
  - endpoint
```
public final String endpoint()
```
    The URL endpoint to use to access the Grafana console in the workspace.
    
    Returns:
    
    The URL endpoint to use to access the Grafana console in the workspace.
  - grafanaVersion
```
public final String grafanaVersion()
```
    The Grafana version that the workspace is running.
    
    Returns:
    
    The Grafana version that the workspace is running.
  - id
```
public final String id()
```
    The unique ID of the workspace.
    
    Returns:
    
    The unique ID of the workspace.
  - modified
```
public final Instant modified()
```
    The most recent date that the workspace was modified.
    
    Returns:
    
    The most recent date that the workspace was modified.
  - name
```
public final String name()
```
    The name of the workspace.
    
    Returns:
    
    The name of the workspace.
  - notificationDestinations
```
public final List<NotificationDestinationType> notificationDestinations()
```
    The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
    
    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 hasNotificationDestinations() method.
    
    Returns:
    
    The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
  - hasNotificationDestinations
```
public final boolean hasNotificationDestinations()
```
    For responses, this returns true if the service returned a value for the NotificationDestinations 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.
  - notificationDestinationsAsStrings
```
public final List<String> notificationDestinationsAsStrings()
```
    The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
    
    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 hasNotificationDestinations() method.
    
    Returns:
    
    The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
  - status
```
public final WorkspaceStatus status()
```
    The current status of the workspace.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WorkspaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the workspace.
    
    See Also:
    
    WorkspaceStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the workspace.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WorkspaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the workspace.
    
    See Also:
    
    WorkspaceStatus
  - 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 tags 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 tags associated with the workspace.
  - toBuilder
```
public WorkspaceSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkspaceSummary.Builder,WorkspaceSummary>
  - builder
```
public static WorkspaceSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkspaceSummary.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

Class WorkspaceSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

authentication

created

description

endpoint

grafanaVersion

id

modified

name

notificationDestinations

hasNotificationDestinations

notificationDestinationsAsStrings

status

statusAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields