Package software.amazon.awssdk.services.amp.model

Class WorkspaceDescription

java.lang.Object
software.amazon.awssdk.services.amp.model.WorkspaceDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
@Generated("software.amazon.awssdk:codegen") public final class WorkspaceDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>

The full details about one Amazon Managed Service for Prometheus workspace in your account.

See Also:

  • Method Details

    • alias

      public final String alias()

      The alias that is assigned to this workspace to help identify it. It may not be unique.

      Returns:
      The alias that is assigned to this workspace to help identify it. It may not be unique.

    • arn

      public final String arn()

      The ARN of the workspace.

      Returns:
      The ARN of the workspace.

    • createdAt

      public final Instant createdAt()

      The date and time that the workspace was created.

      Returns:
      The date and time that the workspace was created.

    • kmsKeyArn

      public final String kmsKeyArn()

      (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

      Returns:
      (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

    • prometheusEndpoint

      public final String prometheusEndpoint()

      The Prometheus endpoint available for this workspace.

      Returns:
      The Prometheus endpoint available for this workspace.

    • status

      public final WorkspaceStatus status()

      The current status of the workspace.

      Returns:
      The current status of the workspace.

    • 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 tag keys and values that are 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 tag keys and values that are associated with the workspace.

    • workspaceId

      public final String workspaceId()

      The unique ID for the workspace.

      Returns:
      The unique ID for the workspace.

    • toBuilder

      public WorkspaceDescription.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<WorkspaceDescription.Builder,WorkspaceDescription>
      Returns:
      a builder for type T

    • 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)
      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.