WorkspaceSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.managedgrafana.model.WorkspaceSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkspaceSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A structure that contains some information about one workspace in the account.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkspaceSummary()

Constructors
Constructor and Description
`WorkspaceSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkspaceSummary`	`addTagsEntry(String key, String value)` Add a single Tags entry
`WorkspaceSummary`	`clearTagsEntries()` Removes all the entries added into Tags.
`WorkspaceSummary`	`clone()`
`boolean`	`equals(Object obj)`
`AuthenticationSummary`	`getAuthentication()` A structure containing information about the authentication methods used in the workspace.
`Date`	`getCreated()` The date that the workspace was created.
`String`	`getDescription()` The customer-entered description of the workspace.
`String`	`getEndpoint()` The URL endpoint to use to access the Grafana console in the workspace.
`String`	`getGrafanaVersion()` The Grafana version that the workspace is running.
`String`	`getId()` The unique ID of the workspace.
`Date`	`getModified()` The most recent date that the workspace was modified.
`String`	`getName()` The name of the workspace.
`List<String>`	`getNotificationDestinations()` 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.
`String`	`getStatus()` The current status of the workspace.
`Map<String,String>`	`getTags()` The list of tags associated with the workspace.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthentication(AuthenticationSummary authentication)` A structure containing information about the authentication methods used in the workspace.
`void`	`setCreated(Date created)` The date that the workspace was created.
`void`	`setDescription(String description)` The customer-entered description of the workspace.
`void`	`setEndpoint(String endpoint)` The URL endpoint to use to access the Grafana console in the workspace.
`void`	`setGrafanaVersion(String grafanaVersion)` The Grafana version that the workspace is running.
`void`	`setId(String id)` The unique ID of the workspace.
`void`	`setModified(Date modified)` The most recent date that the workspace was modified.
`void`	`setName(String name)` The name of the workspace.
`void`	`setNotificationDestinations(Collection<String> 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.
`void`	`setStatus(String status)` The current status of the workspace.
`void`	`setTags(Map<String,String> tags)` The list of tags associated with the workspace.
`String`	`toString()` Returns a string representation of this object.
`WorkspaceSummary`	`withAuthentication(AuthenticationSummary authentication)` A structure containing information about the authentication methods used in the workspace.
`WorkspaceSummary`	`withCreated(Date created)` The date that the workspace was created.
`WorkspaceSummary`	`withDescription(String description)` The customer-entered description of the workspace.
`WorkspaceSummary`	`withEndpoint(String endpoint)` The URL endpoint to use to access the Grafana console in the workspace.
`WorkspaceSummary`	`withGrafanaVersion(String grafanaVersion)` The Grafana version that the workspace is running.
`WorkspaceSummary`	`withId(String id)` The unique ID of the workspace.
`WorkspaceSummary`	`withModified(Date modified)` The most recent date that the workspace was modified.
`WorkspaceSummary`	`withName(String name)` The name of the workspace.
`WorkspaceSummary`	`withNotificationDestinations(Collection<String> 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.
`WorkspaceSummary`	`withNotificationDestinations(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.
`WorkspaceSummary`	`withNotificationDestinations(String... 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.
`WorkspaceSummary`	`withStatus(String status)` The current status of the workspace.
`WorkspaceSummary`	`withStatus(WorkspaceStatus status)` The current status of the workspace.
`WorkspaceSummary`	`withTags(Map<String,String> tags)` The list of tags associated with the workspace.

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

- Constructor Detail
  - WorkspaceSummary
```
public WorkspaceSummary()
```
- Method Detail
  - setAuthentication
```
public void setAuthentication(AuthenticationSummary authentication)
```
    A structure containing information about the authentication methods used in the workspace.
    
    Parameters:
    
    authentication - A structure containing information about the authentication methods used in the workspace.
  - getAuthentication
```
public AuthenticationSummary getAuthentication()
```
    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.
  - withAuthentication
```
public WorkspaceSummary withAuthentication(AuthenticationSummary authentication)
```
    A structure containing information about the authentication methods used in the workspace.
    
    Parameters:
    
    authentication - A structure containing information about the authentication methods used in the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreated
```
public void setCreated(Date created)
```
    The date that the workspace was created.
    
    Parameters:
    
    created - The date that the workspace was created.
  - getCreated
```
public Date getCreated()
```
    The date that the workspace was created.
    
    Returns:
    
    The date that the workspace was created.
  - withCreated
```
public WorkspaceSummary withCreated(Date created)
```
    The date that the workspace was created.
    
    Parameters:
    
    created - The date that the workspace was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The customer-entered description of the workspace.
    
    Parameters:
    
    description - The customer-entered description of the workspace.
  - getDescription
```
public String getDescription()
```
    The customer-entered description of the workspace.
    
    Returns:
    
    The customer-entered description of the workspace.
  - withDescription
```
public WorkspaceSummary withDescription(String description)
```
    The customer-entered description of the workspace.
    
    Parameters:
    
    description - The customer-entered description of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    The URL endpoint to use to access the Grafana console in the workspace.
    
    Parameters:
    
    endpoint - The URL endpoint to use to access the Grafana console in the workspace.
  - getEndpoint
```
public String getEndpoint()
```
    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.
  - withEndpoint
```
public WorkspaceSummary withEndpoint(String endpoint)
```
    The URL endpoint to use to access the Grafana console in the workspace.
    
    Parameters:
    
    endpoint - The URL endpoint to use to access the Grafana console in the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGrafanaVersion
```
public void setGrafanaVersion(String grafanaVersion)
```
    The Grafana version that the workspace is running.
    
    Parameters:
    
    grafanaVersion - The Grafana version that the workspace is running.
  - getGrafanaVersion
```
public String getGrafanaVersion()
```
    The Grafana version that the workspace is running.
    
    Returns:
    
    The Grafana version that the workspace is running.
  - withGrafanaVersion
```
public WorkspaceSummary withGrafanaVersion(String grafanaVersion)
```
    The Grafana version that the workspace is running.
    
    Parameters:
    
    grafanaVersion - The Grafana version that the workspace is running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique ID of the workspace.
    
    Parameters:
    
    id - The unique ID of the workspace.
  - getId
```
public String getId()
```
    The unique ID of the workspace.
    
    Returns:
    
    The unique ID of the workspace.
  - withId
```
public WorkspaceSummary withId(String id)
```
    The unique ID of the workspace.
    
    Parameters:
    
    id - The unique ID of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModified
```
public void setModified(Date modified)
```
    The most recent date that the workspace was modified.
    
    Parameters:
    
    modified - The most recent date that the workspace was modified.
  - getModified
```
public Date getModified()
```
    The most recent date that the workspace was modified.
    
    Returns:
    
    The most recent date that the workspace was modified.
  - withModified
```
public WorkspaceSummary withModified(Date modified)
```
    The most recent date that the workspace was modified.
    
    Parameters:
    
    modified - The most recent date that the workspace was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the workspace.
    
    Parameters:
    
    name - The name of the workspace.
  - getName
```
public String getName()
```
    The name of the workspace.
    
    Returns:
    
    The name of the workspace.
  - withName
```
public WorkspaceSummary withName(String name)
```
    The name of the workspace.
    
    Parameters:
    
    name - The name of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotificationDestinations
```
public List<String> getNotificationDestinations()
```
    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.
    
    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.
    
    See Also:
    
    NotificationDestinationType
  - setNotificationDestinations
```
public void setNotificationDestinations(Collection<String> 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    NotificationDestinationType
  - withNotificationDestinations
```
public WorkspaceSummary withNotificationDestinations(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotificationDestinations(java.util.Collection) or withNotificationDestinations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationDestinationType
  - withNotificationDestinations
```
public WorkspaceSummary withNotificationDestinations(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationDestinationType
  - withNotificationDestinations
```
public WorkspaceSummary withNotificationDestinations(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationDestinationType
  - setStatus
```
public void setStatus(String status)
```
    The current status of the workspace.
    
    Parameters:
    
    status - The current status of the workspace.
    
    See Also:
    
    WorkspaceStatus
  - getStatus
```
public String getStatus()
```
    The current status of the workspace.
    
    Returns:
    
    The current status of the workspace.
    
    See Also:
    
    WorkspaceStatus
  - withStatus
```
public WorkspaceSummary withStatus(String status)
```
    The current status of the workspace.
    
    Parameters:
    
    status - The current status of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceStatus
  - withStatus
```
public WorkspaceSummary withStatus(WorkspaceStatus status)
```
    The current status of the workspace.
    
    Parameters:
    
    status - The current status of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceStatus
  - getTags
```
public Map<String,String> getTags()
```
    The list of tags associated with the workspace.
    
    Returns:
    
    The list of tags associated with the workspace.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The list of tags associated with the workspace.
    
    Parameters:
    
    tags - The list of tags associated with the workspace.
  - withTags
```
public WorkspaceSummary withTags(Map<String,String> tags)
```
    The list of tags associated with the workspace.
    
    Parameters:
    
    tags - The list of tags associated with the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public WorkspaceSummary addTagsEntry(String key,
                                     String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public WorkspaceSummary clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkspaceSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WorkspaceSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceSummary

Method Detail

setAuthentication

getAuthentication

withAuthentication

setCreated

getCreated

withCreated

setDescription

getDescription

withDescription

setEndpoint

getEndpoint

withEndpoint

setGrafanaVersion

getGrafanaVersion

withGrafanaVersion

setId

getId

withId

setModified

getModified

withModified

setName

getName

withName

getNotificationDestinations

setNotificationDestinations

withNotificationDestinations

withNotificationDestinations

withNotificationDestinations

setStatus

getStatus

withStatus

withStatus

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall