WorkspaceDescription (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class WorkspaceDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
```
A structure containing information about an Amazon Managed Grafana workspace in your account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WorkspaceDescription.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccountAccessType`	`accountAccessType()` Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization.
`String`	`accountAccessTypeAsString()` Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization.
`AuthenticationSummary`	`authentication()` A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
`static WorkspaceDescription.Builder`	`builder()`
`Instant`	`created()` The date that the workspace was created.
`List<DataSourceType>`	`dataSources()` Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
`List<String>`	`dataSourcesAsStrings()` Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
`String`	`description()` The user-defined description of the workspace.
`String`	`endpoint()` The URL that users can use to access the Grafana console in the workspace.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`freeTrialConsumed()` Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
`Instant`	`freeTrialExpiration()` If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`grafanaVersion()` The version of Grafana supported in this workspace.
`boolean`	`hasDataSources()` For responses, this returns true if the service returned a value for the DataSources property.
`int`	`hashCode()`
`boolean`	`hasNotificationDestinations()` For responses, this returns true if the service returned a value for the NotificationDestinations property.
`boolean`	`hasOrganizationalUnits()` For responses, this returns true if the service returned a value for the OrganizationalUnits property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`id()` The unique ID of this workspace.
`Instant`	`licenseExpiration()` If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
`LicenseType`	`licenseType()` Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
`String`	`licenseTypeAsString()` Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
`Instant`	`modified()` The most recent date that the workspace was modified.
`String`	`name()` The name of the workspace.
`NetworkAccessConfiguration`	`networkAccessControl()` The configuration settings for network access to your workspace.
`List<NotificationDestinationType>`	`notificationDestinations()` The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow 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, to allow Amazon Managed Grafana to use these channels.
`List<String>`	`organizationalUnits()` Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
`String`	`organizationRoleName()` The name of the IAM role that is used to access resources through Organizations.
`PermissionType`	`permissionType()` If this is `SERVICE_MANAGED`, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
`String`	`permissionTypeAsString()` If this is `SERVICE_MANAGED`, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkspaceDescription.Builder>`	`serializableBuilderClass()`
`String`	`stackSetName()` The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
`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.
`WorkspaceDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VpcConfiguration`	`vpcConfiguration()` The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
`String`	`workspaceRoleArn()` The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from.

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
  - accountAccessType
```
public final AccountAccessType accountAccessType()
```
    Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    If the service returns an enum value that is not available in the current SDK version, accountAccessType will return AccountAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountAccessTypeAsString().
    
    Returns:
    
    Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    See Also:
    
    AccountAccessType
  - accountAccessTypeAsString
```
public final String accountAccessTypeAsString()
```
    Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    If the service returns an enum value that is not available in the current SDK version, accountAccessType will return AccountAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountAccessTypeAsString().
    
    Returns:
    
    Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    See Also:
    
    AccountAccessType
  - authentication
```
public final AuthenticationSummary authentication()
```
    A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
    
    Returns:
    
    A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
  - created
```
public final Instant created()
```
    The date that the workspace was created.
    
    Returns:
    
    The date that the workspace was created.
  - dataSources
```
public final List<DataSourceType> dataSources()
```
    Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
    
    This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.
    
    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 hasDataSources() method.
    
    Returns:
    
    Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
    
    This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.
  - hasDataSources
```
public final boolean hasDataSources()
```
    For responses, this returns true if the service returned a value for the DataSources 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.
  - dataSourcesAsStrings
```
public final List<String> dataSourcesAsStrings()
```
    Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
    
    This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.
    
    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 hasDataSources() method.
    
    Returns:
    
    Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
    
    This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.
  - description
```
public final String description()
```
    The user-defined description of the workspace.
    
    Returns:
    
    The user-defined description of the workspace.
  - endpoint
```
public final String endpoint()
```
    The URL that users can use to access the Grafana console in the workspace.
    
    Returns:
    
    The URL that users can use to access the Grafana console in the workspace.
  - freeTrialConsumed
```
public final Boolean freeTrialConsumed()
```
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    
    Returns:
    
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
  - freeTrialExpiration
```
public final Instant freeTrialExpiration()
```
    If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
    
    Returns:
    
    If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
  - grafanaVersion
```
public final String grafanaVersion()
```
    The version of Grafana supported in this workspace.
    
    Returns:
    
    The version of Grafana supported in this workspace.
  - id
```
public final String id()
```
    The unique ID of this workspace.
    
    Returns:
    
    The unique ID of this workspace.
  - licenseExpiration
```
public final Instant licenseExpiration()
```
    If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
    
    Returns:
    
    If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
  - licenseType
```
public final LicenseType licenseType()
```
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    If the service returns an enum value that is not available in the current SDK version, licenseType will return LicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from licenseTypeAsString().
    
    Returns:
    
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    See Also:
    
    LicenseType
  - licenseTypeAsString
```
public final String licenseTypeAsString()
```
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    If the service returns an enum value that is not available in the current SDK version, licenseType will return LicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from licenseTypeAsString().
    
    Returns:
    
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    See Also:
    
    LicenseType
  - 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.
  - networkAccessControl
```
public final NetworkAccessConfiguration networkAccessControl()
```
    The configuration settings for network access to your workspace.
    
    Returns:
    
    The configuration settings for network access to your 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, to allow 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, to allow 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, to allow 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, to allow Amazon Managed Grafana to use these channels.
  - organizationRoleName
```
public final String organizationRoleName()
```
    The name of the IAM role that is used to access resources through Organizations.
    
    Returns:
    
    The name of the IAM role that is used to access resources through Organizations.
  - hasOrganizationalUnits
```
public final boolean hasOrganizationalUnits()
```
    For responses, this returns true if the service returned a value for the OrganizationalUnits 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.
  - organizationalUnits
```
public final List<String> organizationalUnits()
```
    Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
    
    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 hasOrganizationalUnits() method.
    
    Returns:
    
    Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
  - permissionType
```
public final PermissionType permissionType()
```
    If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
    
    If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
    
    For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
    
    If the service returns an enum value that is not available in the current SDK version, permissionType will return PermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().
    
    Returns:
    
    If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
    
    If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
    
    For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
    
    See Also:
    
    PermissionType
  - permissionTypeAsString
```
public final String permissionTypeAsString()
```
    If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
    
    If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
    
    For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
    
    If the service returns an enum value that is not available in the current SDK version, permissionType will return PermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().
    
    Returns:
    
    If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
    
    If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
    
    For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
    
    See Also:
    
    PermissionType
  - stackSetName
```
public final String stackSetName()
```
    The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
    
    Returns:
    
    The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
  - 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.
  - vpcConfiguration
```
public final VpcConfiguration vpcConfiguration()
```
    The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
    
    Returns:
    
    The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
  - workspaceRoleArn
```
public final String workspaceRoleArn()
```
    The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
    
    Returns:
    
    The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
  - 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

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

accountAccessType

accountAccessTypeAsString

authentication

created

dataSources

hasDataSources

dataSourcesAsStrings

description

endpoint

freeTrialConsumed

freeTrialExpiration

grafanaVersion

id

licenseExpiration

licenseType

licenseTypeAsString

modified

name

networkAccessControl

notificationDestinations

hasNotificationDestinations

notificationDestinationsAsStrings

organizationRoleName

hasOrganizationalUnits

organizationalUnits

permissionType

permissionTypeAsString

stackSetName

status

statusAsString

hasTags

tags

vpcConfiguration

workspaceRoleArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields