Class WorkspaceSummary
- java.lang.Object
-
- software.amazon.awssdk.services.grafana.model.WorkspaceSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<WorkspaceSummary.Builder,WorkspaceSummary>
@Generated("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 Description static interfaceWorkspaceSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationSummaryauthentication()A structure containing information about the authentication methods used in the workspace.static WorkspaceSummary.Builderbuilder()Instantcreated()The date that the workspace was created.Stringdescription()The customer-entered description of the workspace.Stringendpoint()The URL endpoint to use to access the Grafana console in the workspace.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)StringgrafanaToken()The token that ties this workspace to a Grafana Labs account.StringgrafanaVersion()The Grafana version that the workspace is running.inthashCode()booleanhasNotificationDestinations()For responses, this returns true if the service returned a value for the NotificationDestinations property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringid()The unique ID of the workspace.LicenseTypelicenseType()Specifies whether this workspace has a full Grafana Enterprise license.StringlicenseTypeAsString()Specifies whether this workspace has a full Grafana Enterprise license.Instantmodified()The most recent date that the workspace was modified.Stringname()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()WorkspaceStatusstatus()The current status of the workspace.StringstatusAsString()The current status of the workspace.Map<String,String>tags()The list of tags associated with the workspace.WorkspaceSummary.BuildertoBuilder()StringtoString()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.
-
grafanaToken
public final String grafanaToken()
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
- Returns:
- The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
-
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.
-
licenseType
public final LicenseType licenseType()
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
If the service returns an enum value that is not available in the current SDK version,
licenseTypewill returnLicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlicenseTypeAsString().- Returns:
- Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
- See Also:
LicenseType
-
licenseTypeAsString
public final String licenseTypeAsString()
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
If the service returns an enum value that is not available in the current SDK version,
licenseTypewill returnLicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlicenseTypeAsString().- Returns:
- Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
- 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.
-
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 theisEmpty()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,
statuswill returnWorkspaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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,
statuswill returnWorkspaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<WorkspaceSummary.Builder,WorkspaceSummary>
-
builder
public static WorkspaceSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends WorkspaceSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-