UpdateInstruction (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.managedgrafana.model.UpdateInstruction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateInstruction
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateInstruction()

Constructors
Constructor and Description
`UpdateInstruction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateInstruction`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` Specifies whether this update is to add or revoke role permissions.
`String`	`getRole()` The role to add or revoke for the user or the group specified in `users`.
`List<User>`	`getUsers()` A structure that specifies the user or group to add or revoke the role for.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(String action)` Specifies whether this update is to add or revoke role permissions.
`void`	`setRole(String role)` The role to add or revoke for the user or the group specified in `users`.
`void`	`setUsers(Collection<User> users)` A structure that specifies the user or group to add or revoke the role for.
`String`	`toString()` Returns a string representation of this object.
`UpdateInstruction`	`withAction(String action)` Specifies whether this update is to add or revoke role permissions.
`UpdateInstruction`	`withAction(UpdateAction action)` Specifies whether this update is to add or revoke role permissions.
`UpdateInstruction`	`withRole(Role role)` The role to add or revoke for the user or the group specified in `users`.
`UpdateInstruction`	`withRole(String role)` The role to add or revoke for the user or the group specified in `users`.
`UpdateInstruction`	`withUsers(Collection<User> users)` A structure that specifies the user or group to add or revoke the role for.
`UpdateInstruction`	`withUsers(User... users)` A structure that specifies the user or group to add or revoke the role for.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateInstruction
```
public UpdateInstruction()
```
- Method Detail
  - setAction
```
public void setAction(String action)
```
    Specifies whether this update is to add or revoke role permissions.
    
    Parameters:
    
    action - Specifies whether this update is to add or revoke role permissions.
    
    See Also:
    
    UpdateAction
  - getAction
```
public String getAction()
```
    Specifies whether this update is to add or revoke role permissions.
    
    Returns:
    
    Specifies whether this update is to add or revoke role permissions.
    
    See Also:
    
    UpdateAction
  - withAction
```
public UpdateInstruction withAction(String action)
```
    Specifies whether this update is to add or revoke role permissions.
    
    Parameters:
    
    action - Specifies whether this update is to add or revoke role permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpdateAction
  - withAction
```
public UpdateInstruction withAction(UpdateAction action)
```
    Specifies whether this update is to add or revoke role permissions.
    
    Parameters:
    
    action - Specifies whether this update is to add or revoke role permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpdateAction
  - setRole
```
public void setRole(String role)
```
    The role to add or revoke for the user or the group specified in users.
    
    Parameters:
    
    role - The role to add or revoke for the user or the group specified in users.
    
    See Also:
    
    Role
  - getRole
```
public String getRole()
```
    The role to add or revoke for the user or the group specified in users.
    
    Returns:
    
    The role to add or revoke for the user or the group specified in users.
    
    See Also:
    
    Role
  - withRole
```
public UpdateInstruction withRole(String role)
```
    The role to add or revoke for the user or the group specified in users.
    
    Parameters:
    
    role - The role to add or revoke for the user or the group specified in users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Role
  - withRole
```
public UpdateInstruction withRole(Role role)
```
    The role to add or revoke for the user or the group specified in users.
    
    Parameters:
    
    role - The role to add or revoke for the user or the group specified in users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Role
  - getUsers
```
public List<User> getUsers()
```
    A structure that specifies the user or group to add or revoke the role for.
    
    Returns:
    
    A structure that specifies the user or group to add or revoke the role for.
  - setUsers
```
public void setUsers(Collection<User> users)
```
    A structure that specifies the user or group to add or revoke the role for.
    
    Parameters:
    
    users - A structure that specifies the user or group to add or revoke the role for.
  - withUsers
```
public UpdateInstruction withUsers(User... users)
```
    A structure that specifies the user or group to add or revoke the role for.
    
    NOTE: This method appends the values to the existing list (if any). Use setUsers(java.util.Collection) or withUsers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    users - A structure that specifies the user or group to add or revoke the role for.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUsers
```
public UpdateInstruction withUsers(Collection<User> users)
```
    A structure that specifies the user or group to add or revoke the role for.
    
    Parameters:
    
    users - A structure that specifies the user or group to add or revoke the role for.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateInstruction clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UpdateInstruction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateInstruction

Method Detail

setAction

getAction

withAction

withAction

setRole

getRole

withRole

withRole

getUsers

setUsers

withUsers

withUsers

toString

equals

hashCode

clone

marshall