GetPrivilegesRequest (rest-high-level 7.3.1 API)

java.lang.Object
- org.elasticsearch.client.security.GetPrivilegesRequest

All Implemented Interfaces:: Validatable

public final class GetPrivilegesRequest
extends java.lang.Object
implements Validatable

Request object to get application privilege(s)

Field Summary
- Fields inherited from interface org.elasticsearch.client.Validatable
  EMPTY

Constructor Summary

Constructors
Constructor Description

GetPrivilegesRequest(java.lang.String applicationName, java.lang.String... privilegeNames)

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`static GetPrivilegesRequest`	`getAllPrivileges()`	Constructs a `GetPrivilegesRequest` to request all the privileges defined for all applications
`java.lang.String`	`getApplicationName()`
`static GetPrivilegesRequest`	`getApplicationPrivileges(java.lang.String applicationName)`	Constructs a `GetPrivilegesRequest` to request all the privileges defined for the specified `applicationName`
`java.lang.String[]`	`getPrivilegeNames()`
`int`	`hashCode()`

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

Methods inherited from interface org.elasticsearch.client.Validatable
validate

- Constructor Detail
  - GetPrivilegesRequest
```
public GetPrivilegesRequest(@Nullable
                            java.lang.String applicationName,
                            @Nullable
                            java.lang.String... privilegeNames)
```
- Method Detail
  - getAllPrivileges
```
public static GetPrivilegesRequest getAllPrivileges()
```
    Constructs a GetPrivilegesRequest to request all the privileges defined for all applications
  - getApplicationPrivileges
```
public static GetPrivilegesRequest getApplicationPrivileges(java.lang.String applicationName)
```
    Constructs a GetPrivilegesRequest to request all the privileges defined for the specified applicationName
    
    Parameters:
    
    applicationName - the name of the application for which the privileges are requested
  - getApplicationName
```
public java.lang.String getApplicationName()
```
    Returns:
    
    the name of the application for which to return certain privileges
  - getPrivilegeNames
```
public java.lang.String[] getPrivilegeNames()
```
    Returns:
    
    an array of privilege names to return or null if all should be returned
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object