java.lang.Object
- com.oracle.bmc.requests.BmcRequest<Void>
- - com.oracle.bmc.cloudbridge.requests.ListAgentsRequest

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220509")
public class ListAgentsRequest
extends BmcRequest<Void>
```
Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.1/cloudbridge/ListAgentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAgentsRequest.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ListAgentsRequest.Builder

static class ListAgentsRequest.SortBy
The field to sort by.

Constructor Summary

Constructors
Constructor Description

ListAgentsRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListAgentsRequest.Builder`	`builder()`	Return a new builder for this request object.
`boolean`	`equals(Object o)`	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
`String`	`getAgentId()`	A filter to return only resources that match the given Agent ID.
`String`	`getCompartmentId()`	The ID of the compartment in which to list resources.
`String`	`getDisplayName()`	A filter to return only resources that match the entire display name given.
`String`	`getEnvironmentId()`	A filter to return only resources that match the given environment ID.
`Agent.LifecycleState`	`getLifecycleState()`	A filter to return only resources their lifecycleState matches the given lifecycleState.
`Integer`	`getLimit()`	The maximum number of items to return.
`String`	`getOpcRequestId()`	The client request ID for tracing.
`String`	`getPage()`	A token representing the position at which to start retrieving results.
`ListAgentsRequest.SortBy`	`getSortBy()`	The field to sort by.
`SortOrders`	`getSortOrder()`	The sort order to use, either ‘ASC’ or ‘DESC’.
`int`	`hashCode()`	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
`ListAgentsRequest.Builder`	`toBuilder()`	Return an instance of `ListAgentsRequest.Builder` that allows you to modify request properties.
`String`	`toString()`

Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

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

- Constructor Detail
  - ListAgentsRequest
```
public ListAgentsRequest()
```
- Method Detail
  - getCompartmentId
```
public String getCompartmentId()
```
    The ID of the compartment in which to list resources.
  - getEnvironmentId
```
public String getEnvironmentId()
```
    A filter to return only resources that match the given environment ID.
  - getLifecycleState
```
public Agent.LifecycleState getLifecycleState()
```
    A filter to return only resources their lifecycleState matches the given lifecycleState.
  - getDisplayName
```
public String getDisplayName()
```
    A filter to return only resources that match the entire display name given.
  - getAgentId
```
public String getAgentId()
```
    A filter to return only resources that match the given Agent ID.
  - getLimit
```
public Integer getLimit()
```
    The maximum number of items to return.
  - getPage
```
public String getPage()
```
    A token representing the position at which to start retrieving results.
    This must come from the opc-next-page header field of a previous response.
  - getSortOrder
```
public SortOrders getSortOrder()
```
    The sort order to use, either ‘ASC’ or ‘DESC’.
  - getSortBy
```
public ListAgentsRequest.SortBy getSortBy()
```
    The field to sort by.
    Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
  - getOpcRequestId
```
public String getOpcRequestId()
```
    The client request ID for tracing.
  - toBuilder
```
public ListAgentsRequest.Builder toBuilder()
```
    Return an instance of ListAgentsRequest.Builder that allows you to modify request properties.
    
    Returns:
    
    instance of ListAgentsRequest.Builder that allows you to modify request properties.
  - builder
```
public static ListAgentsRequest.Builder builder()
```
    Return a new builder for this request object.
    
    Returns:
    
    builder for the request object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
    
    Overrides:
    
    equals in class BmcRequest<Void>
  - hashCode
```
public int hashCode()
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to generate a hash.
    
    Overrides:
    
    hashCode in class BmcRequest<Void>

Modifier and Type	Class	Description
`static class`	`ListAgentsRequest.Builder`
`static class`	`ListAgentsRequest.SortBy`	The field to sort by.

Class ListAgentsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.requests.BmcRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListAgentsRequest

Method Detail

getCompartmentId

getEnvironmentId

getLifecycleState

getDisplayName

getAgentId

getLimit

getPage

getSortOrder

getSortBy

getOpcRequestId

toBuilder

builder

toString

equals

hashCode