@Generated(value="OracleSDKGenerator", comments="API Version: 20200601") public interface LogAnalytics extends AutoCloseable
The LogAnalytics API for the LogAnalytics service.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
AddEntityAssociationResponse |
addEntityAssociation(AddEntityAssociationRequest request)
Adds association between input source log analytics entity and one or more existing
destination entities.
|
AddSourceEventTypesResponse |
addSourceEventTypes(AddSourceEventTypesRequest request)
Add one or more event types to a source.
|
AppendLookupDataResponse |
appendLookupData(AppendLookupDataRequest request)
Appends data to the lookup content.
|
AssignEncryptionKeyResponse |
assignEncryptionKey(AssignEncryptionKeyRequest request)
This API submits a work request to assign customer encryption key.
|
BatchGetBasicInfoResponse |
batchGetBasicInfo(BatchGetBasicInfoRequest request)
Lists basic information about a specified set of labels in batch.
|
CancelQueryWorkRequestResponse |
cancelQueryWorkRequest(CancelQueryWorkRequestRequest request)
Cancel/Remove query job work request.
|
ChangeIngestTimeRuleCompartmentResponse |
changeIngestTimeRuleCompartment(ChangeIngestTimeRuleCompartmentRequest request)
Moves the specified ingest time rule to a different compartment.
|
ChangeLogAnalyticsEmBridgeCompartmentResponse |
changeLogAnalyticsEmBridgeCompartment(ChangeLogAnalyticsEmBridgeCompartmentRequest request)
Update the compartment of the log analytics enterprise manager bridge with the given id.
|
ChangeLogAnalyticsEntityCompartmentResponse |
changeLogAnalyticsEntityCompartment(ChangeLogAnalyticsEntityCompartmentRequest request)
Update the compartment of the log analytics entity with the given id.
|
ChangeLogAnalyticsLogGroupCompartmentResponse |
changeLogAnalyticsLogGroupCompartment(ChangeLogAnalyticsLogGroupCompartmentRequest request)
Moves the specified log group to a different compartment.
|
ChangeLogAnalyticsObjectCollectionRuleCompartmentResponse |
changeLogAnalyticsObjectCollectionRuleCompartment(ChangeLogAnalyticsObjectCollectionRuleCompartmentRequest request)
Move the rule from it’s current compartment to the given compartment.
|
ChangeScheduledTaskCompartmentResponse |
changeScheduledTaskCompartment(ChangeScheduledTaskCompartmentRequest request)
Move the scheduled task into a different compartment within the same tenancy.
|
CleanResponse |
clean(CleanRequest request)
Clean accumulated acceleration data stored for the accelerated saved search.
|
CompareContentResponse |
compareContent(CompareContentRequest request)
Returns the difference between the two input payloads, including intraline differences.
|
CreateIngestTimeRuleResponse |
createIngestTimeRule(CreateIngestTimeRuleRequest request)
Creates a new ingest time rule in the specified compartment.
|
CreateLogAnalyticsEmBridgeResponse |
createLogAnalyticsEmBridge(CreateLogAnalyticsEmBridgeRequest request)
Add configuration for enterprise manager bridge.
|
CreateLogAnalyticsEntityResponse |
createLogAnalyticsEntity(CreateLogAnalyticsEntityRequest request)
Create a new log analytics entity.
|
CreateLogAnalyticsEntityTypeResponse |
createLogAnalyticsEntityType(CreateLogAnalyticsEntityTypeRequest request)
Add custom log analytics entity type.
|
CreateLogAnalyticsLogGroupResponse |
createLogAnalyticsLogGroup(CreateLogAnalyticsLogGroupRequest request)
Creates a new log group in the specified compartment with the input display name.
|
CreateLogAnalyticsObjectCollectionRuleResponse |
createLogAnalyticsObjectCollectionRule(CreateLogAnalyticsObjectCollectionRuleRequest request)
Creates a rule to collect logs from an object storage bucket.
|
CreateScheduledTaskResponse |
createScheduledTask(CreateScheduledTaskRequest request)
Schedule a task as specified and return task info.
|
DeleteAssociationsResponse |
deleteAssociations(DeleteAssociationsRequest request)
Deletes the associations between the sources and entities specified.
|
DeleteFieldResponse |
deleteField(DeleteFieldRequest request)
Deletes field with the specified name.
|
DeleteIngestTimeRuleResponse |
deleteIngestTimeRule(DeleteIngestTimeRuleRequest request)
Deletes the specified ingest time rule.
|
DeleteLabelResponse |
deleteLabel(DeleteLabelRequest request)
Deletes label with the specified name.
|
DeleteLogAnalyticsEmBridgeResponse |
deleteLogAnalyticsEmBridge(DeleteLogAnalyticsEmBridgeRequest request)
Delete log analytics enterprise manager bridge with the given id.
|
DeleteLogAnalyticsEntityResponse |
deleteLogAnalyticsEntity(DeleteLogAnalyticsEntityRequest request)
Delete log analytics entity with the given id.
|
DeleteLogAnalyticsEntityTypeResponse |
deleteLogAnalyticsEntityType(DeleteLogAnalyticsEntityTypeRequest request)
Delete log analytics entity type with the given name.
|
DeleteLogAnalyticsLogGroupResponse |
deleteLogAnalyticsLogGroup(DeleteLogAnalyticsLogGroupRequest request)
Deletes the specified log group.
|
DeleteLogAnalyticsObjectCollectionRuleResponse |
deleteLogAnalyticsObjectCollectionRule(DeleteLogAnalyticsObjectCollectionRuleRequest request)
Deletes the configured object storage bucket based collection rule and stop the log
collection.
|
DeleteLookupResponse |
deleteLookup(DeleteLookupRequest request)
Deletes lookup with the specified name.
|
DeleteParserResponse |
deleteParser(DeleteParserRequest request)
Deletes parser with the specified name.
|
DeleteScheduledTaskResponse |
deleteScheduledTask(DeleteScheduledTaskRequest request)
Delete the scheduled task.
|
DeleteSourceResponse |
deleteSource(DeleteSourceRequest request)
Deletes source with the specified name.
|
DeleteUploadResponse |
deleteUpload(DeleteUploadRequest request)
Deletes an Upload by its reference.
|
DeleteUploadFileResponse |
deleteUploadFile(DeleteUploadFileRequest request)
Deletes a specific log file inside an upload by upload file reference.
|
DeleteUploadWarningResponse |
deleteUploadWarning(DeleteUploadWarningRequest request)
Suppresses a specific warning inside an upload.
|
DisableArchivingResponse |
disableArchiving(DisableArchivingRequest request)
This API disables archiving.
|
DisableAutoAssociationResponse |
disableAutoAssociation(DisableAutoAssociationRequest request)
Disables auto association for a log source.
|
DisableIngestTimeRuleResponse |
disableIngestTimeRule(DisableIngestTimeRuleRequest request)
Disables the specified ingest time rule.
|
DisableSourceEventTypesResponse |
disableSourceEventTypes(DisableSourceEventTypesRequest request)
Disable one or more event types in a source.
|
EnableArchivingResponse |
enableArchiving(EnableArchivingRequest request)
THis API enables archiving.
|
EnableAutoAssociationResponse |
enableAutoAssociation(EnableAutoAssociationRequest request)
Enables auto association for a log source.
|
EnableIngestTimeRuleResponse |
enableIngestTimeRule(EnableIngestTimeRuleRequest request)
Enables the specified ingest time rule.
|
EnableSourceEventTypesResponse |
enableSourceEventTypes(EnableSourceEventTypesRequest request)
Enable one or more event types in a source.
|
EstimatePurgeDataSizeResponse |
estimatePurgeDataSize(EstimatePurgeDataSizeRequest request)
This API estimates the size of data to be purged based based on time interval, purge query
etc.
|
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.
|
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.
|
ExportCustomContentResponse |
exportCustomContent(ExportCustomContentRequest request)
Exports all custom details of the specified sources, parsers, fields and labels, in zip
format.
|
ExportQueryResultResponse |
exportQueryResult(ExportQueryResultRequest request)
Export data based on query.
|
ExtractStructuredLogFieldPathsResponse |
extractStructuredLogFieldPaths(ExtractStructuredLogFieldPathsRequest request)
Extracts the field paths from the example json or xml content.
|
ExtractStructuredLogHeaderPathsResponse |
extractStructuredLogHeaderPaths(ExtractStructuredLogHeaderPathsRequest request)
Extracts the header paths from the example json or xml content.
|
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.
|
GetAssociationSummaryResponse |
getAssociationSummary(GetAssociationSummaryRequest request)
Returns the count of source associations for entities in the specified compartment.
|
GetCategoryResponse |
getCategory(GetCategoryRequest request)
Gets detailed information about the category with the specified name.
|
GetColumnNamesResponse |
getColumnNames(GetColumnNamesRequest request)
Extracts column names from the input SQL query.
|
GetConfigWorkRequestResponse |
getConfigWorkRequest(GetConfigWorkRequestRequest request)
Returns detailed information about the configuration work request with the specified id.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetFieldResponse |
getField(GetFieldRequest request)
Gets detailed information about the field with the specified name.
|
GetFieldsSummaryResponse |
getFieldsSummary(GetFieldsSummaryRequest request)
Returns the count of fields.
|
GetIngestTimeRuleResponse |
getIngestTimeRule(GetIngestTimeRuleRequest request)
Gets detailed information about the specified ingest time rule such as description, defined
tags, and free-form tags.
|
GetLabelResponse |
getLabel(GetLabelRequest request)
Gets detailed information about the label with the specified name.
|
GetLabelSummaryResponse |
getLabelSummary(GetLabelSummaryRequest request)
Returns the count of labels.
|
GetLogAnalyticsEmBridgeResponse |
getLogAnalyticsEmBridge(GetLogAnalyticsEmBridgeRequest request)
Retrieve the log analytics enterprise manager bridge with the given id.
|
GetLogAnalyticsEmBridgeSummaryResponse |
getLogAnalyticsEmBridgeSummary(GetLogAnalyticsEmBridgeSummaryRequest request)
Returns log analytics enterprise manager bridges summary report.
|
GetLogAnalyticsEntitiesSummaryResponse |
getLogAnalyticsEntitiesSummary(GetLogAnalyticsEntitiesSummaryRequest request)
Returns log analytics entities count summary report.
|
GetLogAnalyticsEntityResponse |
getLogAnalyticsEntity(GetLogAnalyticsEntityRequest request)
Retrieve the log analytics entity with the given id.
|
GetLogAnalyticsEntityTypeResponse |
getLogAnalyticsEntityType(GetLogAnalyticsEntityTypeRequest request)
Retrieve the log analytics entity type with the given name.
|
GetLogAnalyticsLogGroupResponse |
getLogAnalyticsLogGroup(GetLogAnalyticsLogGroupRequest request)
Gets detailed information about the specified log group such as display name, description,
defined tags, and free-form tags.
|
GetLogAnalyticsLogGroupsSummaryResponse |
getLogAnalyticsLogGroupsSummary(GetLogAnalyticsLogGroupsSummaryRequest request)
Returns the count of log groups in a compartment.
|
GetLogAnalyticsObjectCollectionRuleResponse |
getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleRequest request)
Gets a configured object storage based collection rule by given id
|
GetLogSetsCountResponse |
getLogSetsCount(GetLogSetsCountRequest request)
This API returns the count of distinct log sets.
|
GetLookupResponse |
getLookup(GetLookupRequest request)
Gets detailed information about the lookup with the specified name.
|
GetLookupSummaryResponse |
getLookupSummary(GetLookupSummaryRequest request)
Returns the count of user created and oracle defined lookups.
|
GetNamespaceResponse |
getNamespace(GetNamespaceRequest request)
This API gets the namespace details of a tenancy already onboarded in Logging Analytics
Application
|
LogAnalyticsPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetParserResponse |
getParser(GetParserRequest request)
Gets detailed information about the parser with the specified name.
|
GetParserSummaryResponse |
getParserSummary(GetParserSummaryRequest request)
Returns the count of parsers.
|
GetPreferencesResponse |
getPreferences(GetPreferencesRequest request)
Lists the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
|
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.
|
GetQueryWorkRequestResponse |
getQueryWorkRequest(GetQueryWorkRequestRequest request)
Retrieve work request details by workRequestId.
|
GetRecallCountResponse |
getRecallCount(GetRecallCountRequest request)
This API gets the number of recalls made and the maximum recalls that can be made
|
GetRecalledDataSizeResponse |
getRecalledDataSize(GetRecalledDataSizeRequest request)
This API gets the datasize of recalls for a given timeframe
|
GetRulesSummaryResponse |
getRulesSummary(GetRulesSummaryRequest request)
Returns the count of detection rules in a compartment.
|
GetScheduledTaskResponse |
getScheduledTask(GetScheduledTaskRequest request)
Get the scheduled task for the specified task identifier.
|
GetSourceResponse |
getSource(GetSourceRequest request)
Gets detailed information about the source with the specified name.
|
GetSourceSummaryResponse |
getSourceSummary(GetSourceSummaryRequest request)
Returns the count of sources.
|
GetStorageResponse |
getStorage(GetStorageRequest request)
This API gets the storage configuration of a tenancy
|
GetStorageUsageResponse |
getStorageUsage(GetStorageUsageRequest request)
This API gets storage usage information of a tenancy.
|
GetStorageWorkRequestResponse |
getStorageWorkRequest(GetStorageWorkRequestRequest request)
This API returns work request details specified by {workRequestId}.
|
GetUnprocessedDataBucketResponse |
getUnprocessedDataBucket(GetUnprocessedDataBucketRequest request)
This API retrieves details of the configured bucket that stores unprocessed payloads.
|
GetUploadResponse |
getUpload(GetUploadRequest request)
Gets an On-Demand Upload info by reference.
|
LogAnalyticsWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.
|
ImportCustomContentResponse |
importCustomContent(ImportCustomContentRequest request)
Imports the specified custom content from the input in zip format.
|
ListAssociableEntitiesResponse |
listAssociableEntities(ListAssociableEntitiesRequest request)
Lists the entities in the specified compartment which are (in)eligible for association with
this source.
|
ListAssociatedEntitiesResponse |
listAssociatedEntities(ListAssociatedEntitiesRequest request)
Lists the association details of entities in the specified compartment that are associated
with at least one source.
|
ListAutoAssociationsResponse |
listAutoAssociations(ListAutoAssociationsRequest request)
Gets information related to auto association for the source with the specified name.
|
ListCategoriesResponse |
listCategories(ListCategoriesRequest request)
Returns a list of categories, containing detailed information about them.
|
ListConfigWorkRequestsResponse |
listConfigWorkRequests(ListConfigWorkRequestsRequest request)
Returns the list of configuration work requests such as association or lookup operations,
containing detailed information about them.
|
ListEffectivePropertiesResponse |
listEffectiveProperties(ListEffectivePropertiesRequest request)
Returns a list of effective properties for the specified resource.
|
ListEncryptionKeyInfoResponse |
listEncryptionKeyInfo(ListEncryptionKeyInfoRequest request)
This API returns the list of customer owned encryption key info.
|
ListEntityAssociationsResponse |
listEntityAssociations(ListEntityAssociationsRequest request)
Return a list of log analytics entities associated with input source log analytics entity.
|
ListEntitySourceAssociationsResponse |
listEntitySourceAssociations(ListEntitySourceAssociationsRequest request)
Returns the list of source associations for the specified entity.
|
ListFieldsResponse |
listFields(ListFieldsRequest request)
Returns a list of log fields, containing detailed information about them.
|
ListIngestTimeRulesResponse |
listIngestTimeRules(ListIngestTimeRulesRequest request)
Returns a list of ingest time rules in a compartment.
|
ListLabelPrioritiesResponse |
listLabelPriorities(ListLabelPrioritiesRequest request)
Lists the available problem priorities that could be associated with a label.
|
ListLabelsResponse |
listLabels(ListLabelsRequest request)
Returns a list of labels, containing detailed information about them.
|
ListLabelSourceDetailsResponse |
listLabelSourceDetails(ListLabelSourceDetailsRequest request)
Lists sources using the label, along with configuration details like base field, operator and
condition.
|
ListLogAnalyticsEmBridgesResponse |
listLogAnalyticsEmBridges(ListLogAnalyticsEmBridgesRequest request)
Return a list of log analytics enterprise manager bridges.
|
ListLogAnalyticsEntitiesResponse |
listLogAnalyticsEntities(ListLogAnalyticsEntitiesRequest request)
Return a list of log analytics entities.
|
ListLogAnalyticsEntityTopologyResponse |
listLogAnalyticsEntityTopology(ListLogAnalyticsEntityTopologyRequest request)
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.
|
ListLogAnalyticsEntityTypesResponse |
listLogAnalyticsEntityTypes(ListLogAnalyticsEntityTypesRequest request)
Return a list of log analytics entity types.
|
ListLogAnalyticsLogGroupsResponse |
listLogAnalyticsLogGroups(ListLogAnalyticsLogGroupsRequest request)
Returns a list of log groups in a compartment.
|
ListLogAnalyticsObjectCollectionRulesResponse |
listLogAnalyticsObjectCollectionRules(ListLogAnalyticsObjectCollectionRulesRequest request)
Gets list of collection rules.
|
ListLogSetsResponse |
listLogSets(ListLogSetsRequest request)
This API returns a list of log sets.
|
ListLookupsResponse |
listLookups(ListLookupsRequest request)
Returns a list of lookups, containing detailed information about them.
|
ListMetaSourceTypesResponse |
listMetaSourceTypes(ListMetaSourceTypesRequest request)
Lists the types of log sources supported.
|
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.
|
ListOverlappingRecallsResponse |
listOverlappingRecalls(ListOverlappingRecallsRequest request)
This API gets the list of overlapping recalls made in the given timeframe
|
ListParserFunctionsResponse |
listParserFunctions(ListParserFunctionsRequest request)
Lists the parser functions defined for the specified parser.
|
ListParserMetaPluginsResponse |
listParserMetaPlugins(ListParserMetaPluginsRequest request)
Lists the parser meta plugins available for defining parser functions.
|
ListParsersResponse |
listParsers(ListParsersRequest request)
Returns a list of parsers, containing detailed information about them.
|
ListPropertiesMetadataResponse |
listPropertiesMetadata(ListPropertiesMetadataRequest request)
Returns a list of properties along with their metadata.
|
ListQueryWorkRequestsResponse |
listQueryWorkRequests(ListQueryWorkRequestsRequest request)
List active asynchronous queries.
|
ListRecalledDataResponse |
listRecalledData(ListRecalledDataRequest request)
This API returns the list of recalled data of a tenancy.
|
ListResourceCategoriesResponse |
listResourceCategories(ListResourceCategoriesRequest request)
Returns a list of resources and their category assignments.
|
ListRulesResponse |
listRules(ListRulesRequest request)
Returns a list of ingest time rules and scheduled tasks in a compartment.
|
ListScheduledTasksResponse |
listScheduledTasks(ListScheduledTasksRequest request)
Lists scheduled tasks.
|
ListSourceAssociationsResponse |
listSourceAssociations(ListSourceAssociationsRequest request)
Returns the list of entity associations in the input compartment for the specified source.
|
ListSourceEventTypesResponse |
listSourceEventTypes(ListSourceEventTypesRequest request)
Lists the event types mapped to the source with the specified name.
|
ListSourceExtendedFieldDefinitionsResponse |
listSourceExtendedFieldDefinitions(ListSourceExtendedFieldDefinitionsRequest request)
Lists the extended field definitions for the source with the specified name.
|
ListSourceLabelOperatorsResponse |
listSourceLabelOperators(ListSourceLabelOperatorsRequest request)
Lists the supported conditional operators that could be used for matching log field values to
generate a label.
|
ListSourceMetaFunctionsResponse |
listSourceMetaFunctions(ListSourceMetaFunctionsRequest request)
Lists the functions that could be used to enrich log entries based on meaningful information
extracted from the log fields.
|
ListSourcePatternsResponse |
listSourcePatterns(ListSourcePatternsRequest request)
Lists the source patterns for the source with the specified name.
|
ListSourcesResponse |
listSources(ListSourcesRequest request)
Returns a list of sources, containing detailed information about them.
|
ListStorageWorkRequestErrorsResponse |
listStorageWorkRequestErrors(ListStorageWorkRequestErrorsRequest request)
This API returns the list of work request errors if any.
|
ListStorageWorkRequestsResponse |
listStorageWorkRequests(ListStorageWorkRequestsRequest request)
This API lists storage work requests.
|
ListSupportedCharEncodingsResponse |
listSupportedCharEncodings(ListSupportedCharEncodingsRequest request)
Gets list of character encodings which are supported by on-demand upload.
|
ListSupportedTimezonesResponse |
listSupportedTimezones(ListSupportedTimezonesRequest request)
Gets list of timezones which are supported by on-demand upload.
|
ListUploadFilesResponse |
listUploadFiles(ListUploadFilesRequest request)
Gets list of files in an upload along with its processing state.
|
ListUploadsResponse |
listUploads(ListUploadsRequest request)
Gets a list of all On-demand uploads.
|
ListUploadWarningsResponse |
listUploadWarnings(ListUploadWarningsRequest request)
Gets list of warnings in an upload caused by incorrect configuration.
|
ListWarningsResponse |
listWarnings(ListWarningsRequest request)
Returns a list of collection warnings, containing detailed information about them.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
|
OffboardNamespaceResponse |
offboardNamespace(OffboardNamespaceRequest request)
Off-boards a tenant from Logging Analytics
|
OnboardNamespaceResponse |
onboardNamespace(OnboardNamespaceRequest request)
On-boards a tenant to Logging Analytics.
|
ParseQueryResponse |
parseQuery(ParseQueryRequest request)
Describe query
|
PauseScheduledTaskResponse |
pauseScheduledTask(PauseScheduledTaskRequest request)
Pause the scheduled task specified by {scheduledTaskId}.
|
PurgeStorageDataResponse |
purgeStorageData(PurgeStorageDataRequest request)
This API submits a work request to purge data.
|
PutQueryWorkRequestBackgroundResponse |
putQueryWorkRequestBackground(PutQueryWorkRequestBackgroundRequest request)
Put the work request specified by {workRequestId} into the background.
|
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.
|
RecallArchivedDataResponse |
recallArchivedData(RecallArchivedDataRequest request)
This API submits a work request to recall archived data based on time interval and data type.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
RegisterLookupResponse |
registerLookup(RegisterLookupRequest request)
Creates a lookup with the specified name, type and description.
|
ReleaseRecalledDataResponse |
releaseRecalledData(ReleaseRecalledDataRequest request)
This API submits a work request to release recalled data based on time interval and data
type.
|
RemoveEntityAssociationsResponse |
removeEntityAssociations(RemoveEntityAssociationsRequest request)
Delete association between input source log analytics entity and destination entities.
|
RemovePreferencesResponse |
removePreferences(RemovePreferencesRequest request)
Removes the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
|
RemoveResourceCategoriesResponse |
removeResourceCategories(RemoveResourceCategoriesRequest request)
Removes the category assignments of DASHBOARD and SAVEDSEARCH resources.
|
RemoveSourceEventTypesResponse |
removeSourceEventTypes(RemoveSourceEventTypesRequest request)
Remove one or more event types from a source.
|
ResumeScheduledTaskResponse |
resumeScheduledTask(ResumeScheduledTaskRequest request)
Resume the scheduled task specified by {scheduledTaskId}.
|
RunResponse |
run(RunRequest request)
Execute the saved search acceleration task in the foreground.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
SetUnprocessedDataBucketResponse |
setUnprocessedDataBucket(SetUnprocessedDataBucketRequest request)
This API configures a bucket to store unprocessed payloads.
|
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.
|
SuppressWarningResponse |
suppressWarning(SuppressWarningRequest request)
Supresses a list of warnings.
|
TestParserResponse |
testParser(TestParserRequest request)
Tests the parser definition against the specified example content to ensure fields are
successfully extracted.
|
UnsuppressWarningResponse |
unsuppressWarning(UnsuppressWarningRequest request)
Unsupresses a list of warnings.
|
UpdateIngestTimeRuleResponse |
updateIngestTimeRule(UpdateIngestTimeRuleRequest request)
Updates the specified ingest time rule’s description, defined tags, and free-form tags.
|
UpdateLogAnalyticsEmBridgeResponse |
updateLogAnalyticsEmBridge(UpdateLogAnalyticsEmBridgeRequest request)
Update log analytics enterprise manager bridge with the given id.
|
UpdateLogAnalyticsEntityResponse |
updateLogAnalyticsEntity(UpdateLogAnalyticsEntityRequest request)
Update the log analytics entity with the given id.
|
UpdateLogAnalyticsEntityTypeResponse |
updateLogAnalyticsEntityType(UpdateLogAnalyticsEntityTypeRequest request)
Update custom log analytics entity type.
|
UpdateLogAnalyticsLogGroupResponse |
updateLogAnalyticsLogGroup(UpdateLogAnalyticsLogGroupRequest request)
Updates the specified log group’s display name, description, defined tags, and free-form
tags.
|
UpdateLogAnalyticsObjectCollectionRuleResponse |
updateLogAnalyticsObjectCollectionRule(UpdateLogAnalyticsObjectCollectionRuleRequest request)
Updates configuration of the object collection rule for the given id.
|
UpdateLookupResponse |
updateLookup(UpdateLookupRequest request)
Updates the metadata of the specified lookup, such as the lookup description.
|
UpdateLookupDataResponse |
updateLookupData(UpdateLookupDataRequest request)
Updates the lookup content.
|
UpdatePreferencesResponse |
updatePreferences(UpdatePreferencesRequest request)
Updates the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
|
UpdateResourceCategoriesResponse |
updateResourceCategories(UpdateResourceCategoriesRequest request)
Updates the category assignments of DASHBOARD and SAVEDSEARCH resources.
|
UpdateScheduledTaskResponse |
updateScheduledTask(UpdateScheduledTaskRequest request)
Update the scheduled task.
|
UpdateStorageResponse |
updateStorage(UpdateStorageRequest request)
This API updates the archiving configuration
|
UploadDiscoveryDataResponse |
uploadDiscoveryData(UploadDiscoveryDataRequest request)
Accepts discovery data for processing by Logging Analytics.
|
UploadLogEventsFileResponse |
uploadLogEventsFile(UploadLogEventsFileRequest request)
Accepts log events for processing by Logging Analytics.
|
UploadLogFileResponse |
uploadLogFile(UploadLogFileRequest request)
Accepts log data for processing by Logging Analytics.
|
UpsertAssociationsResponse |
upsertAssociations(UpsertAssociationsRequest request)
Creates or updates associations between sources and entities.
|
UpsertFieldResponse |
upsertField(UpsertFieldRequest request)
Creates or updates a field that could be used in parser expressions to extract and assign
value.
|
UpsertLabelResponse |
upsertLabel(UpsertLabelRequest request)
Creates or updates a label that could be used to tag a log entry.
|
UpsertParserResponse |
upsertParser(UpsertParserRequest request)
Creates or updates a parser, which defines how fields are extracted from a log entry.
|
UpsertSourceResponse |
upsertSource(UpsertSourceRequest request)
Creates or updates a log source.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
ValidateAssociationParametersResponse |
validateAssociationParameters(ValidateAssociationParametersRequest request)
Checks if the passed in entities could be associated with the specified sources.
|
ValidateEndpointResponse |
validateEndpoint(ValidateEndpointRequest request)
Validates the REST endpoint configuration.
|
ValidateFileResponse |
validateFile(ValidateFileRequest request)
Validates a log file to check whether it is eligible to be uploaded or not.
|
ValidateLabelConditionResponse |
validateLabelCondition(ValidateLabelConditionRequest request)
Validates specified condition for a source label.
|
ValidateSourceResponse |
validateSource(ValidateSourceRequest request)
Checks if the specified input is a valid log source definition.
|
ValidateSourceExtendedFieldDetailsResponse |
validateSourceExtendedFieldDetails(ValidateSourceExtendedFieldDetailsRequest request)
Checks if the specified input contains valid extended field definitions against the provided
example content.
|
ValidateSourceMappingResponse |
validateSourceMapping(ValidateSourceMappingRequest request)
Validates the source mapping for a given file and provides match status and the parsed
representation of log data.
|
VerifyResponse |
verify(VerifyRequest request)
Verify the accelerated saved search task specified by {scheduledTaskId}.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void 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(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.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateAddEntityAssociationResponse 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddEntityAssociation API.
AddSourceEventTypesResponse addSourceEventTypes(AddSourceEventTypesRequest request)
Add one or more event types to a source. An event type and version can be enabled only on one source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddSourceEventTypes API.
AppendLookupDataResponse appendLookupData(AppendLookupDataRequest request)
Appends data to the lookup content. The csv file containing the content to be appended is passed in as binary data in the request.
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AppendLookupData API.
AssignEncryptionKeyResponse assignEncryptionKey(AssignEncryptionKeyRequest request)
This API submits a work request to assign customer encryption key.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AssignEncryptionKey API.
BatchGetBasicInfoResponse batchGetBasicInfo(BatchGetBasicInfoRequest request)
Lists basic information about a specified set of labels in batch.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelQueryWorkRequest API.
ChangeIngestTimeRuleCompartmentResponse changeIngestTimeRuleCompartment(ChangeIngestTimeRuleCompartmentRequest request)
Moves the specified ingest time rule to a different compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeIngestTimeRuleCompartment API.
ChangeLogAnalyticsEmBridgeCompartmentResponse changeLogAnalyticsEmBridgeCompartment(ChangeLogAnalyticsEmBridgeCompartmentRequest request)
Update the compartment of the log analytics enterprise manager bridge with the given id.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeLogAnalyticsEmBridgeCompartment 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeLogAnalyticsEntityCompartment API.
ChangeLogAnalyticsLogGroupCompartmentResponse changeLogAnalyticsLogGroupCompartment(ChangeLogAnalyticsLogGroupCompartmentRequest request)
Moves the specified log group to a different compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use Clean API.
CompareContentResponse compareContent(CompareContentRequest request)
Returns the difference between the two input payloads, including intraline differences.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CompareContent API.
CreateIngestTimeRuleResponse createIngestTimeRule(CreateIngestTimeRuleRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateIngestTimeRule API.
CreateLogAnalyticsEmBridgeResponse createLogAnalyticsEmBridge(CreateLogAnalyticsEmBridgeRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateLogAnalyticsEmBridge API.
CreateLogAnalyticsEntityResponse createLogAnalyticsEntity(CreateLogAnalyticsEntityRequest request)
Create a new log analytics entity.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateLogAnalyticsEntityType API.
CreateLogAnalyticsLogGroupResponse createLogAnalyticsLogGroup(CreateLogAnalyticsLogGroupRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateScheduledTask API.
DeleteAssociationsResponse deleteAssociations(DeleteAssociationsRequest request)
Deletes the associations between the sources and entities specified.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteAssociations API.
DeleteFieldResponse deleteField(DeleteFieldRequest request)
Deletes field with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteField API.
DeleteIngestTimeRuleResponse deleteIngestTimeRule(DeleteIngestTimeRuleRequest request)
Deletes the specified ingest time rule.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteIngestTimeRule API.
DeleteLabelResponse deleteLabel(DeleteLabelRequest request)
Deletes label with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteLabel API.
DeleteLogAnalyticsEmBridgeResponse deleteLogAnalyticsEmBridge(DeleteLogAnalyticsEmBridgeRequest request)
Delete log analytics enterprise manager bridge with the given id.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteLogAnalyticsEmBridge 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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteLogAnalyticsEntityType API.
DeleteLogAnalyticsLogGroupResponse deleteLogAnalyticsLogGroup(DeleteLogAnalyticsLogGroupRequest request)
Deletes the specified log group. The log group cannot be part of an active association or have an active upload.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteLogAnalyticsObjectCollectionRule API.
DeleteLookupResponse deleteLookup(DeleteLookupRequest request)
Deletes lookup with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteLookup API.
DeleteParserResponse deleteParser(DeleteParserRequest request)
Deletes parser with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteScheduledTask API.
DeleteSourceResponse deleteSource(DeleteSourceRequest request)
Deletes source with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DisableArchiving API.
DisableAutoAssociationResponse disableAutoAssociation(DisableAutoAssociationRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DisableAutoAssociation API.
DisableIngestTimeRuleResponse disableIngestTimeRule(DisableIngestTimeRuleRequest request)
Disables the specified ingest time rule.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DisableIngestTimeRule API.
DisableSourceEventTypesResponse disableSourceEventTypes(DisableSourceEventTypesRequest request)
Disable one or more event types in a source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DisableSourceEventTypes API.
EnableArchivingResponse enableArchiving(EnableArchivingRequest request)
THis API enables archiving.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use EnableArchiving API.
EnableAutoAssociationResponse enableAutoAssociation(EnableAutoAssociationRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use EnableAutoAssociation API.
EnableIngestTimeRuleResponse enableIngestTimeRule(EnableIngestTimeRuleRequest request)
Enables the specified ingest time rule.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use EnableIngestTimeRule API.
EnableSourceEventTypesResponse enableSourceEventTypes(EnableSourceEventTypesRequest request)
Enable one or more event types in a source. An event type and version can be enabled only in one source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use EnableSourceEventTypes 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use EstimateReleaseDataSize API.
ExportCustomContentResponse exportCustomContent(ExportCustomContentRequest request)
Exports all custom details of the specified sources, parsers, fields and labels, in zip format.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ExportQueryResult API.
ExtractStructuredLogFieldPathsResponse extractStructuredLogFieldPaths(ExtractStructuredLogFieldPathsRequest request)
Extracts the field paths from the example json or xml content.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ExtractStructuredLogFieldPaths API.
ExtractStructuredLogHeaderPathsResponse extractStructuredLogHeaderPaths(ExtractStructuredLogHeaderPathsRequest request)
Extracts the header paths from the example json or xml content.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use Filter API.
GetAssociationSummaryResponse getAssociationSummary(GetAssociationSummaryRequest request)
Returns the count of source associations for entities in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAssociationSummary API.
GetCategoryResponse getCategory(GetCategoryRequest request)
Gets detailed information about the category with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetCategory API.
GetColumnNamesResponse getColumnNames(GetColumnNamesRequest request)
Extracts column names from the input SQL query.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetColumnNames API.
GetConfigWorkRequestResponse getConfigWorkRequest(GetConfigWorkRequestRequest request)
Returns detailed information about the configuration work request with the specified id.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetConfigWorkRequest API.
GetFieldResponse getField(GetFieldRequest request)
Gets detailed information about the field with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetField API.
GetFieldsSummaryResponse getFieldsSummary(GetFieldsSummaryRequest request)
Returns the count of fields. You may optionally specify isShowDetail=true to view a summary of each field data type.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetFieldsSummary API.
GetIngestTimeRuleResponse getIngestTimeRule(GetIngestTimeRuleRequest request)
Gets detailed information about the specified ingest time rule such as description, defined tags, and free-form tags.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetIngestTimeRule API.
GetLabelResponse getLabel(GetLabelRequest request)
Gets detailed information about the label with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLabel API.
GetLabelSummaryResponse getLabelSummary(GetLabelSummaryRequest request)
Returns the count of labels.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLabelSummary API.
GetLogAnalyticsEmBridgeResponse getLogAnalyticsEmBridge(GetLogAnalyticsEmBridgeRequest request)
Retrieve the log analytics enterprise manager bridge with the given id.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLogAnalyticsEmBridge API.
GetLogAnalyticsEmBridgeSummaryResponse getLogAnalyticsEmBridgeSummary(GetLogAnalyticsEmBridgeSummaryRequest request)
Returns log analytics enterprise manager bridges summary report.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLogAnalyticsEmBridgeSummary 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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLogAnalyticsEntityType API.
GetLogAnalyticsLogGroupResponse getLogAnalyticsLogGroup(GetLogAnalyticsLogGroupRequest request)
Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLogAnalyticsLogGroup API.
GetLogAnalyticsLogGroupsSummaryResponse getLogAnalyticsLogGroupsSummary(GetLogAnalyticsLogGroupsSummaryRequest request)
Returns the count of log groups in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLogAnalyticsObjectCollectionRule API.
GetLogSetsCountResponse getLogSetsCount(GetLogSetsCountRequest request)
This API returns the count of distinct log sets.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLogSetsCount API.
GetLookupResponse getLookup(GetLookupRequest request)
Gets detailed information about the lookup with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLookup API.
GetLookupSummaryResponse getLookupSummary(GetLookupSummaryRequest request)
Returns the count of user created and oracle defined lookups.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetLookupSummary 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetNamespace API.
GetParserResponse getParser(GetParserRequest request)
Gets detailed information about the parser with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetParser API.
GetParserSummaryResponse getParserSummary(GetParserSummaryRequest request)
Returns the count of parsers.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetParserSummary API.
GetPreferencesResponse getPreferences(GetPreferencesRequest request)
Lists the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetPreferences 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetQueryWorkRequest API.
GetRecallCountResponse getRecallCount(GetRecallCountRequest request)
This API gets the number of recalls made and the maximum recalls that can be made
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetRecallCount API.
GetRecalledDataSizeResponse getRecalledDataSize(GetRecalledDataSizeRequest request)
This API gets the datasize of recalls for a given timeframe
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetRecalledDataSize API.
GetRulesSummaryResponse getRulesSummary(GetRulesSummaryRequest request)
Returns the count of detection rules in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetRulesSummary 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetScheduledTask API.
GetSourceResponse getSource(GetSourceRequest request)
Gets detailed information about the source with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSource API.
GetSourceSummaryResponse getSourceSummary(GetSourceSummaryRequest request)
Returns the count of sources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetStorageWorkRequest API.
GetUnprocessedDataBucketResponse getUnprocessedDataBucket(GetUnprocessedDataBucketRequest request)
This API retrieves details of the configured bucket that stores unprocessed payloads.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetUnprocessedDataBucket 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWorkRequest API.
ImportCustomContentResponse importCustomContent(ImportCustomContentRequest request)
Imports the specified custom content from the input in zip format.
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ImportCustomContent API.
ListAssociableEntitiesResponse listAssociableEntities(ListAssociableEntitiesRequest request)
Lists the entities in the specified compartment which are (in)eligible for association with this source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAssociableEntities API.
ListAssociatedEntitiesResponse listAssociatedEntities(ListAssociatedEntitiesRequest request)
Lists the association details of entities in the specified compartment that are associated with at least one source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAssociatedEntities API.
ListAutoAssociationsResponse listAutoAssociations(ListAutoAssociationsRequest request)
Gets information related to auto association for the source with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAutoAssociations API.
ListCategoriesResponse listCategories(ListCategoriesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListCategories API.
ListConfigWorkRequestsResponse listConfigWorkRequests(ListConfigWorkRequestsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListConfigWorkRequests API.
ListEffectivePropertiesResponse listEffectiveProperties(ListEffectivePropertiesRequest request)
Returns a list of effective properties for the specified resource.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListEffectiveProperties API.
ListEncryptionKeyInfoResponse listEncryptionKeyInfo(ListEncryptionKeyInfoRequest request)
This API returns the list of customer owned encryption key info.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListEncryptionKeyInfo 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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListEntityAssociations API.
ListEntitySourceAssociationsResponse listEntitySourceAssociations(ListEntitySourceAssociationsRequest request)
Returns the list of source associations for the specified entity.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListEntitySourceAssociations API.
ListFieldsResponse listFields(ListFieldsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListFields API.
ListIngestTimeRulesResponse listIngestTimeRules(ListIngestTimeRulesRequest request)
Returns a list of ingest time rules in a compartment. You may limit the number of rules, provide sorting options, and filter the results.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListIngestTimeRules API.
ListLabelPrioritiesResponse listLabelPriorities(ListLabelPrioritiesRequest request)
Lists the available problem priorities that could be associated with a label.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLabelPriorities API.
ListLabelSourceDetailsResponse listLabelSourceDetails(ListLabelSourceDetailsRequest request)
Lists sources using the label, along with configuration details like base field, operator and condition.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLabelSourceDetails API.
ListLabelsResponse listLabels(ListLabelsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLabels API.
ListLogAnalyticsEmBridgesResponse listLogAnalyticsEmBridges(ListLogAnalyticsEmBridgesRequest request)
Return a list of log analytics enterprise manager bridges.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLogAnalyticsEmBridges 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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLogAnalyticsEntities API.
ListLogAnalyticsEntityTopologyResponse listLogAnalyticsEntityTopology(ListLogAnalyticsEntityTopologyRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLogAnalyticsEntityTopology 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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLogAnalyticsEntityTypes API.
ListLogAnalyticsLogGroupsResponse listLogAnalyticsLogGroups(ListLogAnalyticsLogGroupsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLogAnalyticsObjectCollectionRules API.
ListLogSetsResponse listLogSets(ListLogSetsRequest request)
This API returns a list of log sets.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLogSets API.
ListLookupsResponse listLookups(ListLookupsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListLookups API.
ListMetaSourceTypesResponse listMetaSourceTypes(ListMetaSourceTypesRequest request)
Lists the types of log sources supported.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListNamespaces API.
ListOverlappingRecallsResponse listOverlappingRecalls(ListOverlappingRecallsRequest request)
This API gets the list of overlapping recalls made in the given timeframe
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListOverlappingRecalls API.
ListParserFunctionsResponse listParserFunctions(ListParserFunctionsRequest request)
Lists the parser functions defined for the specified parser.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListParserFunctions API.
ListParserMetaPluginsResponse listParserMetaPlugins(ListParserMetaPluginsRequest request)
Lists the parser meta plugins available for defining parser functions.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListParserMetaPlugins API.
ListParsersResponse listParsers(ListParsersRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListParsers API.
ListPropertiesMetadataResponse listPropertiesMetadata(ListPropertiesMetadataRequest request)
Returns a list of properties along with their metadata.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListPropertiesMetadata API.
ListQueryWorkRequestsResponse listQueryWorkRequests(ListQueryWorkRequestsRequest request)
List active asynchronous queries.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListRecalledData API.
ListResourceCategoriesResponse listResourceCategories(ListResourceCategoriesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResourceCategories API.
ListRulesResponse listRules(ListRulesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListRules API.
ListScheduledTasksResponse listScheduledTasks(ListScheduledTasksRequest request)
Lists scheduled tasks.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListScheduledTasks API.
ListSourceAssociationsResponse listSourceAssociations(ListSourceAssociationsRequest request)
Returns the list of entity associations in the input compartment for the specified source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSourceAssociations API.
ListSourceEventTypesResponse listSourceEventTypes(ListSourceEventTypesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSourceEventTypes API.
ListSourceExtendedFieldDefinitionsResponse listSourceExtendedFieldDefinitions(ListSourceExtendedFieldDefinitionsRequest request)
Lists the extended field definitions for the source with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSourceExtendedFieldDefinitions API.
ListSourceLabelOperatorsResponse listSourceLabelOperators(ListSourceLabelOperatorsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSourceLabelOperators API.
ListSourceMetaFunctionsResponse listSourceMetaFunctions(ListSourceMetaFunctionsRequest request)
Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSourceMetaFunctions API.
ListSourcePatternsResponse listSourcePatterns(ListSourcePatternsRequest request)
Lists the source patterns for the source with the specified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSourcePatterns API.
ListSourcesResponse listSources(ListSourcesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListUploads API.
ListWarningsResponse listWarnings(ListWarningsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RecallArchivedData API.
RegisterLookupResponse registerLookup(RegisterLookupRequest request)
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.
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveEntityAssociations API.
RemovePreferencesResponse removePreferences(RemovePreferencesRequest request)
Removes the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemovePreferences API.
RemoveResourceCategoriesResponse removeResourceCategories(RemoveResourceCategoriesRequest request)
Removes the category assignments of DASHBOARD and SAVEDSEARCH resources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveResourceCategories API.
RemoveSourceEventTypesResponse removeSourceEventTypes(RemoveSourceEventTypesRequest request)
Remove one or more event types from a source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveSourceEventTypes 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use Run API.
SetUnprocessedDataBucketResponse setUnprocessedDataBucket(SetUnprocessedDataBucketRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SetUnprocessedDataBucket 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use Suggest API.
SuppressWarningResponse suppressWarning(SuppressWarningRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SuppressWarning API.
TestParserResponse testParser(TestParserRequest request)
Tests the parser definition against the specified example content to ensure fields are successfully extracted.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use TestParser API.
UnsuppressWarningResponse unsuppressWarning(UnsuppressWarningRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UnsuppressWarning API.
UpdateIngestTimeRuleResponse updateIngestTimeRule(UpdateIngestTimeRuleRequest request)
Updates the specified ingest time rule’s description, defined tags, and free-form tags.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateIngestTimeRule API.
UpdateLogAnalyticsEmBridgeResponse updateLogAnalyticsEmBridge(UpdateLogAnalyticsEmBridgeRequest request)
Update log analytics enterprise manager bridge with the given id.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateLogAnalyticsEmBridge 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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateLogAnalyticsEntityType API.
UpdateLogAnalyticsLogGroupResponse updateLogAnalyticsLogGroup(UpdateLogAnalyticsLogGroupRequest request)
Updates the specified log group’s display name, description, defined tags, and free-form tags.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateLookup API.
UpdateLookupDataResponse updateLookupData(UpdateLookupDataRequest request)
Updates the lookup content. The csv file containing the content to be updated is passed in as binary data in the request.
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateLookupData API.
UpdatePreferencesResponse updatePreferences(UpdatePreferencesRequest request)
Updates the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdatePreferences API.
UpdateResourceCategoriesResponse updateResourceCategories(UpdateResourceCategoriesRequest request)
Updates the category assignments of DASHBOARD and SAVEDSEARCH resources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateResourceCategories 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateStorage API.
UploadDiscoveryDataResponse uploadDiscoveryData(UploadDiscoveryDataRequest request)
Accepts discovery 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UploadDiscoveryData API.
UploadLogEventsFileResponse uploadLogEventsFile(UploadLogEventsFileRequest request)
Accepts log events 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UploadLogEventsFile 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UploadLogFile API.
UpsertAssociationsResponse upsertAssociations(UpsertAssociationsRequest request)
Creates or updates associations between sources and entities. All entities should belong to the specified input compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpsertAssociations API.
UpsertFieldResponse upsertField(UpsertFieldRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpsertField API.
UpsertLabelResponse upsertLabel(UpsertLabelRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpsertLabel API.
UpsertParserResponse upsertParser(UpsertParserRequest request)
Creates or updates a parser, which defines how fields are extracted from a log entry.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpsertParser API.
UpsertSourceResponse upsertSource(UpsertSourceRequest request)
Creates or updates a log source. You may also specify parsers, labels, extended fields etc., for the source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpsertSource API.
ValidateAssociationParametersResponse validateAssociationParameters(ValidateAssociationParametersRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ValidateAssociationParameters API.
ValidateEndpointResponse validateEndpoint(ValidateEndpointRequest request)
Validates the REST endpoint configuration.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ValidateEndpoint 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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ValidateFile API.
ValidateLabelConditionResponse validateLabelCondition(ValidateLabelConditionRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ValidateLabelCondition API.
ValidateSourceResponse validateSource(ValidateSourceRequest request)
Checks if the specified input is a valid log source definition.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ValidateSource API.
ValidateSourceExtendedFieldDetailsResponse validateSourceExtendedFieldDetails(ValidateSourceExtendedFieldDetailsRequest request)
Checks if the specified input contains valid extended field definitions against the provided example content.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
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. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ValidateSourceMapping API.
VerifyResponse verify(VerifyRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use Verify 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–2024. All rights reserved.