Class OccMetricsClient
Service client instance for OccMetrics.
Implements
Inherited Members
Namespace: Oci.OcicontrolcenterService
Assembly: OCI.DotNetSDK.Ocicontrolcenter.dll
Syntax
public class OccMetricsClient : RegionalClientBase, IDisposable
Constructors
OccMetricsClient(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 OccMetricsClient(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 OccMetricsPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
OccMetricsPaginators |
Methods
ListMetricProperties(ListMetricPropertiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of available metrics for the given namespace. The results for metrics with dimensions includes list of all the associated dimensions. The results are sorted by the metricName and then by dimension in ascending alphabetical order. For a list of valid namespaces, see {@link #listNamespaces(ListNamespacesRequest) listNamespaces}.
Declaration
public Task<ListMetricPropertiesResponse> ListMetricProperties(ListMetricPropertiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMetricPropertiesRequest | 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<ListMetricPropertiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMetricProperties API.
ListNamespaces(ListNamespacesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all the available source services called namespaces emitting metrics for this region. The namespaces are sorted in ascending alphabetical order.
Declaration
public Task<ListNamespacesResponse> ListNamespaces(ListNamespacesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNamespacesRequest | 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<ListNamespacesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNamespaces API.
RequestSummarizedMetricData(RequestSummarizedMetricDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the summarized data for the given metric from the given namespace. The aggregation method depends on the metric. The metric data can be filtered by providing the dimension, startTime or endTime. The metric data in the response is sorted by dimension in ascending order and then by sampleTime in ascending chronological order.
Declaration
public Task<RequestSummarizedMetricDataResponse> RequestSummarizedMetricData(RequestSummarizedMetricDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedMetricDataRequest | 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<RequestSummarizedMetricDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedMetricData API.