Package software.amazon.awssdk.services.grafana.model

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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WorkspaceSummary.Builder,WorkspaceSummary>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.