Class DashxApisClient

Service client instance for DashxApis.

Inheritance

object

ClientBase

RegionalClientBase

DashxApisClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ManagementdashboardService

Assembly: OCI.DotNetSDK.Managementdashboard.dll

Syntax

public class DashxApisClient : RegionalClientBase, IDisposable

Constructors

DashxApisClient(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 DashxApisClient(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 DashxApisPaginators Paginators { get; }

Property Value

Type	Description
DashxApisPaginators

Waiters

Declaration

public DashxApisWaiters Waiters { get; }

Property Value

Type	Description
DashxApisWaiters

Methods

ChangeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the dashboard from the existing compartment to a new compartment.

Declaration

public Task<ChangeManagementDashboardsCompartmentResponse> ChangeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeManagementDashboardsCompartmentRequest	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<ChangeManagementDashboardsCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeManagementDashboardsCompartment API.

ChangeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the saved search from the existing compartment to a new compartment.

Declaration

public Task<ChangeManagementSavedSearchesCompartmentResponse> ChangeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeManagementSavedSearchesCompartmentRequest	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<ChangeManagementSavedSearchesCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeManagementSavedSearchesCompartment API.

CreateManagementDashboard(CreateManagementDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new dashboard. Limit for number of saved searches in a dashboard is 20.
Here's an example of how you can use CLI to create a dashboard. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: oci management-dashboard dashboard get --management-dashboard-id \"ocid1.managementdashboard.oc1..dashboardId1\" --query data > Create.json. You can then modify the Create.json file by removing the id attribute and making other required changes, and use the oci management-dashboard dashboard create command.

Declaration

public Task<CreateManagementDashboardResponse> CreateManagementDashboard(CreateManagementDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateManagementDashboardRequest	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<CreateManagementDashboardResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateManagementDashboard API.

CreateManagementSavedSearch(CreateManagementSavedSearchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new saved search. Here's an example of how you can use CLI to create a saved search. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: oci management-dashboard saved-search get --management-saved-search-id ocid1.managementsavedsearch.oc1..savedsearchId1 --query data > Create.json. You can then modify the Create.json file by removing the id attribute and making other required changes, and use the oci management-dashboard saved-search create command.

Declaration

public Task<CreateManagementSavedSearchResponse> CreateManagementSavedSearch(CreateManagementSavedSearchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateManagementSavedSearchRequest	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<CreateManagementSavedSearchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateManagementSavedSearch API.

DeleteManagementDashboard(DeleteManagementDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Dashboard by ID.

Declaration

public Task<DeleteManagementDashboardResponse> DeleteManagementDashboard(DeleteManagementDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteManagementDashboardRequest	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<DeleteManagementDashboardResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteManagementDashboard API.

DeleteManagementSavedSearch(DeleteManagementSavedSearchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a saved search by ID.

Declaration

public Task<DeleteManagementSavedSearchResponse> DeleteManagementSavedSearch(DeleteManagementSavedSearchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteManagementSavedSearchRequest	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<DeleteManagementSavedSearchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteManagementSavedSearch API.

ExportDashboard(ExportDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Exports an array of dashboards and their saved searches. Export is designed to work with importDashboard. Here's an example of how you can use CLI to export a dashboard: $oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > dashboards.json

Declaration

public Task<ExportDashboardResponse> ExportDashboard(ExportDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ExportDashboardRequest	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<ExportDashboardResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ExportDashboard API.

GetManagementDashboard(GetManagementDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile's state property.

Declaration

public Task<GetManagementDashboardResponse> GetManagementDashboard(GetManagementDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetManagementDashboardRequest	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<GetManagementDashboardResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetManagementDashboard API.

GetManagementSavedSearch(GetManagementSavedSearchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a saved search by ID.

Declaration

public Task<GetManagementSavedSearchResponse> GetManagementSavedSearch(GetManagementSavedSearchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetManagementSavedSearchRequest	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<GetManagementSavedSearchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetManagementSavedSearch API.

GetOobManagementDashboard(GetOobManagementDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an OOB dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile's state property.

Declaration

public Task<GetOobManagementDashboardResponse> GetOobManagementDashboard(GetOobManagementDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOobManagementDashboardRequest	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<GetOobManagementDashboardResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOobManagementDashboard API.

GetOobManagementSavedSearch(GetOobManagementSavedSearchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a saved search by ID.

Declaration

public Task<GetOobManagementSavedSearchResponse> GetOobManagementSavedSearch(GetOobManagementSavedSearchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOobManagementSavedSearchRequest	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<GetOobManagementSavedSearchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOobManagementSavedSearch API.

ImportDashboard(ImportDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Imports an array of dashboards and their saved searches. Here's an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > Import.json. Note that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. Here's an example of how you can use CLI to import: oci management-dashboard dashboard import --from-json file://Import.json

Declaration

public Task<ImportDashboardResponse> ImportDashboard(ImportDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ImportDashboardRequest	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<ImportDashboardResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ImportDashboard API.

ListManagementDashboards(ListManagementDashboardsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the list of dashboards in a compartment with pagination. Returned properties are the summary.

Declaration

public Task<ListManagementDashboardsResponse> ListManagementDashboards(ListManagementDashboardsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListManagementDashboardsRequest	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<ListManagementDashboardsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListManagementDashboards API.

ListManagementSavedSearches(ListManagementSavedSearchesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the list of saved searches in a compartment with pagination. Returned properties are the summary.

Declaration

public Task<ListManagementSavedSearchesResponse> ListManagementSavedSearches(ListManagementSavedSearchesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListManagementSavedSearchesRequest	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<ListManagementSavedSearchesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListManagementSavedSearches API.

ListOobManagementDashboards(ListOobManagementDashboardsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the list of OOB dashboards with pagination. Returned properties are the summary.

Declaration

public Task<ListOobManagementDashboardsResponse> ListOobManagementDashboards(ListOobManagementDashboardsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOobManagementDashboardsRequest	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<ListOobManagementDashboardsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOobManagementDashboards API.

ListOobManagementSavedSearches(ListOobManagementSavedSearchesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the list of out-of-box saved searches in a compartment with pagination. Returned properties are the summary.

Declaration

public Task<ListOobManagementSavedSearchesResponse> ListOobManagementSavedSearches(ListOobManagementSavedSearchesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOobManagementSavedSearchesRequest	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<ListOobManagementSavedSearchesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOobManagementSavedSearches API.

UpdateManagementDashboard(UpdateManagementDashboardRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an existing dashboard identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API. Limit for number of saved searches in a dashboard is 20.

Declaration

public Task<UpdateManagementDashboardResponse> UpdateManagementDashboard(UpdateManagementDashboardRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateManagementDashboardRequest	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<UpdateManagementDashboardResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateManagementDashboard API.

UpdateManagementSavedSearch(UpdateManagementSavedSearchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an existing saved search identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API.

Declaration

public Task<UpdateManagementSavedSearchResponse> UpdateManagementSavedSearch(UpdateManagementSavedSearchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateManagementSavedSearchRequest	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<UpdateManagementSavedSearchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateManagementSavedSearch API.

Implements

IDisposable