Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DashboardClient

Constructors

constructor

  • new DashboardClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DashboardClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: DashboardWaiter

targetService

targetService: string = "Dashboard"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://dashboard.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeDashboardGroup

  • Moves a Dashboard resource from one dashboardGroup identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeDashboardGroup API.

    Parameters

    Returns Promise<ChangeDashboardGroupResponse>

    ChangeDashboardGroupResponse

close

  • close(): void

createDashboard

  • Creates a new dashboard in the dashboard group's compartment using the details provided in request body.

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDashboard API.

    Parameters

    Returns Promise<CreateDashboardResponse>

    CreateDashboardResponse

createWaiters

deleteDashboard

  • Deletes the specified dashboard. Uses the dashboard's OCID to determine which dashboard to delete. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDashboard API.

    Parameters

    Returns Promise<DeleteDashboardResponse>

    DeleteDashboardResponse

getDashboard

  • Gets the specified dashboard's information. Uses the dashboard's OCID to determine which dashboard to retrieve. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDashboard API.

    Parameters

    Returns Promise<GetDashboardResponse>

    GetDashboardResponse

getWaiters

listDashboards

  • Returns a list of dashboards with a specific dashboard group ID.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDashboards API.

    Parameters

    Returns Promise<ListDashboardsResponse>

    ListDashboardsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateDashboard

  • Updates the specified dashboard. Uses the dashboard's OCID to determine which dashboard to update. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDashboard API.

    Parameters

    Returns Promise<UpdateDashboardResponse>

    UpdateDashboardResponse