Class QueryClient
Service client instance for Query.
Implements
Inherited Members
Namespace: Oci.ApmtracesService
Assembly: OCI.DotNetSDK.Apmtraces.dll
Syntax
public class QueryClient : RegionalClientBase, IDisposable
Constructors
QueryClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public QueryClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public QueryPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
QueryPaginators |
Methods
ListQuickPicks(ListQuickPicksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of predefined Quick Pick queries intended to assist the user to choose a query to run. There is no sorting applied on the results.
Declaration
public Task<ListQuickPicksResponse> ListQuickPicks(ListQuickPicksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListQuickPicksRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListQuickPicksResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListQuickPicks API.
Query(QueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the results (selected attributes and aggregations) of a query constructed according to the Application Performance Monitoring Defined Query Syntax. Query results are filtered by the filter criteria specified in the where clause. Further query results are grouped by the attributes specified in the group by clause. Finally, ordering (asc/desc) is done by the specified attributes in the order by clause.
Declaration
public Task<QueryResponse> Query(QueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
QueryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<QueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Query API.