Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogAnalyticsClient

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

  • LogAnalyticsClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

targetService

targetService: string = "LogAnalytics"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://loganalytics.{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

addEntityAssociation

  • Adds association between input source log analytics entity and one or more existing destination entities. 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 AddEntityAssociation API.

    Parameters

    Returns Promise<AddEntityAssociationResponse>

    AddEntityAssociationResponse

addSourceEventTypes

  • Add one or more event types to a source. An event type and version can be enabled only on one source.

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

    Parameters

    Returns Promise<AddSourceEventTypesResponse>

    AddSourceEventTypesResponse

appendLookupData

  • Appends data to the lookup content. The csv file containing the content to be appended is passed in as binary data in the 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 AppendLookupData API.

    Parameters

    Returns Promise<AppendLookupDataResponse>

    AppendLookupDataResponse

assignEncryptionKey

batchGetBasicInfo

  • Lists basic information about a specified set of labels in batch.

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

    Parameters

    Returns Promise<BatchGetBasicInfoResponse>

    BatchGetBasicInfoResponse

cancelQueryWorkRequest

changeIngestTimeRuleCompartment

changeLogAnalyticsEmBridgeCompartment

changeLogAnalyticsEntityCompartment

changeLogAnalyticsLogGroupCompartment

changeLogAnalyticsObjectCollectionRuleCompartment

changeScheduledTaskCompartment

clean

  • Clean accumulated acceleration data stored for the accelerated saved search. The ScheduledTask taskType must be ACCELERATION.

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

    Parameters

    Returns Promise<CleanResponse>

    CleanResponse

close

  • close(): void

compareContent

  • Returns the difference between the two input payloads, including intraline differences.

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

    Parameters

    Returns Promise<CompareContentResponse>

    CompareContentResponse

createIngestTimeRule

  • Creates a new ingest time rule in the specified compartment. You may also specify optional information such as description, defined tags, and free-form tags.

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

    Parameters

    Returns Promise<CreateIngestTimeRuleResponse>

    CreateIngestTimeRuleResponse

createLogAnalyticsEmBridge

  • Add configuration for enterprise manager bridge. Enterprise manager bridge is used to automatically add selected entities from enterprise manager cloud control. A corresponding OCI bridge configuration is required in enterprise manager. 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 CreateLogAnalyticsEmBridge API.

    Parameters

    Returns Promise<CreateLogAnalyticsEmBridgeResponse>

    CreateLogAnalyticsEmBridgeResponse

createLogAnalyticsEntity

createLogAnalyticsEntityType

createLogAnalyticsLogGroup

  • Creates a new log group in the specified compartment with the input display name. You may also specify optional information such as description, defined tags, and free-form tags.

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

    Parameters

    Returns Promise<CreateLogAnalyticsLogGroupResponse>

    CreateLogAnalyticsLogGroupResponse

createLogAnalyticsObjectCollectionRule

createScheduledTask

createWaiters

  • Creates a new LogAnalyticsWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns LogAnalyticsWaiter

    The service waiters.

deleteAssociations

  • Deletes the associations between the sources and entities specified.

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

    Parameters

    Returns Promise<DeleteAssociationsResponse>

    DeleteAssociationsResponse

deleteField

  • Deletes field with the specified name.

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

    Parameters

    Returns Promise<DeleteFieldResponse>

    DeleteFieldResponse

deleteIngestTimeRule

deleteLabel

  • Deletes label with the specified name.

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

    Parameters

    Returns Promise<DeleteLabelResponse>

    DeleteLabelResponse

deleteLogAnalyticsEmBridge

deleteLogAnalyticsEntity

deleteLogAnalyticsEntityType

deleteLogAnalyticsLogGroup

  • Deletes the specified log group. The log group cannot be part of an active association or have an active upload.

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

    Parameters

    Returns Promise<DeleteLogAnalyticsLogGroupResponse>

    DeleteLogAnalyticsLogGroupResponse

deleteLogAnalyticsObjectCollectionRule

  • Deletes the configured object storage bucket based collection rule and stop the log collection. It will not delete the existing processed data associated with this bucket from logging analytics storage.

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

    Parameters

    Returns Promise<DeleteLogAnalyticsObjectCollectionRuleResponse>

    DeleteLogAnalyticsObjectCollectionRuleResponse

deleteLookup

  • Deletes lookup with the specified name.

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

    Parameters

    Returns Promise<DeleteLookupResponse>

    DeleteLookupResponse

deleteParser

  • Deletes parser with the specified name.

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

    Parameters

    Returns Promise<DeleteParserResponse>

    DeleteParserResponse

deleteScheduledTask

deleteSource

  • Deletes source with the specified name.

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

    Parameters

    Returns Promise<DeleteSourceResponse>

    DeleteSourceResponse

deleteUpload

  • Deletes an Upload by its reference. It deletes all the logs in storage asscoiated with the upload and the corresponding upload metadata.

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

    Parameters

    Returns Promise<DeleteUploadResponse>

    DeleteUploadResponse

deleteUploadFile

  • Deletes a specific log file inside an upload by upload file reference. It deletes all the logs from storage associated with the file and the corresponding metadata.

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

    Parameters

    Returns Promise<DeleteUploadFileResponse>

    DeleteUploadFileResponse

deleteUploadWarning

disableArchiving

disableAutoAssociation

  • Disables auto association for a log source. In the future, this log source would not be automatically associated with any entity that becomes eligible for association. In addition, you may also optionally remove all existing associations for this log source.

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

    Parameters

    Returns Promise<DisableAutoAssociationResponse>

    DisableAutoAssociationResponse

disableIngestTimeRule

disableSourceEventTypes

enableArchiving

enableAutoAssociation

  • Enables auto association for a log source. This would initiate immediate association of the source to any eligible entities it is not already associated with, and would also ensure the log source gets associated with entities that are added or become eligible in the future.

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

    Parameters

    Returns Promise<EnableAutoAssociationResponse>

    EnableAutoAssociationResponse

enableIngestTimeRule

enableSourceEventTypes

  • Enable one or more event types in a source. An event type and version can be enabled only in one source.

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

    Parameters

    Returns Promise<EnableSourceEventTypesResponse>

    EnableSourceEventTypesResponse

estimatePurgeDataSize

  • This API estimates the size of data to be purged based based on time interval, purge query etc.

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

    Parameters

    Returns Promise<EstimatePurgeDataSizeResponse>

    EstimatePurgeDataSizeResponse

estimateRecallDataSize

  • This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.

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

    Parameters

    Returns Promise<EstimateRecallDataSizeResponse>

    EstimateRecallDataSizeResponse

estimateReleaseDataSize

  • This API gives an active storage usage estimate for recalled data to be released and the time range of such data.

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

    Parameters

    Returns Promise<EstimateReleaseDataSizeResponse>

    EstimateReleaseDataSizeResponse

exportCustomContent

  • Exports all custom details of the specified sources, parsers, fields and labels, in zip format.

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

    Parameters

    Returns Promise<ExportCustomContentResponse>

    ExportCustomContentResponse

exportQueryResult

  • Export data based on query. Endpoint returns a stream of data. Endpoint is synchronous. Queries must deliver first result within 60 seconds or calls are subject to timeout. 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 ExportQueryResult API.

    Parameters

    Returns Promise<ExportQueryResultResponse>

    ExportQueryResultResponse

extractStructuredLogFieldPaths

extractStructuredLogHeaderPaths

filter

  • Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria. 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 Filter API.

    Parameters

    Returns Promise<FilterResponse>

    FilterResponse

getAssociationSummary

  • Returns the count of source associations for entities in the specified 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 GetAssociationSummary API.

    Parameters

    Returns Promise<GetAssociationSummaryResponse>

    GetAssociationSummaryResponse

getCategory

  • Gets detailed information about the category with the specified name.

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

    Parameters

    Returns Promise<GetCategoryResponse>

    GetCategoryResponse

getColumnNames

  • Extracts column names from the input SQL query.

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

    Parameters

    Returns Promise<GetColumnNamesResponse>

    GetColumnNamesResponse

getConfigWorkRequest

  • Returns detailed information about the configuration work request with the specified 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 GetConfigWorkRequest API.

    Parameters

    Returns Promise<GetConfigWorkRequestResponse>

    GetConfigWorkRequestResponse

getField

  • Gets detailed information about the field with the specified name.

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

    Parameters

    Returns Promise<GetFieldResponse>

    GetFieldResponse

getFieldsSummary

  • Returns the count of fields. You may optionally specify isShowDetail=true to view a summary of each field data type.

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

    Parameters

    Returns Promise<GetFieldsSummaryResponse>

    GetFieldsSummaryResponse

getIngestTimeRule

  • Gets detailed information about the specified ingest time rule such as description, defined tags, and free-form tags.

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

    Parameters

    Returns Promise<GetIngestTimeRuleResponse>

    GetIngestTimeRuleResponse

getLabel

  • Gets detailed information about the label with the specified name.

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

    Parameters

    Returns Promise<GetLabelResponse>

    GetLabelResponse

getLabelSummary

getLogAnalyticsEmBridge

getLogAnalyticsEmBridgeSummary

getLogAnalyticsEntitiesSummary

getLogAnalyticsEntity

getLogAnalyticsEntityType

getLogAnalyticsLogGroup

  • Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.

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

    Parameters

    Returns Promise<GetLogAnalyticsLogGroupResponse>

    GetLogAnalyticsLogGroupResponse

getLogAnalyticsLogGroupsSummary

getLogAnalyticsObjectCollectionRule

getLogSetsCount

  • This API returns the count of distinct log sets.

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

    Parameters

    Returns Promise<GetLogSetsCountResponse>

    GetLogSetsCountResponse

getLookup

  • Gets detailed information about the lookup with the specified name.

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

    Parameters

    Returns Promise<GetLookupResponse>

    GetLookupResponse

getLookupSummary

  • Returns the count of user created and oracle defined lookups. 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 GetLookupSummary API.

    Parameters

    Returns Promise<GetLookupSummaryResponse>

    GetLookupSummaryResponse

getNamespace

  • This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application

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

    Parameters

    Returns Promise<GetNamespaceResponse>

    GetNamespaceResponse

getParser

  • Gets detailed information about the parser with the specified name.

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

    Parameters

    Returns Promise<GetParserResponse>

    GetParserResponse

getParserSummary

getPreferences

  • Lists the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.

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

    Parameters

    Returns Promise<GetPreferencesResponse>

    GetPreferencesResponse

getQueryResult

  • Returns the intermediate results for a query that was specified to run asynchronously if the query has not completed, otherwise the final query results identified by a queryWorkRequestId returned when submitting the query execute asynchronously.

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

    Parameters

    Returns Promise<GetQueryResultResponse>

    GetQueryResultResponse

getQueryWorkRequest

  • Retrieve work request details by workRequestId. This endpoint can be polled for status tracking of work request. Clients should poll using the interval returned in the retry-after header. 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 GetQueryWorkRequest API.

    Parameters

    Returns Promise<GetQueryWorkRequestResponse>

    GetQueryWorkRequestResponse

getRecallCount

  • This API gets the number of recalls made and the maximum recalls that can be made

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

    Parameters

    Returns Promise<GetRecallCountResponse>

    GetRecallCountResponse

getRecalledDataSize

  • This API gets the datasize of recalls for a given timeframe

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

    Parameters

    Returns Promise<GetRecalledDataSizeResponse>

    GetRecalledDataSizeResponse

getRulesSummary

  • Returns the count of detection rules 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 GetRulesSummary API.

    Parameters

    Returns Promise<GetRulesSummaryResponse>

    GetRulesSummaryResponse

getScheduledTask

  • Get the scheduled task for the specified task identifier. 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 GetScheduledTask API.

    Parameters

    Returns Promise<GetScheduledTaskResponse>

    GetScheduledTaskResponse

getSource

  • Gets detailed information about the source with the specified name.

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

    Parameters

    Returns Promise<GetSourceResponse>

    GetSourceResponse

getSourceSummary

getStorage

  • This API gets the storage configuration of a tenancy

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

    Parameters

    Returns Promise<GetStorageResponse>

    GetStorageResponse

getStorageUsage

  • This API gets storage usage information of a tenancy. Storage usage information includes active, archived or recalled data. The unit of return data is in bytes.

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

    Parameters

    Returns Promise<GetStorageUsageResponse>

    GetStorageUsageResponse

getStorageWorkRequest

  • This API returns work request details specified by {workRequestId}. This API can be polled for status tracking of work request. Clients should poll using the interval returned in retry-after header.

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

    Parameters

    Returns Promise<GetStorageWorkRequestResponse>

    GetStorageWorkRequestResponse

getUnprocessedDataBucket

  • This API retrieves details of the configured bucket that stores unprocessed payloads.

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

    Parameters

    Returns Promise<GetUnprocessedDataBucketResponse>

    GetUnprocessedDataBucketResponse

getUpload

  • Gets an On-Demand Upload info by reference. 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 GetUpload API.

    Parameters

    Returns Promise<GetUploadResponse>

    GetUploadResponse

getWaiters

getWorkRequest

importCustomContent

  • Imports the specified custom content from the input in zip format.

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

    Parameters

    Returns Promise<ImportCustomContentResponse>

    ImportCustomContentResponse

listAssociableEntities

  • Lists the entities in the specified compartment which are (in)eligible for association with this source.

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

    Parameters

    Returns Promise<ListAssociableEntitiesResponse>

    ListAssociableEntitiesResponse

listAssociatedEntities

  • Lists the association details of entities in the specified compartment that are associated with at least one source.

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

    Parameters

    Returns Promise<ListAssociatedEntitiesResponse>

    ListAssociatedEntitiesResponse

listAutoAssociations

  • Gets information related to auto association for the source with the specified name.

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

    Parameters

    Returns Promise<ListAutoAssociationsResponse>

    ListAutoAssociationsResponse

listCategories

  • Returns a list of categories, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as category name or description.

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

    Parameters

    Returns Promise<ListCategoriesResponse>

    ListCategoriesResponse

listConfigWorkRequests

  • Returns the list of configuration work requests such as association or lookup operations, containing detailed information about them. You may paginate or limit the number of results.

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

    Parameters

    Returns Promise<ListConfigWorkRequestsResponse>

    ListConfigWorkRequestsResponse

listEffectiveProperties

listEncryptionKeyInfo

listEntityAssociations

listEntitySourceAssociations

listFields

  • Returns a list of log fields, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by specifying various options including parser and source names.

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

    Parameters

    Returns Promise<ListFieldsResponse>

    ListFieldsResponse

listIngestTimeRules

  • Returns a list of ingest time rules in a compartment. You may limit the number of rules, provide sorting options, and filter the results.

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

    Parameters

    Returns Promise<ListIngestTimeRulesResponse>

    ListIngestTimeRulesResponse

listLabelPriorities

  • Lists the available problem priorities that could be associated with a label.

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

    Parameters

    Returns Promise<ListLabelPrioritiesResponse>

    ListLabelPrioritiesResponse

listLabelSourceDetails

  • Lists sources using the label, along with configuration details like base field, operator and condition.

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

    Parameters

    Returns Promise<ListLabelSourceDetailsResponse>

    ListLabelSourceDetailsResponse

listLabels

  • Returns a list of labels, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as label name, display name, description and priority.

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

    Parameters

    Returns Promise<ListLabelsResponse>

    ListLabelsResponse

listLogAnalyticsEmBridges

listLogAnalyticsEntities

listLogAnalyticsEntityTopology

  • Return a log analytics entity topology collection that contains a set of log analytics entities and a set of relationships between those, for the input source entity. 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 ListLogAnalyticsEntityTopology API.

    Parameters

    Returns Promise<ListLogAnalyticsEntityTopologyResponse>

    ListLogAnalyticsEntityTopologyResponse

listLogAnalyticsEntityTypes

listLogAnalyticsLogGroups

  • Returns a list of log groups in a compartment. You may limit the number of log groups, provide sorting options, and filter the results by specifying a display name.

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

    Parameters

    Returns Promise<ListLogAnalyticsLogGroupsResponse>

    ListLogAnalyticsLogGroupsResponse

listLogAnalyticsObjectCollectionRules

listLogSets

  • This API returns a list of log sets.

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

    Parameters

    Returns Promise<ListLogSetsResponse>

    ListLogSetsResponse

listLookups

  • Returns a list of lookups, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as lookup name, description and type.

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

    Parameters

    Returns Promise<ListLookupsResponse>

    ListLookupsResponse

listMetaSourceTypes

listNamespaces

  • Given a tenancy OCID, this API returns the namespace of the tenancy if it is valid and subscribed to the region. The result also indicates if the tenancy is onboarded with Logging Analytics.

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

    Parameters

    Returns Promise<ListNamespacesResponse>

    ListNamespacesResponse

listOverlappingRecalls

  • This API gets the list of overlapping recalls made in the given timeframe

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

    Parameters

    Returns Promise<ListOverlappingRecallsResponse>

    ListOverlappingRecallsResponse

listParserFunctions

  • Lists the parser functions defined for the specified parser.

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

    Parameters

    Returns Promise<ListParserFunctionsResponse>

    ListParserFunctionsResponse

listParserMetaPlugins

  • Lists the parser meta plugins available for defining parser functions.

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

    Parameters

    Returns Promise<ListParserMetaPluginsResponse>

    ListParserMetaPluginsResponse

listParsers

  • Returns a list of parsers, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as parser name, type, display name and description.

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

    Parameters

    Returns Promise<ListParsersResponse>

    ListParsersResponse

listPropertiesMetadata

listQueryWorkRequests

listRecalledData

  • This API returns the list of recalled data of a tenancy.

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

    Parameters

    Returns Promise<ListRecalledDataResponse>

    ListRecalledDataResponse

listResourceCategories

  • Returns a list of resources and their category assignments. You may limit the number of results, provide sorting order, and filter by information such as resource type.

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

    Parameters

    Returns Promise<ListResourceCategoriesResponse>

    ListResourceCategoriesResponse

listRules

  • Returns a list of ingest time rules and scheduled tasks in a compartment. You may limit the number of items returned, provide sorting options, and filter the results.

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

    Parameters

    Returns Promise<ListRulesResponse>

    ListRulesResponse

listScheduledTasks

listSourceAssociations

  • Returns the list of entity associations in the input compartment for the specified source.

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

    Parameters

    Returns Promise<ListSourceAssociationsResponse>

    ListSourceAssociationsResponse

listSourceEventTypes

  • Lists the event types mapped to the source with the specified name. The event type string could be the fully qualified name or a prefix that matches the event type.

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

    Parameters

    Returns Promise<ListSourceEventTypesResponse>

    ListSourceEventTypesResponse

listSourceExtendedFieldDefinitions

listSourceLabelOperators

  • Lists the supported conditional operators that could be used for matching log field values to generate a label. You may use patterns to specify a condition. If a log entry matches that condition, it is tagged with the corresponding label.

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

    Parameters

    Returns Promise<ListSourceLabelOperatorsResponse>

    ListSourceLabelOperatorsResponse

listSourceMetaFunctions

  • Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields.

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

    Parameters

    Returns Promise<ListSourceMetaFunctionsResponse>

    ListSourceMetaFunctionsResponse

listSourcePatterns

  • Lists the source patterns for the source with the specified name.

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

    Parameters

    Returns Promise<ListSourcePatternsResponse>

    ListSourcePatternsResponse

listSources

  • Returns a list of sources, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as display name, description and entity type.

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

    Parameters

    Returns Promise<ListSourcesResponse>

    ListSourcesResponse

listStorageWorkRequestErrors

listStorageWorkRequests

  • This API lists storage work requests. Use query parameters to narrow down or sort the result list.

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

    Parameters

    Returns Promise<ListStorageWorkRequestsResponse>

    ListStorageWorkRequestsResponse

listSupportedCharEncodings

listSupportedTimezones

listUploadFiles

  • Gets list of files in an upload along with its processing state. 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 ListUploadFiles API.

    Parameters

    Returns Promise<ListUploadFilesResponse>

    ListUploadFilesResponse

listUploadWarnings

  • Gets list of warnings in an upload caused by incorrect configuration. 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 ListUploadWarnings API.

    Parameters

    Returns Promise<ListUploadWarningsResponse>

    ListUploadWarningsResponse

listUploads

  • Gets a list of all On-demand uploads. To use this and other API operations, you must be authorized in an IAM policy.

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

    Parameters

    Returns Promise<ListUploadsResponse>

    ListUploadsResponse

listWarnings

  • Returns a list of collection warnings, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as start time, end time, warning type, warning state, source name, source pattern and entity name.

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

    Parameters

    Returns Promise<ListWarningsResponse>

    ListWarningsResponse

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

offboardNamespace

onboardNamespace

parseQuery

  • Describe query 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 ParseQuery API.

    Parameters

    Returns Promise<ParseQueryResponse>

    ParseQueryResponse

pauseScheduledTask

  • Pause the scheduled task specified by {scheduledTaskId}.

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

    Parameters

    Returns Promise<PauseScheduledTaskResponse>

    PauseScheduledTaskResponse

purgeStorageData

  • This API submits a work request to purge data. Only data from log groups that the user has permission to delete will be purged. To purge all data, the user must have permission to all log groups.

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

    Parameters

    Returns Promise<PurgeStorageDataResponse>

    PurgeStorageDataResponse

putQueryWorkRequestBackground

  • Put the work request specified by {workRequestId} into the background. Backgrounded queries will preserve query results on query completion for up to 7 days for recall. After 7 days the results and query expire. 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 PutQueryWorkRequestBackground API.

    Parameters

    Returns Promise<PutQueryWorkRequestBackgroundResponse>

    PutQueryWorkRequestBackgroundResponse

query

  • Performs a log analytics search, if shouldRunAsync is false returns the query results once they become available subject to 60 second timeout. If a query is subject to exceed that time then it should be run asynchronously. Asynchronous query submissions return the queryWorkRequestId to use for execution tracking, query submission lifecycle actions and to poll for query results.

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

    Parameters

    Returns Promise<QueryResponse>

    QueryResponse

recallArchivedData

  • This API submits a work request to recall archived data based on time interval and data type.

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

    Parameters

    Returns Promise<RecallArchivedDataResponse>

    RecallArchivedDataResponse

registerLookup

  • Creates a lookup with the specified name, type and description. The csv file containing the lookup content is passed in as binary data in the 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 RegisterLookup API.

    Parameters

    Returns Promise<RegisterLookupResponse>

    RegisterLookupResponse

releaseRecalledData

removeEntityAssociations

  • Delete association between input source log analytics entity and destination entities. 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 RemoveEntityAssociations API.

    Parameters

    Returns Promise<RemoveEntityAssociationsResponse>

    RemoveEntityAssociationsResponse

removePreferences

  • Removes the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.

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

    Parameters

    Returns Promise<RemovePreferencesResponse>

    RemovePreferencesResponse

removeResourceCategories

removeSourceEventTypes

resumeScheduledTask

run

  • Execute the saved search acceleration task in the foreground. The ScheduledTask taskType must be ACCELERATION. Optionally specify time range (timeStart and timeEnd). The default is all time.

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

    Parameters

    Returns Promise<RunResponse>

    RunResponse

setUnprocessedDataBucket

  • This API configures a bucket to store unprocessed payloads. While processing there could be reasons a payload cannot be processed (mismatched structure, corrupted archive format, etc), if configured the payload would be uploaded to the bucket for verification.

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

    Parameters

    Returns Promise<SetUnprocessedDataBucketResponse>

    SetUnprocessedDataBucketResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

suggest

  • Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable. 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 Suggest API.

    Parameters

    Returns Promise<SuggestResponse>

    SuggestResponse

suppressWarning

  • Supresses a list of warnings. Any unsuppressed warnings in the input list would be suppressed. Warnings in the input list which are already suppressed will not be modified.

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

    Parameters

    Returns Promise<SuppressWarningResponse>

    SuppressWarningResponse

testParser

  • Tests the parser definition against the specified example content to ensure fields are successfully extracted.

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

    Parameters

    Returns Promise<TestParserResponse>

    TestParserResponse

unsuppressWarning

  • Unsupresses a list of warnings. Any suppressed warnings in the input list would be unsuppressed. Warnings in the input list which are already unsuppressed will not be modified.

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

    Parameters

    Returns Promise<UnsuppressWarningResponse>

    UnsuppressWarningResponse

updateIngestTimeRule

  • Updates the specified ingest time rule's description, defined tags, and free-form tags.

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

    Parameters

    Returns Promise<UpdateIngestTimeRuleResponse>

    UpdateIngestTimeRuleResponse

updateLogAnalyticsEmBridge

updateLogAnalyticsEntity

updateLogAnalyticsEntityType

updateLogAnalyticsLogGroup

  • Updates the specified log group's display name, description, defined tags, and free-form tags.

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

    Parameters

    Returns Promise<UpdateLogAnalyticsLogGroupResponse>

    UpdateLogAnalyticsLogGroupResponse

updateLogAnalyticsObjectCollectionRule

updateLookup

  • Updates the metadata of the specified lookup, such as the lookup description.

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

    Parameters

    Returns Promise<UpdateLookupResponse>

    UpdateLookupResponse

updateLookupData

  • Updates the lookup content. The csv file containing the content to be updated is passed in as binary data in the 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 UpdateLookupData API.

    Parameters

    Returns Promise<UpdateLookupDataResponse>

    UpdateLookupDataResponse

updatePreferences

  • Updates the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.

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

    Parameters

    Returns Promise<UpdatePreferencesResponse>

    UpdatePreferencesResponse

updateResourceCategories

updateScheduledTask

  • Update the scheduled task. Schedules may be updated only for taskType SAVED_SEARCH and PURGE. 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 UpdateScheduledTask API.

    Parameters

    Returns Promise<UpdateScheduledTaskResponse>

    UpdateScheduledTaskResponse

updateStorage

  • This API updates the archiving configuration

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

    Parameters

    Returns Promise<UpdateStorageResponse>

    UpdateStorageResponse

uploadDiscoveryData

  • Accepts discovery data for processing by Logging Analytics.

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

    Parameters

    Returns Promise<UploadDiscoveryDataResponse>

    UploadDiscoveryDataResponse

uploadLogEventsFile

uploadLogFile

  • Accepts log data for processing by Logging Analytics.

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

    Parameters

    Returns Promise<UploadLogFileResponse>

    UploadLogFileResponse

upsertAssociations

  • Creates or updates associations between sources and entities. All entities should belong to the specified input 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 UpsertAssociations API.

    Parameters

    Returns Promise<UpsertAssociationsResponse>

    UpsertAssociationsResponse

upsertField

  • Creates or updates a field that could be used in parser expressions to extract and assign value. To create a field, specify its display name. A name would be generated for the field. For subsequent calls to update the field, include the name attribute.

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

    Parameters

    Returns Promise<UpsertFieldResponse>

    UpsertFieldResponse

upsertLabel

  • Creates or updates a label that could be used to tag a log entry. You may optionally designate the label as a problem, and assign it a priority. You may also provide its related terms (aliases). To create a label, specify its display name. A name would be generated for the label. For subsequent calls to update the label, include the name attribute.

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

    Parameters

    Returns Promise<UpsertLabelResponse>

    UpsertLabelResponse

upsertParser

  • Creates or updates a parser, which defines how fields are extracted from a log entry.

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

    Parameters

    Returns Promise<UpsertParserResponse>

    UpsertParserResponse

upsertSource

  • Creates or updates a log source. You may also specify parsers, labels, extended fields etc., for the source.

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

    Parameters

    Returns Promise<UpsertSourceResponse>

    UpsertSourceResponse

validateAssociationParameters

  • Checks if the passed in entities could be associated with the specified sources. The validation is performed to ensure that the entities have the relevant property values that are used in the corresponding source patterns.

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

    Parameters

    Returns Promise<ValidateAssociationParametersResponse>

    ValidateAssociationParametersResponse

validateEndpoint

validateFile

  • Validates a log file to check whether it is eligible to be uploaded or not. 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 ValidateFile API.

    Parameters

    Returns Promise<ValidateFileResponse>

    ValidateFileResponse

validateLabelCondition

  • Validates specified condition for a source label. If both conditionString and conditionBlocks are specified, they would be validated to ensure they represent identical conditions. If one of them is input, the response would include the validated representation of the other structure too. Additionally, if field values are passed, the condition specification would be evaluated against them.

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

    Parameters

    Returns Promise<ValidateLabelConditionResponse>

    ValidateLabelConditionResponse

validateSource

  • Checks if the specified input is a valid log source definition.

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

    Parameters

    Returns Promise<ValidateSourceResponse>

    ValidateSourceResponse

validateSourceExtendedFieldDetails

validateSourceMapping

  • Validates the source mapping for a given file and provides match status and the parsed representation of log data. 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 ValidateSourceMapping API.

    Parameters

    Returns Promise<ValidateSourceMappingResponse>

    ValidateSourceMappingResponse

verify

  • Verify the accelerated saved search task specified by {scheduledTaskId}. For internal use only. Optionally specify whether to return accelerated search results; the default is false. The ScheduledTask taskType must be ACCELERATION.

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

    Parameters

    Returns Promise<VerifyResponse>

    VerifyResponse