Class UpdateInstruction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UpdateInstruction.Builder,
UpdateInstruction>
Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal UpdateAction
action()
Specifies whether this update is to add or revoke role permissions.final String
Specifies whether this update is to add or revoke role permissions.static UpdateInstruction.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasUsers()
For responses, this returns true if the service returned a value for the Users property.final Role
role()
The role to add or revoke for the user or the group specified inusers
.final String
The role to add or revoke for the user or the group specified inusers
.static Class
<? extends UpdateInstruction.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.users()
A structure that specifies the user or group to add or revoke the role for.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnUpdateAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- Specifies whether this update is to add or revoke role permissions.
- See Also:
-
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 returnUpdateAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- Specifies whether this update is to add or revoke role permissions.
- See Also:
-
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 returnRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- Returns:
- The role to add or revoke for the user or the group specified in
users
. - See Also:
-
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 returnRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- Returns:
- The role to add or revoke for the user or the group specified in
users
. - See Also:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<UpdateInstruction.Builder,
UpdateInstruction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-