Interface LogAnalytics
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
LogAnalyticsClient
@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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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 idGetLogSetsCountResponse
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 ApplicationLogAnalyticsPaginators
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 madeGetRecalledDataSizeResponse
getRecalledDataSize(GetRecalledDataSizeRequest request)
This API gets the datasize of recalls for a given timeframeGetRulesSummaryResponse
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 tenancyGetStorageUsageResponse
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 timeframeListParserFunctionsResponse
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 AnalyticsOnboardNamespaceResponse
onboardNamespace(OnboardNamespaceRequest request)
On-boards a tenant to Logging Analytics.ParseQueryResponse
parseQuery(ParseQueryRequest request)
Describe queryPauseScheduledTaskResponse
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 configurationUploadDiscoveryDataResponse
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}.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
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.- Parameters:
region
- The region of the service.
-
setRegion
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
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”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
addEntityAssociation
AddEntityAssociationResponse addEntityAssociation(AddEntityAssociationRequest request)
Adds association between input source log analytics entity and one or more existing destination entities.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/AddEntityAssociationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddEntityAssociation API.
-
addSourceEventTypes
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/AddSourceEventTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddSourceEventTypes API.
-
appendLookupData
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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/AppendLookupDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AppendLookupData API.
-
assignEncryptionKey
AssignEncryptionKeyResponse assignEncryptionKey(AssignEncryptionKeyRequest request)
This API submits a work request to assign customer encryption key.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/AssignEncryptionKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AssignEncryptionKey API.
-
batchGetBasicInfo
BatchGetBasicInfoResponse batchGetBasicInfo(BatchGetBasicInfoRequest request)
Lists basic information about a specified set of labels in batch.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/BatchGetBasicInfoExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchGetBasicInfo API.
-
cancelQueryWorkRequest
CancelQueryWorkRequestResponse cancelQueryWorkRequest(CancelQueryWorkRequestRequest request)
Cancel/Remove query job work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CancelQueryWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelQueryWorkRequest API.
-
changeIngestTimeRuleCompartment
ChangeIngestTimeRuleCompartmentResponse changeIngestTimeRuleCompartment(ChangeIngestTimeRuleCompartmentRequest request)
Moves the specified ingest time rule to a different compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ChangeIngestTimeRuleCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeIngestTimeRuleCompartment API.
-
changeLogAnalyticsEmBridgeCompartment
ChangeLogAnalyticsEmBridgeCompartmentResponse changeLogAnalyticsEmBridgeCompartment(ChangeLogAnalyticsEmBridgeCompartmentRequest request)
Update the compartment of the log analytics enterprise manager bridge with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ChangeLogAnalyticsEmBridgeCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeLogAnalyticsEmBridgeCompartment API.
-
changeLogAnalyticsEntityCompartment
ChangeLogAnalyticsEntityCompartmentResponse changeLogAnalyticsEntityCompartment(ChangeLogAnalyticsEntityCompartmentRequest request)
Update the compartment of the log analytics entity with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ChangeLogAnalyticsEntityCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeLogAnalyticsEntityCompartment API.
-
changeLogAnalyticsLogGroupCompartment
ChangeLogAnalyticsLogGroupCompartmentResponse changeLogAnalyticsLogGroupCompartment(ChangeLogAnalyticsLogGroupCompartmentRequest request)
Moves the specified log group to a different compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ChangeLogAnalyticsLogGroupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeLogAnalyticsLogGroupCompartment API.
-
changeLogAnalyticsObjectCollectionRuleCompartment
ChangeLogAnalyticsObjectCollectionRuleCompartmentResponse changeLogAnalyticsObjectCollectionRuleCompartment(ChangeLogAnalyticsObjectCollectionRuleCompartmentRequest request)
Move the rule from it’s current compartment to the given compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ChangeLogAnalyticsObjectCollectionRuleCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeLogAnalyticsObjectCollectionRuleCompartment API.
-
changeScheduledTaskCompartment
ChangeScheduledTaskCompartmentResponse changeScheduledTaskCompartment(ChangeScheduledTaskCompartmentRequest request)
Move the scheduled task into a different compartment within the same tenancy.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ChangeScheduledTaskCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeScheduledTaskCompartment API.
-
clean
CleanResponse clean(CleanRequest request)
Clean accumulated acceleration data stored for the accelerated saved search.The ScheduledTask taskType must be ACCELERATION.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CleanExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Clean API.
-
compareContent
CompareContentResponse compareContent(CompareContentRequest request)
Returns the difference between the two input payloads, including intraline differences.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CompareContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CompareContent API.
-
createIngestTimeRule
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CreateIngestTimeRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateIngestTimeRule API.
-
createLogAnalyticsEmBridge
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CreateLogAnalyticsEmBridgeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateLogAnalyticsEmBridge API.
-
createLogAnalyticsEntity
CreateLogAnalyticsEntityResponse createLogAnalyticsEntity(CreateLogAnalyticsEntityRequest request)
Create a new log analytics entity.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CreateLogAnalyticsEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateLogAnalyticsEntity API.
-
createLogAnalyticsEntityType
CreateLogAnalyticsEntityTypeResponse createLogAnalyticsEntityType(CreateLogAnalyticsEntityTypeRequest request)
Add custom log analytics entity type.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CreateLogAnalyticsEntityTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateLogAnalyticsEntityType API.
-
createLogAnalyticsLogGroup
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CreateLogAnalyticsLogGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateLogAnalyticsLogGroup API.
-
createLogAnalyticsObjectCollectionRule
CreateLogAnalyticsObjectCollectionRuleResponse createLogAnalyticsObjectCollectionRule(CreateLogAnalyticsObjectCollectionRuleRequest request)
Creates a rule to collect logs from an object storage bucket.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CreateLogAnalyticsObjectCollectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateLogAnalyticsObjectCollectionRule API.
-
createScheduledTask
CreateScheduledTaskResponse createScheduledTask(CreateScheduledTaskRequest request)
Schedule a task as specified and return task info.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/CreateScheduledTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateScheduledTask API.
-
deleteAssociations
DeleteAssociationsResponse deleteAssociations(DeleteAssociationsRequest request)
Deletes the associations between the sources and entities specified.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteAssociationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAssociations API.
-
deleteField
DeleteFieldResponse deleteField(DeleteFieldRequest request)
Deletes field with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteFieldExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteField API.
-
deleteIngestTimeRule
DeleteIngestTimeRuleResponse deleteIngestTimeRule(DeleteIngestTimeRuleRequest request)
Deletes the specified ingest time rule.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteIngestTimeRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteIngestTimeRule API.
-
deleteLabel
DeleteLabelResponse deleteLabel(DeleteLabelRequest request)
Deletes label with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteLabelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLabel API.
-
deleteLogAnalyticsEmBridge
DeleteLogAnalyticsEmBridgeResponse deleteLogAnalyticsEmBridge(DeleteLogAnalyticsEmBridgeRequest request)
Delete log analytics enterprise manager bridge with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteLogAnalyticsEmBridgeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLogAnalyticsEmBridge API.
-
deleteLogAnalyticsEntity
DeleteLogAnalyticsEntityResponse deleteLogAnalyticsEntity(DeleteLogAnalyticsEntityRequest request)
Delete log analytics entity with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteLogAnalyticsEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLogAnalyticsEntity API.
-
deleteLogAnalyticsEntityType
DeleteLogAnalyticsEntityTypeResponse deleteLogAnalyticsEntityType(DeleteLogAnalyticsEntityTypeRequest request)
Delete log analytics entity type with the given name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteLogAnalyticsEntityTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLogAnalyticsEntityType API.
-
deleteLogAnalyticsLogGroup
DeleteLogAnalyticsLogGroupResponse deleteLogAnalyticsLogGroup(DeleteLogAnalyticsLogGroupRequest request)
Deletes the specified log group.The log group cannot be part of an active association or have an active upload.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteLogAnalyticsLogGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLogAnalyticsLogGroup API.
-
deleteLogAnalyticsObjectCollectionRule
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteLogAnalyticsObjectCollectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLogAnalyticsObjectCollectionRule API.
-
deleteLookup
DeleteLookupResponse deleteLookup(DeleteLookupRequest request)
Deletes lookup with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteLookupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLookup API.
-
deleteParser
DeleteParserResponse deleteParser(DeleteParserRequest request)
Deletes parser with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteParserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteParser API.
-
deleteScheduledTask
DeleteScheduledTaskResponse deleteScheduledTask(DeleteScheduledTaskRequest request)
Delete the scheduled task.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteScheduledTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteScheduledTask API.
-
deleteSource
DeleteSourceResponse deleteSource(DeleteSourceRequest request)
Deletes source with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSource API.
-
deleteUpload
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteUploadExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteUpload API.
-
deleteUploadFile
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteUploadFileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteUploadFile API.
-
deleteUploadWarning
DeleteUploadWarningResponse deleteUploadWarning(DeleteUploadWarningRequest request)
Suppresses a specific warning inside an upload.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DeleteUploadWarningExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteUploadWarning API.
-
disableArchiving
DisableArchivingResponse disableArchiving(DisableArchivingRequest request)
This API disables archiving.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DisableArchivingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DisableArchiving API.
-
disableAutoAssociation
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DisableAutoAssociationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DisableAutoAssociation API.
-
disableIngestTimeRule
DisableIngestTimeRuleResponse disableIngestTimeRule(DisableIngestTimeRuleRequest request)
Disables the specified ingest time rule.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DisableIngestTimeRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DisableIngestTimeRule API.
-
disableSourceEventTypes
DisableSourceEventTypesResponse disableSourceEventTypes(DisableSourceEventTypesRequest request)
Disable one or more event types in a source.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/DisableSourceEventTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DisableSourceEventTypes API.
-
enableArchiving
EnableArchivingResponse enableArchiving(EnableArchivingRequest request)
THis API enables archiving.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/EnableArchivingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EnableArchiving API.
-
enableAutoAssociation
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/EnableAutoAssociationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EnableAutoAssociation API.
-
enableIngestTimeRule
EnableIngestTimeRuleResponse enableIngestTimeRule(EnableIngestTimeRuleRequest request)
Enables the specified ingest time rule.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/EnableIngestTimeRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EnableIngestTimeRule API.
-
enableSourceEventTypes
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/EnableSourceEventTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EnableSourceEventTypes API.
-
estimatePurgeDataSize
EstimatePurgeDataSizeResponse estimatePurgeDataSize(EstimatePurgeDataSizeRequest request)
This API estimates the size of data to be purged based based on time interval, purge query etc.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/EstimatePurgeDataSizeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EstimatePurgeDataSize API.
-
estimateRecallDataSize
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/EstimateRecallDataSizeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EstimateRecallDataSize API.
-
estimateReleaseDataSize
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/EstimateReleaseDataSizeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EstimateReleaseDataSize API.
-
exportCustomContent
ExportCustomContentResponse exportCustomContent(ExportCustomContentRequest request)
Exports all custom details of the specified sources, parsers, fields and labels, in zip format.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ExportCustomContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportCustomContent API.
-
exportQueryResult
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ExportQueryResultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportQueryResult API.
-
extractStructuredLogFieldPaths
ExtractStructuredLogFieldPathsResponse extractStructuredLogFieldPaths(ExtractStructuredLogFieldPathsRequest request)
Extracts the field paths from the example json or xml content.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ExtractStructuredLogFieldPathsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExtractStructuredLogFieldPaths API.
-
extractStructuredLogHeaderPaths
ExtractStructuredLogHeaderPathsResponse extractStructuredLogHeaderPaths(ExtractStructuredLogHeaderPathsRequest request)
Extracts the header paths from the example json or xml content.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ExtractStructuredLogHeaderPathsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExtractStructuredLogHeaderPaths API.
-
filter
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/FilterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Filter API.
-
getAssociationSummary
GetAssociationSummaryResponse getAssociationSummary(GetAssociationSummaryRequest request)
Returns the count of source associations for entities in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetAssociationSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAssociationSummary API.
-
getCategory
GetCategoryResponse getCategory(GetCategoryRequest request)
Gets detailed information about the category with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetCategoryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCategory API.
-
getColumnNames
GetColumnNamesResponse getColumnNames(GetColumnNamesRequest request)
Extracts column names from the input SQL query.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetColumnNamesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetColumnNames API.
-
getConfigWorkRequest
GetConfigWorkRequestResponse getConfigWorkRequest(GetConfigWorkRequestRequest request)
Returns detailed information about the configuration work request with the specified id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetConfigWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConfigWorkRequest API.
-
getField
GetFieldResponse getField(GetFieldRequest request)
Gets detailed information about the field with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetFieldExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetField API.
-
getFieldsSummary
GetFieldsSummaryResponse getFieldsSummary(GetFieldsSummaryRequest request)
Returns the count of fields.You may optionally specify isShowDetail=true to view a summary of each field data type.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetFieldsSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFieldsSummary API.
-
getIngestTimeRule
GetIngestTimeRuleResponse getIngestTimeRule(GetIngestTimeRuleRequest request)
Gets detailed information about the specified ingest time rule such as description, defined tags, and free-form tags.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetIngestTimeRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetIngestTimeRule API.
-
getLabel
GetLabelResponse getLabel(GetLabelRequest request)
Gets detailed information about the label with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLabelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLabel API.
-
getLabelSummary
GetLabelSummaryResponse getLabelSummary(GetLabelSummaryRequest request)
Returns the count of labels.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLabelSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLabelSummary API.
-
getLogAnalyticsEmBridge
GetLogAnalyticsEmBridgeResponse getLogAnalyticsEmBridge(GetLogAnalyticsEmBridgeRequest request)
Retrieve the log analytics enterprise manager bridge with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsEmBridgeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsEmBridge API.
-
getLogAnalyticsEmBridgeSummary
GetLogAnalyticsEmBridgeSummaryResponse getLogAnalyticsEmBridgeSummary(GetLogAnalyticsEmBridgeSummaryRequest request)
Returns log analytics enterprise manager bridges summary report.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsEmBridgeSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsEmBridgeSummary API.
-
getLogAnalyticsEntitiesSummary
GetLogAnalyticsEntitiesSummaryResponse getLogAnalyticsEntitiesSummary(GetLogAnalyticsEntitiesSummaryRequest request)
Returns log analytics entities count summary report.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsEntitiesSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsEntitiesSummary API.
-
getLogAnalyticsEntity
GetLogAnalyticsEntityResponse getLogAnalyticsEntity(GetLogAnalyticsEntityRequest request)
Retrieve the log analytics entity with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsEntity API.
-
getLogAnalyticsEntityType
GetLogAnalyticsEntityTypeResponse getLogAnalyticsEntityType(GetLogAnalyticsEntityTypeRequest request)
Retrieve the log analytics entity type with the given name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsEntityTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsEntityType API.
-
getLogAnalyticsLogGroup
GetLogAnalyticsLogGroupResponse getLogAnalyticsLogGroup(GetLogAnalyticsLogGroupRequest request)
Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsLogGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsLogGroup API.
-
getLogAnalyticsLogGroupsSummary
GetLogAnalyticsLogGroupsSummaryResponse getLogAnalyticsLogGroupsSummary(GetLogAnalyticsLogGroupsSummaryRequest request)
Returns the count of log groups in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsLogGroupsSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsLogGroupsSummary API.
-
getLogAnalyticsObjectCollectionRule
GetLogAnalyticsObjectCollectionRuleResponse getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleRequest request)
Gets a configured object storage based collection rule by given id- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogAnalyticsObjectCollectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogAnalyticsObjectCollectionRule API.
-
getLogSetsCount
GetLogSetsCountResponse getLogSetsCount(GetLogSetsCountRequest request)
This API returns the count of distinct log sets.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLogSetsCountExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLogSetsCount API.
-
getLookup
GetLookupResponse getLookup(GetLookupRequest request)
Gets detailed information about the lookup with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLookupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLookup API.
-
getLookupSummary
GetLookupSummaryResponse getLookupSummary(GetLookupSummaryRequest request)
Returns the count of user created and oracle defined lookups.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetLookupSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLookupSummary API.
-
getNamespace
GetNamespaceResponse getNamespace(GetNamespaceRequest request)
This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetNamespace API.
-
getParser
GetParserResponse getParser(GetParserRequest request)
Gets detailed information about the parser with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetParserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetParser API.
-
getParserSummary
GetParserSummaryResponse getParserSummary(GetParserSummaryRequest request)
Returns the count of parsers.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetParserSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetParserSummary API.
-
getPreferences
GetPreferencesResponse getPreferences(GetPreferencesRequest request)
Lists the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetPreferencesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPreferences API.
-
getQueryResult
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetQueryResultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetQueryResult API.
-
getQueryWorkRequest
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetQueryWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetQueryWorkRequest API.
-
getRecallCount
GetRecallCountResponse getRecallCount(GetRecallCountRequest request)
This API gets the number of recalls made and the maximum recalls that can be made- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetRecallCountExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRecallCount API.
-
getRecalledDataSize
GetRecalledDataSizeResponse getRecalledDataSize(GetRecalledDataSizeRequest request)
This API gets the datasize of recalls for a given timeframe- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetRecalledDataSizeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRecalledDataSize API.
-
getRulesSummary
GetRulesSummaryResponse getRulesSummary(GetRulesSummaryRequest request)
Returns the count of detection rules in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetRulesSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRulesSummary API.
-
getScheduledTask
GetScheduledTaskResponse getScheduledTask(GetScheduledTaskRequest request)
Get the scheduled task for the specified task identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetScheduledTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetScheduledTask API.
-
getSource
GetSourceResponse getSource(GetSourceRequest request)
Gets detailed information about the source with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSource API.
-
getSourceSummary
GetSourceSummaryResponse getSourceSummary(GetSourceSummaryRequest request)
Returns the count of sources.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetSourceSummaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSourceSummary API.
-
getStorage
GetStorageResponse getStorage(GetStorageRequest request)
This API gets the storage configuration of a tenancy- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetStorageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStorage API.
-
getStorageUsage
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetStorageUsageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStorageUsage API.
-
getStorageWorkRequest
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetStorageWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStorageWorkRequest API.
-
getUnprocessedDataBucket
GetUnprocessedDataBucketResponse getUnprocessedDataBucket(GetUnprocessedDataBucketRequest request)
This API retrieves details of the configured bucket that stores unprocessed payloads.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetUnprocessedDataBucketExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUnprocessedDataBucket API.
-
getUpload
GetUploadResponse getUpload(GetUploadRequest request)
Gets an On-Demand Upload info by reference.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetUploadExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUpload API.
-
getWorkRequest
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
-
importCustomContent
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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ImportCustomContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportCustomContent API.
-
listAssociableEntities
ListAssociableEntitiesResponse listAssociableEntities(ListAssociableEntitiesRequest request)
Lists the entities in the specified compartment which are (in)eligible for association with this source.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListAssociableEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAssociableEntities API.
-
listAssociatedEntities
ListAssociatedEntitiesResponse listAssociatedEntities(ListAssociatedEntitiesRequest request)
Lists the association details of entities in the specified compartment that are associated with at least one source.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListAssociatedEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAssociatedEntities API.
-
listAutoAssociations
ListAutoAssociationsResponse listAutoAssociations(ListAutoAssociationsRequest request)
Gets information related to auto association for the source with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListAutoAssociationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAutoAssociations API.
-
listCategories
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListCategoriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCategories API.
-
listConfigWorkRequests
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListConfigWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConfigWorkRequests API.
-
listEffectiveProperties
ListEffectivePropertiesResponse listEffectiveProperties(ListEffectivePropertiesRequest request)
Returns a list of effective properties for the specified resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListEffectivePropertiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEffectiveProperties API.
-
listEncryptionKeyInfo
ListEncryptionKeyInfoResponse listEncryptionKeyInfo(ListEncryptionKeyInfoRequest request)
This API returns the list of customer owned encryption key info.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListEncryptionKeyInfoExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEncryptionKeyInfo API.
-
listEntityAssociations
ListEntityAssociationsResponse listEntityAssociations(ListEntityAssociationsRequest request)
Return a list of log analytics entities associated with input source log analytics entity.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListEntityAssociationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEntityAssociations API.
-
listEntitySourceAssociations
ListEntitySourceAssociationsResponse listEntitySourceAssociations(ListEntitySourceAssociationsRequest request)
Returns the list of source associations for the specified entity.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListEntitySourceAssociationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEntitySourceAssociations API.
-
listFields
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListFieldsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFields API.
-
listIngestTimeRules
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListIngestTimeRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIngestTimeRules API.
-
listLabelPriorities
ListLabelPrioritiesResponse listLabelPriorities(ListLabelPrioritiesRequest request)
Lists the available problem priorities that could be associated with a label.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLabelPrioritiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLabelPriorities API.
-
listLabelSourceDetails
ListLabelSourceDetailsResponse listLabelSourceDetails(ListLabelSourceDetailsRequest request)
Lists sources using the label, along with configuration details like base field, operator and condition.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLabelSourceDetailsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLabelSourceDetails API.
-
listLabels
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLabelsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLabels API.
-
listLogAnalyticsEmBridges
ListLogAnalyticsEmBridgesResponse listLogAnalyticsEmBridges(ListLogAnalyticsEmBridgesRequest request)
Return a list of log analytics enterprise manager bridges.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLogAnalyticsEmBridgesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogAnalyticsEmBridges API.
-
listLogAnalyticsEntities
ListLogAnalyticsEntitiesResponse listLogAnalyticsEntities(ListLogAnalyticsEntitiesRequest request)
Return a list of log analytics entities.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLogAnalyticsEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogAnalyticsEntities API.
-
listLogAnalyticsEntityTopology
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLogAnalyticsEntityTopologyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogAnalyticsEntityTopology API.
-
listLogAnalyticsEntityTypes
ListLogAnalyticsEntityTypesResponse listLogAnalyticsEntityTypes(ListLogAnalyticsEntityTypesRequest request)
Return a list of log analytics entity types.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLogAnalyticsEntityTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogAnalyticsEntityTypes API.
-
listLogAnalyticsLogGroups
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLogAnalyticsLogGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogAnalyticsLogGroups API.
-
listLogAnalyticsObjectCollectionRules
ListLogAnalyticsObjectCollectionRulesResponse listLogAnalyticsObjectCollectionRules(ListLogAnalyticsObjectCollectionRulesRequest request)
Gets list of collection rules.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLogAnalyticsObjectCollectionRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogAnalyticsObjectCollectionRules API.
-
listLogSets
ListLogSetsResponse listLogSets(ListLogSetsRequest request)
This API returns a list of log sets.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLogSetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogSets API.
-
listLookups
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListLookupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLookups API.
-
listMetaSourceTypes
ListMetaSourceTypesResponse listMetaSourceTypes(ListMetaSourceTypesRequest request)
Lists the types of log sources supported.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListMetaSourceTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMetaSourceTypes API.
-
listNamespaces
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListNamespacesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListNamespaces API.
-
listOverlappingRecalls
ListOverlappingRecallsResponse listOverlappingRecalls(ListOverlappingRecallsRequest request)
This API gets the list of overlapping recalls made in the given timeframe- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListOverlappingRecallsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOverlappingRecalls API.
-
listParserFunctions
ListParserFunctionsResponse listParserFunctions(ListParserFunctionsRequest request)
Lists the parser functions defined for the specified parser.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListParserFunctionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListParserFunctions API.
-
listParserMetaPlugins
ListParserMetaPluginsResponse listParserMetaPlugins(ListParserMetaPluginsRequest request)
Lists the parser meta plugins available for defining parser functions.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListParserMetaPluginsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListParserMetaPlugins API.
-
listParsers
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListParsersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListParsers API.
-
listPropertiesMetadata
ListPropertiesMetadataResponse listPropertiesMetadata(ListPropertiesMetadataRequest request)
Returns a list of properties along with their metadata.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListPropertiesMetadataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPropertiesMetadata API.
-
listQueryWorkRequests
ListQueryWorkRequestsResponse listQueryWorkRequests(ListQueryWorkRequestsRequest request)
List active asynchronous queries.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListQueryWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListQueryWorkRequests API.
-
listRecalledData
ListRecalledDataResponse listRecalledData(ListRecalledDataRequest request)
This API returns the list of recalled data of a tenancy.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListRecalledDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRecalledData API.
-
listResourceCategories
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListResourceCategoriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListResourceCategories API.
-
listRules
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRules API.
-
listScheduledTasks
ListScheduledTasksResponse listScheduledTasks(ListScheduledTasksRequest request)
Lists scheduled tasks.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListScheduledTasksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListScheduledTasks API.
-
listSourceAssociations
ListSourceAssociationsResponse listSourceAssociations(ListSourceAssociationsRequest request)
Returns the list of entity associations in the input compartment for the specified source.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSourceAssociationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSourceAssociations API.
-
listSourceEventTypes
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSourceEventTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSourceEventTypes API.
-
listSourceExtendedFieldDefinitions
ListSourceExtendedFieldDefinitionsResponse listSourceExtendedFieldDefinitions(ListSourceExtendedFieldDefinitionsRequest request)
Lists the extended field definitions for the source with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSourceExtendedFieldDefinitionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSourceExtendedFieldDefinitions API.
-
listSourceLabelOperators
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSourceLabelOperatorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSourceLabelOperators API.
-
listSourceMetaFunctions
ListSourceMetaFunctionsResponse listSourceMetaFunctions(ListSourceMetaFunctionsRequest request)
Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSourceMetaFunctionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSourceMetaFunctions API.
-
listSourcePatterns
ListSourcePatternsResponse listSourcePatterns(ListSourcePatternsRequest request)
Lists the source patterns for the source with the specified name.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSourcePatternsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSourcePatterns API.
-
listSources
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSources API.
-
listStorageWorkRequestErrors
ListStorageWorkRequestErrorsResponse listStorageWorkRequestErrors(ListStorageWorkRequestErrorsRequest request)
This API returns the list of work request errors if any.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListStorageWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStorageWorkRequestErrors API.
-
listStorageWorkRequests
ListStorageWorkRequestsResponse listStorageWorkRequests(ListStorageWorkRequestsRequest request)
This API lists storage work requests.Use query parameters to narrow down or sort the result list.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListStorageWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStorageWorkRequests API.
-
listSupportedCharEncodings
ListSupportedCharEncodingsResponse listSupportedCharEncodings(ListSupportedCharEncodingsRequest request)
Gets list of character encodings which are supported by on-demand upload.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSupportedCharEncodingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSupportedCharEncodings API.
-
listSupportedTimezones
ListSupportedTimezonesResponse listSupportedTimezones(ListSupportedTimezonesRequest request)
Gets list of timezones which are supported by on-demand upload.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListSupportedTimezonesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSupportedTimezones API.
-
listUploadFiles
ListUploadFilesResponse listUploadFiles(ListUploadFilesRequest request)
Gets list of files in an upload along with its processing state.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListUploadFilesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUploadFiles API.
-
listUploadWarnings
ListUploadWarningsResponse listUploadWarnings(ListUploadWarningsRequest request)
Gets list of warnings in an upload caused by incorrect configuration.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListUploadWarningsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUploadWarnings API.
-
listUploads
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListUploadsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUploads API.
-
listWarnings
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListWarningsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWarnings API.
-
listWorkRequestErrors
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
-
listWorkRequestLogs
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
-
listWorkRequests
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
offboardNamespace
OffboardNamespaceResponse offboardNamespace(OffboardNamespaceRequest request)
Off-boards a tenant from Logging Analytics- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/OffboardNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use OffboardNamespace API.
-
onboardNamespace
OnboardNamespaceResponse onboardNamespace(OnboardNamespaceRequest request)
On-boards a tenant to Logging Analytics.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/OnboardNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use OnboardNamespace API.
-
parseQuery
ParseQueryResponse parseQuery(ParseQueryRequest request)
Describe query- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ParseQueryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ParseQuery API.
-
pauseScheduledTask
PauseScheduledTaskResponse pauseScheduledTask(PauseScheduledTaskRequest request)
Pause the scheduled task specified by {scheduledTaskId}.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/PauseScheduledTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PauseScheduledTask API.
-
purgeStorageData
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/PurgeStorageDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PurgeStorageData API.
-
putQueryWorkRequestBackground
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/PutQueryWorkRequestBackgroundExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PutQueryWorkRequestBackground API.
-
query
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/QueryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Query API.
-
recallArchivedData
RecallArchivedDataResponse recallArchivedData(RecallArchivedDataRequest request)
This API submits a work request to recall archived data based on time interval and data type.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/RecallArchivedDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RecallArchivedData API.
-
registerLookup
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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/RegisterLookupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RegisterLookup API.
-
releaseRecalledData
ReleaseRecalledDataResponse releaseRecalledData(ReleaseRecalledDataRequest request)
This API submits a work request to release recalled data based on time interval and data type.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ReleaseRecalledDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ReleaseRecalledData API.
-
removeEntityAssociations
RemoveEntityAssociationsResponse removeEntityAssociations(RemoveEntityAssociationsRequest request)
Delete association between input source log analytics entity and destination entities.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/RemoveEntityAssociationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveEntityAssociations API.
-
removePreferences
RemovePreferencesResponse removePreferences(RemovePreferencesRequest request)
Removes the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/RemovePreferencesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemovePreferences API.
-
removeResourceCategories
RemoveResourceCategoriesResponse removeResourceCategories(RemoveResourceCategoriesRequest request)
Removes the category assignments of DASHBOARD and SAVEDSEARCH resources.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/RemoveResourceCategoriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveResourceCategories API.
-
removeSourceEventTypes
RemoveSourceEventTypesResponse removeSourceEventTypes(RemoveSourceEventTypesRequest request)
Remove one or more event types from a source.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/RemoveSourceEventTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveSourceEventTypes API.
-
resumeScheduledTask
ResumeScheduledTaskResponse resumeScheduledTask(ResumeScheduledTaskRequest request)
Resume the scheduled task specified by {scheduledTaskId}.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ResumeScheduledTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ResumeScheduledTask API.
-
run
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/RunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Run API.
-
setUnprocessedDataBucket
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/SetUnprocessedDataBucketExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SetUnprocessedDataBucket API.
-
suggest
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/SuggestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Suggest API.
-
suppressWarning
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/SuppressWarningExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SuppressWarning API.
-
testParser
TestParserResponse testParser(TestParserRequest request)
Tests the parser definition against the specified example content to ensure fields are successfully extracted.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/TestParserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use TestParser API.
-
unsuppressWarning
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UnsuppressWarningExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UnsuppressWarning API.
-
updateIngestTimeRule
UpdateIngestTimeRuleResponse updateIngestTimeRule(UpdateIngestTimeRuleRequest request)
Updates the specified ingest time rule’s description, defined tags, and free-form tags.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateIngestTimeRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateIngestTimeRule API.
-
updateLogAnalyticsEmBridge
UpdateLogAnalyticsEmBridgeResponse updateLogAnalyticsEmBridge(UpdateLogAnalyticsEmBridgeRequest request)
Update log analytics enterprise manager bridge with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateLogAnalyticsEmBridgeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLogAnalyticsEmBridge API.
-
updateLogAnalyticsEntity
UpdateLogAnalyticsEntityResponse updateLogAnalyticsEntity(UpdateLogAnalyticsEntityRequest request)
Update the log analytics entity with the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateLogAnalyticsEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLogAnalyticsEntity API.
-
updateLogAnalyticsEntityType
UpdateLogAnalyticsEntityTypeResponse updateLogAnalyticsEntityType(UpdateLogAnalyticsEntityTypeRequest request)
Update custom log analytics entity type.Out of box entity types cannot be udpated.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateLogAnalyticsEntityTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLogAnalyticsEntityType API.
-
updateLogAnalyticsLogGroup
UpdateLogAnalyticsLogGroupResponse updateLogAnalyticsLogGroup(UpdateLogAnalyticsLogGroupRequest request)
Updates the specified log group’s display name, description, defined tags, and free-form tags.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateLogAnalyticsLogGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLogAnalyticsLogGroup API.
-
updateLogAnalyticsObjectCollectionRule
UpdateLogAnalyticsObjectCollectionRuleResponse updateLogAnalyticsObjectCollectionRule(UpdateLogAnalyticsObjectCollectionRuleRequest request)
Updates configuration of the object collection rule for the given id.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateLogAnalyticsObjectCollectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLogAnalyticsObjectCollectionRule API.
-
updateLookup
UpdateLookupResponse updateLookup(UpdateLookupRequest request)
Updates the metadata of the specified lookup, such as the lookup description.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateLookupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLookup API.
-
updateLookupData
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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateLookupDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLookupData API.
-
updatePreferences
UpdatePreferencesResponse updatePreferences(UpdatePreferencesRequest request)
Updates the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdatePreferencesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePreferences API.
-
updateResourceCategories
UpdateResourceCategoriesResponse updateResourceCategories(UpdateResourceCategoriesRequest request)
Updates the category assignments of DASHBOARD and SAVEDSEARCH resources.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateResourceCategoriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateResourceCategories API.
-
updateScheduledTask
UpdateScheduledTaskResponse updateScheduledTask(UpdateScheduledTaskRequest request)
Update the scheduled task.Schedules may be updated only for taskType SAVED_SEARCH and PURGE.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateScheduledTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateScheduledTask API.
-
updateStorage
UpdateStorageResponse updateStorage(UpdateStorageRequest request)
This API updates the archiving configuration- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpdateStorageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateStorage API.
-
uploadDiscoveryData
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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UploadDiscoveryDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UploadDiscoveryData API.
-
uploadLogEventsFile
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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UploadLogEventsFileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UploadLogEventsFile API.
-
uploadLogFile
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)
andInputStream.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 toInputStream.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'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
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)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, 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
whoseFileChannel
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UploadLogFileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UploadLogFile API.
-
upsertAssociations
UpsertAssociationsResponse upsertAssociations(UpsertAssociationsRequest request)
Creates or updates associations between sources and entities.All entities should belong to the specified input compartment.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpsertAssociationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpsertAssociations API.
-
upsertField
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpsertFieldExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpsertField API.
-
upsertLabel
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpsertLabelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpsertLabel API.
-
upsertParser
UpsertParserResponse upsertParser(UpsertParserRequest request)
Creates or updates a parser, which defines how fields are extracted from a log entry.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpsertParserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpsertParser API.
-
upsertSource
UpsertSourceResponse upsertSource(UpsertSourceRequest request)
Creates or updates a log source.You may also specify parsers, labels, extended fields etc., for the source.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/UpsertSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpsertSource API.
-
validateAssociationParameters
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ValidateAssociationParametersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateAssociationParameters API.
-
validateEndpoint
ValidateEndpointResponse validateEndpoint(ValidateEndpointRequest request)
Validates the REST endpoint configuration.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ValidateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateEndpoint API.
-
validateFile
ValidateFileResponse validateFile(ValidateFileRequest request)
Validates a log file to check whether it is eligible to be uploaded or not.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ValidateFileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateFile API.
-
validateLabelCondition
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ValidateLabelConditionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateLabelCondition API.
-
validateSource
ValidateSourceResponse validateSource(ValidateSourceRequest request)
Checks if the specified input is a valid log source definition.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ValidateSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateSource API.
-
validateSourceExtendedFieldDetails
ValidateSourceExtendedFieldDetailsResponse validateSourceExtendedFieldDetails(ValidateSourceExtendedFieldDetailsRequest request)
Checks if the specified input contains valid extended field definitions against the provided example content.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ValidateSourceExtendedFieldDetailsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateSourceExtendedFieldDetails API.
-
validateSourceMapping
ValidateSourceMappingResponse validateSourceMapping(ValidateSourceMappingRequest request)
Validates the source mapping for a given file and provides match status and the parsed representation of log data.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/ValidateSourceMappingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateSourceMapping API.
-
verify
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loganalytics/VerifyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Verify API.
-
getWaiters
LogAnalyticsWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
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.- Returns:
- The service paginators.
-
-