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

Class UpdateInstruction

java.lang.Object

software.amazon.awssdk.services.grafana.model.UpdateInstruction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UpdateInstruction.Builder,UpdateInstruction>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateInstruction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UpdateInstruction.Builder,UpdateInstruction>

Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateInstruction.Builder

Method Summary

Modifier and Type	Method	Description
UpdateAction	action()	Specifies whether this update is to add or revoke role permissions.
String	actionAsString()	Specifies whether this update is to add or revoke role permissions.
static UpdateInstruction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUsers()	For responses, this returns true if the service returned a value for the Users property.
Role	role()	The role to add or revoke for the user or the group specified in users.
String	roleAsString()	The role to add or revoke for the user or the group specified in users.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateInstruction.Builder>	serializableBuilderClass()
UpdateInstruction.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<User>	users()	A structure that specifies the user or group to add or revoke the role for.

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

action

public final UpdateAction action()

Specifies whether this update is to add or revoke role permissions.

If the service returns an enum value that is not available in the current SDK version, action will return UpdateAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Specifies whether this update is to add or revoke role permissions.

See Also:

UpdateAction

actionAsString

public final String actionAsString()

Specifies whether this update is to add or revoke role permissions.

If the service returns an enum value that is not available in the current SDK version, action will return UpdateAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Specifies whether this update is to add or revoke role permissions.

See Also:

UpdateAction

role

public final Role role()

The role to add or revoke for the user or the group specified in users.

If the service returns an enum value that is not available in the current SDK version, role will return Role.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

Returns:

The role to add or revoke for the user or the group specified in users.

See Also:

Role

roleAsString

public final String roleAsString()

The role to add or revoke for the user or the group specified in users.

If the service returns an enum value that is not available in the current SDK version, role will return Role.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

Returns:

The role to add or revoke for the user or the group specified in users.

See Also:

Role

hasUsers

public final boolean hasUsers()

For responses, this returns true if the service returned a value for the Users 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.

users

public final List<User> users()

A structure that specifies the user or group to add or revoke the role for.

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

Returns:

A structure that specifies the user or group to add or revoke the role for.

toBuilder

public UpdateInstruction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateInstruction.Builder,UpdateInstruction>

builder

public static UpdateInstruction.Builder builder()

serializableBuilderClass

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