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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RoleValues.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	admin()	A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
static RoleValues.Builder	builder()
List<String>	editor()	A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdmin()	For responses, this returns true if the service returned a value for the Admin property.
boolean	hasEditor()	For responses, this returns true if the service returned a value for the Editor property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends RoleValues.Builder>	serializableBuilderClass()
RoleValues.Builder	toBuilder()
String	toString()	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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<RoleValues.Builder,RoleValues>

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)

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