Class DashboardClient
Service client instance for Dashboard.
Implements
Inherited Members
Namespace: Oci.DashboardService
Assembly: OCI.DotNetSDK.Dashboardservice.dll
Syntax
public class DashboardClient : RegionalClientBase, IDisposable
Constructors
DashboardClient(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 DashboardClient(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 DashboardPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DashboardPaginators |
Waiters
Declaration
public DashboardWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DashboardWaiters |
Methods
ChangeDashboardGroup(ChangeDashboardGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Dashboard resource from one dashboardGroup identifier to another. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeDashboardGroupResponse> ChangeDashboardGroup(ChangeDashboardGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDashboardGroupRequest | 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<ChangeDashboardGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDashboardGroup API.
CreateDashboard(CreateDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new dashboard in the dashboard group's compartment using the details provided in request body. <br/> Caution: Resources for the Dashboard service are created in the tenacy's home region. Although it is possible to create dashboard resource in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended.
Declaration
public Task<CreateDashboardResponse> CreateDashboard(CreateDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDashboardRequest | 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<CreateDashboardResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDashboard API.
DeleteDashboard(DeleteDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified dashboard. Uses the dashboard's OCID to determine which dashboard to delete.
Declaration
public Task<DeleteDashboardResponse> DeleteDashboard(DeleteDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDashboardRequest | 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<DeleteDashboardResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDashboard API.
GetDashboard(GetDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified dashboard's information. Uses the dashboard's OCID to determine which dashboard to retrieve.
Declaration
public Task<GetDashboardResponse> GetDashboard(GetDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDashboardRequest | 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<GetDashboardResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDashboard API.
ListDashboards(ListDashboardsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of dashboards with a specific dashboard group ID.
Declaration
public Task<ListDashboardsResponse> ListDashboards(ListDashboardsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDashboardsRequest | 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<ListDashboardsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDashboards API.
UpdateDashboard(UpdateDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified dashboard. Uses the dashboard's OCID to determine which dashboard to update.
Declaration
public Task<UpdateDashboardResponse> UpdateDashboard(UpdateDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDashboardRequest | 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<UpdateDashboardResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDashboard API.