Class DashboardGroupClient

Service client instance for DashboardGroup.

Inheritance

object

ClientBase

RegionalClientBase

DashboardGroupClient

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.DashboardService

Assembly: OCI.DotNetSDK.Dashboardservice.dll

Syntax

public class DashboardGroupClient : RegionalClientBase, IDisposable

Constructors

DashboardGroupClient(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 DashboardGroupClient(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 DashboardGroupPaginators Paginators { get; }

Property Value

Type	Description
DashboardGroupPaginators

Waiters

Declaration

public DashboardGroupWaiters Waiters { get; }

Property Value

Type	Description
DashboardGroupWaiters

Methods

ChangeDashboardGroupCompartment(ChangeDashboardGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a DashboardGroup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeDashboardGroupCompartmentResponse> ChangeDashboardGroupCompartment(ChangeDashboardGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateDashboardGroup(CreateDashboardGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new dashboard group 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 group 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<CreateDashboardGroupResponse> CreateDashboardGroup(CreateDashboardGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteDashboardGroup(DeleteDashboardGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to delete.

Declaration

public Task<DeleteDashboardGroupResponse> DeleteDashboardGroup(DeleteDashboardGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetDashboardGroup(GetDashboardGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified dashboard group's information. Uses the dashboard group's OCID to determine which dashboard to retrieve.

Declaration

public Task<GetDashboardGroupResponse> GetDashboardGroup(GetDashboardGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListDashboardGroups(ListDashboardGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of dashboard groups with a specific compartment ID.

Declaration

public Task<ListDashboardGroupsResponse> ListDashboardGroups(ListDashboardGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateDashboardGroup(UpdateDashboardGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to update.

Declaration

public Task<UpdateDashboardGroupResponse> UpdateDashboardGroup(UpdateDashboardGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable