@Generated(value="OracleSDKGenerator", comments="API Version: 20200601") public interface LogAnalytics extends AutoCloseable
The LogAnalytics API for the LogAnalytics service.
closevoid setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint - The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(com.oracle.bmc.Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region - The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint.
regionId - The public region ID.AddEntityAssociationResponse addEntityAssociation(AddEntityAssociationRequest request)
Adds association between input source log analytics entity and one or more existing destination entities.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use AddEntityAssociation API.
AppendLookupDataResponse appendLookupData(AppendLookupDataRequest request)
Append data to a lookup. The file containing the information to append must be provided.
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is
necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this
operation is called}.
Note this means that if the caller has used InputStream.mark(int) before, then the mark
will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by
the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation
was called.
If the stream is a FileInputStream, and the stream’s FileChannel position
can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide
support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as
above is followed. If the stream’s FileChannel position cannot be changed (like for a
named pipe), then the stream’s contents will be buffered in memory, as described below.
If the stream does not support InputStream.mark(int) and InputStream.reset(), then
the stream is wrapped in a BufferedInputStream, which means the entire contents may
be buffered in memory. Then the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream whose
FileChannel position can be changed, should be less than 2 GiB in size if retries are used.
This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream
is larger, do not use built-in retries and manage retries yourself.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use AppendLookupData API.
BatchGetBasicInfoResponse batchGetBasicInfo(BatchGetBasicInfoRequest request)
get basic information about a specified set of labels
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use BatchGetBasicInfo API.
CancelQueryWorkRequestResponse cancelQueryWorkRequest(CancelQueryWorkRequestRequest request)
Cancel/Remove query job work request.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use CancelQueryWorkRequest API.
ChangeLogAnalyticsEntityCompartmentResponse changeLogAnalyticsEntityCompartment(ChangeLogAnalyticsEntityCompartmentRequest request)
Update the compartment of the log analytics entity with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ChangeLogAnalyticsEntityCompartment API.
ChangeLogAnalyticsLogGroupCompartmentResponse changeLogAnalyticsLogGroupCompartment(ChangeLogAnalyticsLogGroupCompartmentRequest request)
Updates the compartment of the Log-Analytics group with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ChangeLogAnalyticsLogGroupCompartment API.
ChangeLogAnalyticsObjectCollectionRuleCompartmentResponse changeLogAnalyticsObjectCollectionRuleCompartment(ChangeLogAnalyticsObjectCollectionRuleCompartmentRequest request)
Move the rule from it’s current compartment to the given compartment.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ChangeLogAnalyticsObjectCollectionRuleCompartment API.
ChangeScheduledTaskCompartmentResponse changeScheduledTaskCompartment(ChangeScheduledTaskCompartmentRequest request)
Move the scheduled task into a different compartment within the same tenancy.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ChangeScheduledTaskCompartment API.
CleanResponse clean(CleanRequest request)
Clean accumulated acceleration data stored for the accelerated saved search. The ScheduledTask taskType must be ACCELERATION.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use Clean API.
CreateLogAnalyticsEntityResponse createLogAnalyticsEntity(CreateLogAnalyticsEntityRequest request)
Create a new log analytics entity.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use CreateLogAnalyticsEntity API.
CreateLogAnalyticsEntityTypeResponse createLogAnalyticsEntityType(CreateLogAnalyticsEntityTypeRequest request)
Add custom log analytics entity type.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use CreateLogAnalyticsEntityType API.
CreateLogAnalyticsLogGroupResponse createLogAnalyticsLogGroup(CreateLogAnalyticsLogGroupRequest request)
Creates a new Log-Analytics group.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use CreateLogAnalyticsLogGroup API.
CreateLogAnalyticsObjectCollectionRuleResponse createLogAnalyticsObjectCollectionRule(CreateLogAnalyticsObjectCollectionRuleRequest request)
Creates a rule to collect logs from an object storage bucket.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use CreateLogAnalyticsObjectCollectionRule API.
CreateScheduledTaskResponse createScheduledTask(CreateScheduledTaskRequest request)
Schedule a task as specified and return task info.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use CreateScheduledTask API.
DeleteAssociationsResponse deleteAssociations(DeleteAssociationsRequest request)
delete associations
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteAssociations API.
DeleteFieldResponse deleteField(DeleteFieldRequest request)
delete field with specified name
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteField API.
DeleteLabelResponse deleteLabel(DeleteLabelRequest request)
delete a label
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteLabel API.
DeleteLogAnalyticsEntityResponse deleteLogAnalyticsEntity(DeleteLogAnalyticsEntityRequest request)
Delete log analytics entity with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteLogAnalyticsEntity API.
DeleteLogAnalyticsEntityTypeResponse deleteLogAnalyticsEntityType(DeleteLogAnalyticsEntityTypeRequest request)
Delete log analytics entity type with the given name.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteLogAnalyticsEntityType API.
DeleteLogAnalyticsLogGroupResponse deleteLogAnalyticsLogGroup(DeleteLogAnalyticsLogGroupRequest request)
Deletes the Log-Analytics group with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteLogAnalyticsLogGroup API.
DeleteLogAnalyticsObjectCollectionRuleResponse deleteLogAnalyticsObjectCollectionRule(DeleteLogAnalyticsObjectCollectionRuleRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteLogAnalyticsObjectCollectionRule API.
DeleteLookupResponse deleteLookup(DeleteLookupRequest request)
Delete the specified lookup.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteLookup API.
DeleteParserResponse deleteParser(DeleteParserRequest request)
delete parser with specified name
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteParser API.
DeleteScheduledTaskResponse deleteScheduledTask(DeleteScheduledTaskRequest request)
Delete the scheduled task.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteScheduledTask API.
DeleteSourceResponse deleteSource(DeleteSourceRequest request)
delete source with specified ID
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteSource API.
DeleteUploadResponse deleteUpload(DeleteUploadRequest request)
Deletes an Upload by its reference. It deletes all the logs in storage asscoiated with the upload and the corresponding upload metadata.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteUpload API.
DeleteUploadFileResponse deleteUploadFile(DeleteUploadFileRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteUploadFile API.
DeleteUploadWarningResponse deleteUploadWarning(DeleteUploadWarningRequest request)
Suppresses a specific warning inside an upload.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DeleteUploadWarning API.
DisableArchivingResponse disableArchiving(DisableArchivingRequest request)
This API disables archiving.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use DisableArchiving API.
EnableArchivingResponse enableArchiving(EnableArchivingRequest request)
THis API enables archiving.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use EnableArchiving API.
EstimatePurgeDataSizeResponse estimatePurgeDataSize(EstimatePurgeDataSizeRequest request)
This API estimates the size of data to be purged based based on time interval, purge query etc.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use EstimatePurgeDataSize API.
EstimateRecallDataSizeResponse estimateRecallDataSize(EstimateRecallDataSizeRequest request)
This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use EstimateRecallDataSize API.
EstimateReleaseDataSizeResponse estimateReleaseDataSize(EstimateReleaseDataSizeRequest request)
This API gives an active storage usage estimate for recalled data to be released and the time range of such data.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use EstimateReleaseDataSize API.
ExportCustomContentResponse exportCustomContent(ExportCustomContentRequest request)
export
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ExportCustomContent API.
ExportQueryResultResponse exportQueryResult(ExportQueryResultRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ExportQueryResult API.
ExtractStructuredLogFieldPathsResponse extractStructuredLogFieldPaths(ExtractStructuredLogFieldPathsRequest request)
structured log fieldpaths
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ExtractStructuredLogFieldPaths API.
ExtractStructuredLogHeaderPathsResponse extractStructuredLogHeaderPaths(ExtractStructuredLogHeaderPathsRequest request)
structured log header paths
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ExtractStructuredLogHeaderPaths API.
FilterResponse filter(FilterRequest request)
Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use Filter API.
GetAssociationSummaryResponse getAssociationSummary(GetAssociationSummaryRequest request)
association summary
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetAssociationSummary API.
GetColumnNamesResponse getColumnNames(GetColumnNamesRequest request)
extract column names from SQL query
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetColumnNames API.
GetConfigWorkRequestResponse getConfigWorkRequest(GetConfigWorkRequestRequest request)
association summary by source
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetConfigWorkRequest API.
GetFieldResponse getField(GetFieldRequest request)
get common field with specified name
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetField API.
GetFieldsSummaryResponse getFieldsSummary(GetFieldsSummaryRequest request)
get field summary
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetFieldsSummary API.
GetLabelResponse getLabel(GetLabelRequest request)
get label with specified name
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLabel API.
GetLabelSummaryResponse getLabelSummary(GetLabelSummaryRequest request)
get total count
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLabelSummary API.
GetLogAnalyticsEntitiesSummaryResponse getLogAnalyticsEntitiesSummary(GetLogAnalyticsEntitiesSummaryRequest request)
Returns log analytics entities count summary report.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLogAnalyticsEntitiesSummary API.
GetLogAnalyticsEntityResponse getLogAnalyticsEntity(GetLogAnalyticsEntityRequest request)
Retrieve the log analytics entity with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLogAnalyticsEntity API.
GetLogAnalyticsEntityTypeResponse getLogAnalyticsEntityType(GetLogAnalyticsEntityTypeRequest request)
Retrieve the log analytics entity type with the given name.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLogAnalyticsEntityType API.
GetLogAnalyticsLogGroupResponse getLogAnalyticsLogGroup(GetLogAnalyticsLogGroupRequest request)
Retrieves the Log-Analytics group with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLogAnalyticsLogGroup API.
GetLogAnalyticsLogGroupsSummaryResponse getLogAnalyticsLogGroupsSummary(GetLogAnalyticsLogGroupsSummaryRequest request)
Returns a count of Log-Analytics groups.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLogAnalyticsLogGroupsSummary API.
GetLogAnalyticsObjectCollectionRuleResponse getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleRequest request)
Gets a configured object storage based collection rule by given id
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLogAnalyticsObjectCollectionRule API.
GetLookupResponse getLookup(GetLookupRequest request)
Obtains the lookup with the specified reference.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetLookup API.
GetNamespaceResponse getNamespace(GetNamespaceRequest request)
This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetNamespace API.
GetParserResponse getParser(GetParserRequest request)
get parser with fields by Name
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetParser API.
GetParserSummaryResponse getParserSummary(GetParserSummaryRequest request)
parser summary
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetParserSummary API.
GetQueryResultResponse getQueryResult(GetQueryResultRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetQueryResult API.
GetQueryWorkRequestResponse getQueryWorkRequest(GetQueryWorkRequestRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetQueryWorkRequest API.
GetScheduledTaskResponse getScheduledTask(GetScheduledTaskRequest request)
Get the scheduled task for the specified task identifier.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetScheduledTask API.
GetSourceResponse getSource(GetSourceRequest request)
get source with specified name
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetSource API.
GetSourceSummaryResponse getSourceSummary(GetSourceSummaryRequest request)
source summary
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetSourceSummary API.
GetStorageResponse getStorage(GetStorageRequest request)
This API gets the storage configuration of a tenancy
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetStorage API.
GetStorageUsageResponse getStorageUsage(GetStorageUsageRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetStorageUsage API.
GetStorageWorkRequestResponse getStorageWorkRequest(GetStorageWorkRequestRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetStorageWorkRequest API.
GetUploadResponse getUpload(GetUploadRequest request)
Gets an On-Demand Upload info by reference.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetUpload API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use GetWorkRequest API.
ImportCustomContentResponse importCustomContent(ImportCustomContentRequest request)
register custom content
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is
necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this
operation is called}.
Note this means that if the caller has used InputStream.mark(int) before, then the mark
will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by
the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation
was called.
If the stream is a FileInputStream, and the stream’s FileChannel position
can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide
support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as
above is followed. If the stream’s FileChannel position cannot be changed (like for a
named pipe), then the stream’s contents will be buffered in memory, as described below.
If the stream does not support InputStream.mark(int) and InputStream.reset(), then
the stream is wrapped in a BufferedInputStream, which means the entire contents may
be buffered in memory. Then the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream whose
FileChannel position can be changed, should be less than 2 GiB in size if retries are used.
This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream
is larger, do not use built-in retries and manage retries yourself.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ImportCustomContent API.
ListAssociatedEntitiesResponse listAssociatedEntities(ListAssociatedEntitiesRequest request)
list of entities that have been associated to at least one source
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListAssociatedEntities API.
ListConfigWorkRequestsResponse listConfigWorkRequests(ListConfigWorkRequestsRequest request)
association summary by source
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListConfigWorkRequests API.
ListEntityAssociationsResponse listEntityAssociations(ListEntityAssociationsRequest request)
Return a list of log analytics entities associated with input source log analytics entity.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListEntityAssociations API.
ListEntitySourceAssociationsResponse listEntitySourceAssociations(ListEntitySourceAssociationsRequest request)
entity associations summary
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListEntitySourceAssociations API.
ListFieldsResponse listFields(ListFieldsRequest request)
get all common field with specified display name and description
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListFields API.
ListLabelPrioritiesResponse listLabelPriorities(ListLabelPrioritiesRequest request)
get list of priorities
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLabelPriorities API.
ListLabelSourceDetailsResponse listLabelSourceDetails(ListLabelSourceDetailsRequest request)
get details of sources using the label
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLabelSourceDetails API.
ListLabelsResponse listLabels(ListLabelsRequest request)
get labels passing specified filter
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLabels API.
ListLogAnalyticsEntitiesResponse listLogAnalyticsEntities(ListLogAnalyticsEntitiesRequest request)
Return a list of log analytics entities.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLogAnalyticsEntities API.
ListLogAnalyticsEntityTypesResponse listLogAnalyticsEntityTypes(ListLogAnalyticsEntityTypesRequest request)
Return a list of log analytics entity types.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLogAnalyticsEntityTypes API.
ListLogAnalyticsLogGroupsResponse listLogAnalyticsLogGroups(ListLogAnalyticsLogGroupsRequest request)
Returns a list of Log-Analytics groups.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLogAnalyticsLogGroups API.
ListLogAnalyticsObjectCollectionRulesResponse listLogAnalyticsObjectCollectionRules(ListLogAnalyticsObjectCollectionRulesRequest request)
Gets list of collection rules.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLogAnalyticsObjectCollectionRules API.
ListLookupsResponse listLookups(ListLookupsRequest request)
Obtains a list of lookups. The list is filtered according to the filter criteria specified by the user, and sorted according to the ordering criteria specified.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListLookups API.
ListMetaSourceTypesResponse listMetaSourceTypes(ListMetaSourceTypesRequest request)
get all meta source types
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListMetaSourceTypes API.
ListNamespacesResponse listNamespaces(ListNamespacesRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListNamespaces API.
ListParserFunctionsResponse listParserFunctions(ListParserFunctionsRequest request)
get pre-process plugin instance
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListParserFunctions API.
ListParserMetaPluginsResponse listParserMetaPlugins(ListParserMetaPluginsRequest request)
get pre-process Meta plugins
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListParserMetaPlugins API.
ListParsersResponse listParsers(ListParsersRequest request)
List parsers passing specified filter
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListParsers API.
ListQueryWorkRequestsResponse listQueryWorkRequests(ListQueryWorkRequestsRequest request)
List active asynchronous queries.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListQueryWorkRequests API.
ListRecalledDataResponse listRecalledData(ListRecalledDataRequest request)
This API returns the list of recalled data of a tenancy.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListRecalledData API.
ListScheduledTasksResponse listScheduledTasks(ListScheduledTasksRequest request)
Lists scheduled tasks.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListScheduledTasks API.
ListSourceAssociationsResponse listSourceAssociations(ListSourceAssociationsRequest request)
association summary by source
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSourceAssociations API.
ListSourceExtendedFieldDefinitionsResponse listSourceExtendedFieldDefinitions(ListSourceExtendedFieldDefinitionsRequest request)
get source extended fields for source with specified Id
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSourceExtendedFieldDefinitions API.
ListSourceLabelOperatorsResponse listSourceLabelOperators(ListSourceLabelOperatorsRequest request)
list source label operators
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSourceLabelOperators API.
ListSourceMetaFunctionsResponse listSourceMetaFunctions(ListSourceMetaFunctionsRequest request)
get source meta functions
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSourceMetaFunctions API.
ListSourcePatternsResponse listSourcePatterns(ListSourcePatternsRequest request)
get source patterns for source with specified Id
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSourcePatterns API.
ListSourcesResponse listSources(ListSourcesRequest request)
source list
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSources API.
ListStorageWorkRequestErrorsResponse listStorageWorkRequestErrors(ListStorageWorkRequestErrorsRequest request)
This API returns the list of work request errors if any.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListStorageWorkRequestErrors API.
ListStorageWorkRequestsResponse listStorageWorkRequests(ListStorageWorkRequestsRequest request)
This API lists storage work requests. Use query parameters to narrow down or sort the result list.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListStorageWorkRequests API.
ListSupportedCharEncodingsResponse listSupportedCharEncodings(ListSupportedCharEncodingsRequest request)
Gets list of character encodings which are supported by on-demand upload.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSupportedCharEncodings API.
ListSupportedTimezonesResponse listSupportedTimezones(ListSupportedTimezonesRequest request)
Gets list of timezones which are supported by on-demand upload.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListSupportedTimezones API.
ListUploadFilesResponse listUploadFiles(ListUploadFilesRequest request)
Gets list of files in an upload along with its processing state.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListUploadFiles API.
ListUploadWarningsResponse listUploadWarnings(ListUploadWarningsRequest request)
Gets list of warnings in an upload caused by incorrect configuration.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListUploadWarnings API.
ListUploadsResponse listUploads(ListUploadsRequest request)
Gets a list of all On-demand uploads. To use this and other API operations, you must be authorized in an IAM policy.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListUploads API.
ListWarningsResponse listWarnings(ListWarningsRequest request)
Obtains a list of warnings. The list is filtered according to the filter criteria specified by the user, and sorted according to the ordering criteria specified.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListWarnings API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ListWorkRequests API.
OffboardNamespaceResponse offboardNamespace(OffboardNamespaceRequest request)
Off-boards a tenant from Logging Analytics
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use OffboardNamespace API.
OnboardNamespaceResponse onboardNamespace(OnboardNamespaceRequest request)
On-boards a tenant to Logging Analytics.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use OnboardNamespace API.
ParseQueryResponse parseQuery(ParseQueryRequest request)
Describe query
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ParseQuery API.
PauseScheduledTaskResponse pauseScheduledTask(PauseScheduledTaskRequest request)
Pause the scheduled task specified by {scheduledTaskId}.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use PauseScheduledTask API.
PurgeStorageDataResponse purgeStorageData(PurgeStorageDataRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use PurgeStorageData API.
PutQueryWorkRequestBackgroundResponse putQueryWorkRequestBackground(PutQueryWorkRequestBackgroundRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use PutQueryWorkRequestBackground API.
QueryResponse query(QueryRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use Query API.
RecallArchivedDataResponse recallArchivedData(RecallArchivedDataRequest request)
This API submits a work request to recall archived data based on time interval and data type.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use RecallArchivedData API.
RegisterLookupResponse registerLookup(RegisterLookupRequest request)
register lookup
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is
necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this
operation is called}.
Note this means that if the caller has used InputStream.mark(int) before, then the mark
will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by
the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation
was called.
If the stream is a FileInputStream, and the stream’s FileChannel position
can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide
support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as
above is followed. If the stream’s FileChannel position cannot be changed (like for a
named pipe), then the stream’s contents will be buffered in memory, as described below.
If the stream does not support InputStream.mark(int) and InputStream.reset(), then
the stream is wrapped in a BufferedInputStream, which means the entire contents may
be buffered in memory. Then the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream whose
FileChannel position can be changed, should be less than 2 GiB in size if retries are used.
This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream
is larger, do not use built-in retries and manage retries yourself.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use RegisterLookup API.
ReleaseRecalledDataResponse releaseRecalledData(ReleaseRecalledDataRequest request)
This API submits a work request to release recalled data based on time interval and data type.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ReleaseRecalledData API.
RemoveEntityAssociationsResponse removeEntityAssociations(RemoveEntityAssociationsRequest request)
Delete association between input source log analytics entity and destination entities.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use RemoveEntityAssociations API.
ResumeScheduledTaskResponse resumeScheduledTask(ResumeScheduledTaskRequest request)
Resume the scheduled task specified by {scheduledTaskId}.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ResumeScheduledTask API.
RunResponse run(RunRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use Run API.
SuggestResponse suggest(SuggestRequest request)
Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use Suggest API.
SuppressWarningResponse suppressWarning(SuppressWarningRequest request)
Accepts a list of warnings. Any unsuppressed warnings in the input list will be suppressed. Warnings in the input list which are already suppressed will not be modified.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use SuppressWarning API.
TestParserResponse testParser(TestParserRequest request)
test parser
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use TestParser API.
UnsuppressWarningResponse unsuppressWarning(UnsuppressWarningRequest request)
Accepts a list of warnings. Any suppressed warnings in the input list will be unsuppressed. Warnings in the input list which are unsuppressed will not be modified.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UnsuppressWarning API.
UpdateLogAnalyticsEntityResponse updateLogAnalyticsEntity(UpdateLogAnalyticsEntityRequest request)
Update the log analytics entity with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateLogAnalyticsEntity API.
UpdateLogAnalyticsEntityTypeResponse updateLogAnalyticsEntityType(UpdateLogAnalyticsEntityTypeRequest request)
Update custom log analytics entity type. Out of box entity types cannot be udpated.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateLogAnalyticsEntityType API.
UpdateLogAnalyticsLogGroupResponse updateLogAnalyticsLogGroup(UpdateLogAnalyticsLogGroupRequest request)
Updates the Log-Analytics group with the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateLogAnalyticsLogGroup API.
UpdateLogAnalyticsObjectCollectionRuleResponse updateLogAnalyticsObjectCollectionRule(UpdateLogAnalyticsObjectCollectionRuleRequest request)
Updates configuration of the object collection rule for the given id.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateLogAnalyticsObjectCollectionRule API.
UpdateLookupResponse updateLookup(UpdateLookupRequest request)
Updates the metadata of the specified lookup, such as the lookup description.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateLookup API.
UpdateLookupDataResponse updateLookupData(UpdateLookupDataRequest request)
Updates the specified lookup with the details provided. This API will not update lookup metadata (such as lookup description).
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is
necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this
operation is called}.
Note this means that if the caller has used InputStream.mark(int) before, then the mark
will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by
the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation
was called.
If the stream is a FileInputStream, and the stream’s FileChannel position
can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide
support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as
above is followed. If the stream’s FileChannel position cannot be changed (like for a
named pipe), then the stream’s contents will be buffered in memory, as described below.
If the stream does not support InputStream.mark(int) and InputStream.reset(), then
the stream is wrapped in a BufferedInputStream, which means the entire contents may
be buffered in memory. Then the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream whose
FileChannel position can be changed, should be less than 2 GiB in size if retries are used.
This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream
is larger, do not use built-in retries and manage retries yourself.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateLookupData API.
UpdateScheduledTaskResponse updateScheduledTask(UpdateScheduledTaskRequest request)
Update the scheduled task. Schedules may be updated only for taskType SAVED_SEARCH and PURGE.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateScheduledTask API.
UpdateStorageResponse updateStorage(UpdateStorageRequest request)
This API updates the archiving configuration
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpdateStorage API.
UploadLogFileResponse uploadLogFile(UploadLogFileRequest request)
Accepts log data for processing by Logging Analytics.
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is
necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this
operation is called}.
Note this means that if the caller has used InputStream.mark(int) before, then the mark
will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by
the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation
was called.
If the stream is a FileInputStream, and the stream’s FileChannel position
can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide
support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as
above is followed. If the stream’s FileChannel position cannot be changed (like for a
named pipe), then the stream’s contents will be buffered in memory, as described below.
If the stream does not support InputStream.mark(int) and InputStream.reset(), then
the stream is wrapped in a BufferedInputStream, which means the entire contents may
be buffered in memory. Then the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream whose
FileChannel position can be changed, should be less than 2 GiB in size if retries are used.
This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream
is larger, do not use built-in retries and manage retries yourself.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UploadLogFile API.
UpsertAssociationsResponse upsertAssociations(UpsertAssociationsRequest request)
create or update associations for a source
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpsertAssociations API.
UpsertFieldResponse upsertField(UpsertFieldRequest request)
Defines or update a field.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpsertField API.
UpsertLabelResponse upsertLabel(UpsertLabelRequest request)
Define or update a label.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpsertLabel API.
UpsertParserResponse upsertParser(UpsertParserRequest request)
Define or update parser
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpsertParser API.
UpsertSourceResponse upsertSource(UpsertSourceRequest request)
Define or update a source
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use UpsertSource API.
ValidateAssociationParametersResponse validateAssociationParameters(ValidateAssociationParametersRequest request)
association parameter validation
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ValidateAssociationParameters API.
ValidateFileResponse validateFile(ValidateFileRequest request)
Validates a log file to check whether it is eligible to be uploaded or not.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ValidateFile API.
ValidateSourceResponse validateSource(ValidateSourceRequest request)
Pre-define or update a source
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ValidateSource API.
ValidateSourceExtendedFieldDetailsResponse validateSourceExtendedFieldDetails(ValidateSourceExtendedFieldDetailsRequest request)
test extended fields
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ValidateSourceExtendedFieldDetails API.
ValidateSourceMappingResponse validateSourceMapping(ValidateSourceMappingRequest request)
Validates the source mapping for a given file and provides match status and the parsed representation of log data.
request - The request object containing the details to sendBmcException - when an error occurs.
Example: Click here to see how to use ValidateSourceMapping API.
LogAnalyticsWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
LogAnalyticsPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2021. All rights reserved.