Class RoleValues

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

This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace. SAML authenticated users not part of Admin or Editor role groups have Viewer permission over the workspace.

See Also:

  • Method Details

    • hasAdmin

      public final boolean hasAdmin()
      For responses, this returns true if the service returned a value for the Admin 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.

    • admin

      public final List<String> admin()

      A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.

      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 hasAdmin() method.

      Returns:
      A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.

    • hasEditor

      public final boolean hasEditor()
      For responses, this returns true if the service returned a value for the Editor 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.

    • editor

      public final List<String> editor()

      A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.

      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 hasEditor() method.

      Returns:
      A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.

    • toBuilder

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

    • builder

      public static RoleValues.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RoleValues.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.