Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListAgentsRequest

example

Click here to see how to use ListAgentsRequest.

Properties

Optional agentId

agentId: undefined | string

A filter to return only resources that match the given Agent ID.

compartmentId

compartmentId: string

The ID of the compartment in which to list resources.

Optional displayName

displayName: undefined | string

A filter to return only resources that match the entire display name given.

Optional environmentId

environmentId: undefined | string

A filter to return only resources that match the given environment ID.

Optional lifecycleState

lifecycleState: undefined | string

A filter to return only resources their lifecycleState matches the given lifecycleState.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

A token representing the position at which to start retrieving results. This must come from the {@code opc-next-page} header field of a previous response.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Optional sortOrder

sortOrder: model.SortOrders

The sort order to use, either 'ASC' or 'DESC'.