Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnalyticsClient

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

  • AnalyticsClient

Constructors

constructor

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

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: AnalyticsWaiter

targetService

targetService: string = "Analytics"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://analytics.{region}.ocp.{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

changeAnalyticsInstanceCompartment

changeAnalyticsInstanceNetworkEndpoint

close

  • close(): void

createAnalyticsInstance

  • Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest.

    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 CreateAnalyticsInstance API.

    Parameters

    Returns Promise<CreateAnalyticsInstanceResponse>

    CreateAnalyticsInstanceResponse

createPrivateAccessChannel

  • Create an Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest.

    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 CreatePrivateAccessChannel API.

    Parameters

    Returns Promise<CreatePrivateAccessChannelResponse>

    CreatePrivateAccessChannelResponse

createVanityUrl

  • Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate for this host.

    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 CreateVanityUrl API.

    Parameters

    Returns Promise<CreateVanityUrlResponse>

    CreateVanityUrlResponse

createWaiters

  • Creates a new AnalyticsWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns AnalyticsWaiter

    The service waiters.

deleteAnalyticsInstance

  • Terminates the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

    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 DeleteAnalyticsInstance API.

    Parameters

    Returns Promise<DeleteAnalyticsInstanceResponse>

    DeleteAnalyticsInstanceResponse

deletePrivateAccessChannel

  • Delete an Analytics instance's Private access channel with the given unique identifier key.

    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 DeletePrivateAccessChannel API.

    Parameters

    Returns Promise<DeletePrivateAccessChannelResponse>

    DeletePrivateAccessChannelResponse

deleteVanityUrl

  • Allows deleting a previously created vanity url.

    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 DeleteVanityUrl API.

    Parameters

    Returns Promise<DeleteVanityUrlResponse>

    DeleteVanityUrlResponse

deleteWorkRequest

getAnalyticsInstance

getPrivateAccessChannel

  • Retrieve private access channel in the specified Analytics Instance.

    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 GetPrivateAccessChannel API.

    Parameters

    Returns Promise<GetPrivateAccessChannelResponse>

    GetPrivateAccessChannelResponse

getWaiters

getWorkRequest

  • Get the details of a work request.

    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 GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAllAnalyticsInstances

  • NOTE: This function is deprecated in favor of listAnalyticsInstancesRecordIterator function. Creates a new async iterator which will iterate over the models.AnalyticsInstanceSummary objects contained in responses from the listAnalyticsInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AnalyticsInstanceSummary>

listAllAnalyticsInstancesResponses

  • NOTE: This function is deprecated in favor of listAnalyticsInstancesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAnalyticsInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAnalyticsInstancesResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLog objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLog>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listAnalyticsInstances

listAnalyticsInstancesRecordIterator

listAnalyticsInstancesResponseIterator

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestLog objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLog>

listWorkRequestLogsResponseIterator

listWorkRequests

  • List all work requests in a compartment.

    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 ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

scaleAnalyticsInstance

  • Scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest.

    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 ScaleAnalyticsInstance API.

    Parameters

    Returns Promise<ScaleAnalyticsInstanceResponse>

    ScaleAnalyticsInstanceResponse

setKmsKey

  • Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.

    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 SetKmsKey API.

    Parameters

    Returns Promise<SetKmsKeyResponse>

    SetKmsKeyResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startAnalyticsInstance

  • Starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

    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 StartAnalyticsInstance API.

    Parameters

    Returns Promise<StartAnalyticsInstanceResponse>

    StartAnalyticsInstanceResponse

stopAnalyticsInstance

  • Stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

    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 StopAnalyticsInstance API.

    Parameters

    Returns Promise<StopAnalyticsInstanceResponse>

    StopAnalyticsInstanceResponse

updateAnalyticsInstance

  • Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated.

    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 UpdateAnalyticsInstance API.

    Parameters

    Returns Promise<UpdateAnalyticsInstanceResponse>

    UpdateAnalyticsInstanceResponse

updatePrivateAccessChannel

  • Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.

    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 UpdatePrivateAccessChannel API.

    Parameters

    Returns Promise<UpdatePrivateAccessChannelResponse>

    UpdatePrivateAccessChannelResponse

updateVanityUrl

  • Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.

    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 UpdateVanityUrl API.

    Parameters

    Returns Promise<UpdateVanityUrlResponse>

    UpdateVanityUrlResponse