Class LogAnalyticsClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.loganalytics.LogAnalyticsClient
-
- All Implemented Interfaces:
LogAnalytics
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200601") public class LogAnalyticsClient extends BaseSyncClient implements LogAnalytics
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LogAnalyticsClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for LogAnalytics.
-
Constructor Summary
Constructors Constructor Description LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.LogAnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.LogAnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.LogAnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete 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.static LogAnalyticsClient.Builder
builder()
Create a builder for this client.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.void
close()
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.String
getClientCommonLibraryVersion()
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.protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
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.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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}.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.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()
Rebuild the backingHttpClient
.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)
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.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.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 useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.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 class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.loganalytics.LogAnalytics
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
LogAnalyticsClient
@Deprecated public LogAnalyticsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLogAnalyticsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-LogAnalyticsClient.Builder.executorService
-
-
Method Detail
-
builder
public static LogAnalyticsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:LogAnalytics
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.- Specified by:
setRegion
in interfaceLogAnalytics
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:LogAnalytics
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
.- Specified by:
setRegion
in interfaceLogAnalytics
- Parameters:
regionId
- The public region ID.
-
addEntityAssociation
public AddEntityAssociationResponse addEntityAssociation(AddEntityAssociationRequest request)
Description copied from interface:LogAnalytics
Adds association between input source log analytics entity and one or more existing destination entities.- Specified by:
addEntityAssociation
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addSourceEventTypes
public AddSourceEventTypesResponse addSourceEventTypes(AddSourceEventTypesRequest request)
Description copied from interface:LogAnalytics
Add one or more event types to a source.An event type and version can be enabled only on one source.
- Specified by:
addSourceEventTypes
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
appendLookupData
public AppendLookupDataResponse appendLookupData(AppendLookupDataRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
appendLookupData
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
assignEncryptionKey
public AssignEncryptionKeyResponse assignEncryptionKey(AssignEncryptionKeyRequest request)
Description copied from interface:LogAnalytics
This API submits a work request to assign customer encryption key.- Specified by:
assignEncryptionKey
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
batchGetBasicInfo
public BatchGetBasicInfoResponse batchGetBasicInfo(BatchGetBasicInfoRequest request)
Description copied from interface:LogAnalytics
Lists basic information about a specified set of labels in batch.- Specified by:
batchGetBasicInfo
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelQueryWorkRequest
public CancelQueryWorkRequestResponse cancelQueryWorkRequest(CancelQueryWorkRequestRequest request)
Description copied from interface:LogAnalytics
Cancel/Remove query job work request.- Specified by:
cancelQueryWorkRequest
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeIngestTimeRuleCompartment
public ChangeIngestTimeRuleCompartmentResponse changeIngestTimeRuleCompartment(ChangeIngestTimeRuleCompartmentRequest request)
Description copied from interface:LogAnalytics
Moves the specified ingest time rule to a different compartment.- Specified by:
changeIngestTimeRuleCompartment
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeLogAnalyticsEmBridgeCompartment
public ChangeLogAnalyticsEmBridgeCompartmentResponse changeLogAnalyticsEmBridgeCompartment(ChangeLogAnalyticsEmBridgeCompartmentRequest request)
Description copied from interface:LogAnalytics
Update the compartment of the log analytics enterprise manager bridge with the given id.- Specified by:
changeLogAnalyticsEmBridgeCompartment
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeLogAnalyticsEntityCompartment
public ChangeLogAnalyticsEntityCompartmentResponse changeLogAnalyticsEntityCompartment(ChangeLogAnalyticsEntityCompartmentRequest request)
Description copied from interface:LogAnalytics
Update the compartment of the log analytics entity with the given id.- Specified by:
changeLogAnalyticsEntityCompartment
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeLogAnalyticsLogGroupCompartment
public ChangeLogAnalyticsLogGroupCompartmentResponse changeLogAnalyticsLogGroupCompartment(ChangeLogAnalyticsLogGroupCompartmentRequest request)
Description copied from interface:LogAnalytics
Moves the specified log group to a different compartment.- Specified by:
changeLogAnalyticsLogGroupCompartment
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeLogAnalyticsObjectCollectionRuleCompartment
public ChangeLogAnalyticsObjectCollectionRuleCompartmentResponse changeLogAnalyticsObjectCollectionRuleCompartment(ChangeLogAnalyticsObjectCollectionRuleCompartmentRequest request)
Description copied from interface:LogAnalytics
Move the rule from it’s current compartment to the given compartment.- Specified by:
changeLogAnalyticsObjectCollectionRuleCompartment
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeScheduledTaskCompartment
public ChangeScheduledTaskCompartmentResponse changeScheduledTaskCompartment(ChangeScheduledTaskCompartmentRequest request)
Description copied from interface:LogAnalytics
Move the scheduled task into a different compartment within the same tenancy.- Specified by:
changeScheduledTaskCompartment
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
clean
public CleanResponse clean(CleanRequest request)
Description copied from interface:LogAnalytics
Clean accumulated acceleration data stored for the accelerated saved search.The ScheduledTask taskType must be ACCELERATION.
- Specified by:
clean
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
compareContent
public CompareContentResponse compareContent(CompareContentRequest request)
Description copied from interface:LogAnalytics
Returns the difference between the two input payloads, including intraline differences.- Specified by:
compareContent
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createIngestTimeRule
public CreateIngestTimeRuleResponse createIngestTimeRule(CreateIngestTimeRuleRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
createIngestTimeRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLogAnalyticsEmBridge
public CreateLogAnalyticsEmBridgeResponse createLogAnalyticsEmBridge(CreateLogAnalyticsEmBridgeRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
createLogAnalyticsEmBridge
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLogAnalyticsEntity
public CreateLogAnalyticsEntityResponse createLogAnalyticsEntity(CreateLogAnalyticsEntityRequest request)
Description copied from interface:LogAnalytics
Create a new log analytics entity.- Specified by:
createLogAnalyticsEntity
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLogAnalyticsEntityType
public CreateLogAnalyticsEntityTypeResponse createLogAnalyticsEntityType(CreateLogAnalyticsEntityTypeRequest request)
Description copied from interface:LogAnalytics
Add custom log analytics entity type.- Specified by:
createLogAnalyticsEntityType
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLogAnalyticsLogGroup
public CreateLogAnalyticsLogGroupResponse createLogAnalyticsLogGroup(CreateLogAnalyticsLogGroupRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
createLogAnalyticsLogGroup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLogAnalyticsObjectCollectionRule
public CreateLogAnalyticsObjectCollectionRuleResponse createLogAnalyticsObjectCollectionRule(CreateLogAnalyticsObjectCollectionRuleRequest request)
Description copied from interface:LogAnalytics
Creates a rule to collect logs from an object storage bucket.- Specified by:
createLogAnalyticsObjectCollectionRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createScheduledTask
public CreateScheduledTaskResponse createScheduledTask(CreateScheduledTaskRequest request)
Description copied from interface:LogAnalytics
Schedule a task as specified and return task info.- Specified by:
createScheduledTask
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAssociations
public DeleteAssociationsResponse deleteAssociations(DeleteAssociationsRequest request)
Description copied from interface:LogAnalytics
Deletes the associations between the sources and entities specified.- Specified by:
deleteAssociations
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteField
public DeleteFieldResponse deleteField(DeleteFieldRequest request)
Description copied from interface:LogAnalytics
Deletes field with the specified name.- Specified by:
deleteField
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteIngestTimeRule
public DeleteIngestTimeRuleResponse deleteIngestTimeRule(DeleteIngestTimeRuleRequest request)
Description copied from interface:LogAnalytics
Deletes the specified ingest time rule.- Specified by:
deleteIngestTimeRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLabel
public DeleteLabelResponse deleteLabel(DeleteLabelRequest request)
Description copied from interface:LogAnalytics
Deletes label with the specified name.- Specified by:
deleteLabel
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLogAnalyticsEmBridge
public DeleteLogAnalyticsEmBridgeResponse deleteLogAnalyticsEmBridge(DeleteLogAnalyticsEmBridgeRequest request)
Description copied from interface:LogAnalytics
Delete log analytics enterprise manager bridge with the given id.- Specified by:
deleteLogAnalyticsEmBridge
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLogAnalyticsEntity
public DeleteLogAnalyticsEntityResponse deleteLogAnalyticsEntity(DeleteLogAnalyticsEntityRequest request)
Description copied from interface:LogAnalytics
Delete log analytics entity with the given id.- Specified by:
deleteLogAnalyticsEntity
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLogAnalyticsEntityType
public DeleteLogAnalyticsEntityTypeResponse deleteLogAnalyticsEntityType(DeleteLogAnalyticsEntityTypeRequest request)
Description copied from interface:LogAnalytics
Delete log analytics entity type with the given name.- Specified by:
deleteLogAnalyticsEntityType
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLogAnalyticsLogGroup
public DeleteLogAnalyticsLogGroupResponse deleteLogAnalyticsLogGroup(DeleteLogAnalyticsLogGroupRequest request)
Description copied from interface:LogAnalytics
Deletes the specified log group.The log group cannot be part of an active association or have an active upload.
- Specified by:
deleteLogAnalyticsLogGroup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLogAnalyticsObjectCollectionRule
public DeleteLogAnalyticsObjectCollectionRuleResponse deleteLogAnalyticsObjectCollectionRule(DeleteLogAnalyticsObjectCollectionRuleRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
deleteLogAnalyticsObjectCollectionRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLookup
public DeleteLookupResponse deleteLookup(DeleteLookupRequest request)
Description copied from interface:LogAnalytics
Deletes lookup with the specified name.- Specified by:
deleteLookup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteParser
public DeleteParserResponse deleteParser(DeleteParserRequest request)
Description copied from interface:LogAnalytics
Deletes parser with the specified name.- Specified by:
deleteParser
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteScheduledTask
public DeleteScheduledTaskResponse deleteScheduledTask(DeleteScheduledTaskRequest request)
Description copied from interface:LogAnalytics
Delete the scheduled task.- Specified by:
deleteScheduledTask
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSource
public DeleteSourceResponse deleteSource(DeleteSourceRequest request)
Description copied from interface:LogAnalytics
Deletes source with the specified name.- Specified by:
deleteSource
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteUpload
public DeleteUploadResponse deleteUpload(DeleteUploadRequest request)
Description copied from interface:LogAnalytics
Deletes an Upload by its reference.It deletes all the logs in storage asscoiated with the upload and the corresponding upload metadata.
- Specified by:
deleteUpload
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteUploadFile
public DeleteUploadFileResponse deleteUploadFile(DeleteUploadFileRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
deleteUploadFile
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteUploadWarning
public DeleteUploadWarningResponse deleteUploadWarning(DeleteUploadWarningRequest request)
Description copied from interface:LogAnalytics
Suppresses a specific warning inside an upload.- Specified by:
deleteUploadWarning
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
disableArchiving
public DisableArchivingResponse disableArchiving(DisableArchivingRequest request)
Description copied from interface:LogAnalytics
This API disables archiving.- Specified by:
disableArchiving
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
disableAutoAssociation
public DisableAutoAssociationResponse disableAutoAssociation(DisableAutoAssociationRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
disableAutoAssociation
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
disableIngestTimeRule
public DisableIngestTimeRuleResponse disableIngestTimeRule(DisableIngestTimeRuleRequest request)
Description copied from interface:LogAnalytics
Disables the specified ingest time rule.- Specified by:
disableIngestTimeRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
disableSourceEventTypes
public DisableSourceEventTypesResponse disableSourceEventTypes(DisableSourceEventTypesRequest request)
Description copied from interface:LogAnalytics
Disable one or more event types in a source.- Specified by:
disableSourceEventTypes
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
enableArchiving
public EnableArchivingResponse enableArchiving(EnableArchivingRequest request)
Description copied from interface:LogAnalytics
THis API enables archiving.- Specified by:
enableArchiving
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
enableAutoAssociation
public EnableAutoAssociationResponse enableAutoAssociation(EnableAutoAssociationRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
enableAutoAssociation
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
enableIngestTimeRule
public EnableIngestTimeRuleResponse enableIngestTimeRule(EnableIngestTimeRuleRequest request)
Description copied from interface:LogAnalytics
Enables the specified ingest time rule.- Specified by:
enableIngestTimeRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
enableSourceEventTypes
public EnableSourceEventTypesResponse enableSourceEventTypes(EnableSourceEventTypesRequest request)
Description copied from interface:LogAnalytics
Enable one or more event types in a source.An event type and version can be enabled only in one source.
- Specified by:
enableSourceEventTypes
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
estimatePurgeDataSize
public EstimatePurgeDataSizeResponse estimatePurgeDataSize(EstimatePurgeDataSizeRequest request)
Description copied from interface:LogAnalytics
This API estimates the size of data to be purged based based on time interval, purge query etc.- Specified by:
estimatePurgeDataSize
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
estimateRecallDataSize
public EstimateRecallDataSizeResponse estimateRecallDataSize(EstimateRecallDataSizeRequest request)
Description copied from interface:LogAnalytics
This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.- Specified by:
estimateRecallDataSize
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
estimateReleaseDataSize
public EstimateReleaseDataSizeResponse estimateReleaseDataSize(EstimateReleaseDataSizeRequest request)
Description copied from interface:LogAnalytics
This API gives an active storage usage estimate for recalled data to be released and the time range of such data.- Specified by:
estimateReleaseDataSize
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportCustomContent
public ExportCustomContentResponse exportCustomContent(ExportCustomContentRequest request)
Description copied from interface:LogAnalytics
Exports all custom details of the specified sources, parsers, fields and labels, in zip format.- Specified by:
exportCustomContent
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportQueryResult
public ExportQueryResultResponse exportQueryResult(ExportQueryResultRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
exportQueryResult
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
extractStructuredLogFieldPaths
public ExtractStructuredLogFieldPathsResponse extractStructuredLogFieldPaths(ExtractStructuredLogFieldPathsRequest request)
Description copied from interface:LogAnalytics
Extracts the field paths from the example json or xml content.- Specified by:
extractStructuredLogFieldPaths
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
extractStructuredLogHeaderPaths
public ExtractStructuredLogHeaderPathsResponse extractStructuredLogHeaderPaths(ExtractStructuredLogHeaderPathsRequest request)
Description copied from interface:LogAnalytics
Extracts the header paths from the example json or xml content.- Specified by:
extractStructuredLogHeaderPaths
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
filter
public FilterResponse filter(FilterRequest request)
Description copied from interface:LogAnalytics
Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.- Specified by:
filter
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAssociationSummary
public GetAssociationSummaryResponse getAssociationSummary(GetAssociationSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of source associations for entities in the specified compartment.- Specified by:
getAssociationSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCategory
public GetCategoryResponse getCategory(GetCategoryRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the category with the specified name.- Specified by:
getCategory
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getColumnNames
public GetColumnNamesResponse getColumnNames(GetColumnNamesRequest request)
Description copied from interface:LogAnalytics
Extracts column names from the input SQL query.- Specified by:
getColumnNames
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConfigWorkRequest
public GetConfigWorkRequestResponse getConfigWorkRequest(GetConfigWorkRequestRequest request)
Description copied from interface:LogAnalytics
Returns detailed information about the configuration work request with the specified id.- Specified by:
getConfigWorkRequest
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getField
public GetFieldResponse getField(GetFieldRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the field with the specified name.- Specified by:
getField
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFieldsSummary
public GetFieldsSummaryResponse getFieldsSummary(GetFieldsSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of fields.You may optionally specify isShowDetail=true to view a summary of each field data type.
- Specified by:
getFieldsSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getIngestTimeRule
public GetIngestTimeRuleResponse getIngestTimeRule(GetIngestTimeRuleRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the specified ingest time rule such as description, defined tags, and free-form tags.- Specified by:
getIngestTimeRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLabel
public GetLabelResponse getLabel(GetLabelRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the label with the specified name.- Specified by:
getLabel
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLabelSummary
public GetLabelSummaryResponse getLabelSummary(GetLabelSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of labels.- Specified by:
getLabelSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsEmBridge
public GetLogAnalyticsEmBridgeResponse getLogAnalyticsEmBridge(GetLogAnalyticsEmBridgeRequest request)
Description copied from interface:LogAnalytics
Retrieve the log analytics enterprise manager bridge with the given id.- Specified by:
getLogAnalyticsEmBridge
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsEmBridgeSummary
public GetLogAnalyticsEmBridgeSummaryResponse getLogAnalyticsEmBridgeSummary(GetLogAnalyticsEmBridgeSummaryRequest request)
Description copied from interface:LogAnalytics
Returns log analytics enterprise manager bridges summary report.- Specified by:
getLogAnalyticsEmBridgeSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsEntitiesSummary
public GetLogAnalyticsEntitiesSummaryResponse getLogAnalyticsEntitiesSummary(GetLogAnalyticsEntitiesSummaryRequest request)
Description copied from interface:LogAnalytics
Returns log analytics entities count summary report.- Specified by:
getLogAnalyticsEntitiesSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsEntity
public GetLogAnalyticsEntityResponse getLogAnalyticsEntity(GetLogAnalyticsEntityRequest request)
Description copied from interface:LogAnalytics
Retrieve the log analytics entity with the given id.- Specified by:
getLogAnalyticsEntity
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsEntityType
public GetLogAnalyticsEntityTypeResponse getLogAnalyticsEntityType(GetLogAnalyticsEntityTypeRequest request)
Description copied from interface:LogAnalytics
Retrieve the log analytics entity type with the given name.- Specified by:
getLogAnalyticsEntityType
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsLogGroup
public GetLogAnalyticsLogGroupResponse getLogAnalyticsLogGroup(GetLogAnalyticsLogGroupRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.- Specified by:
getLogAnalyticsLogGroup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsLogGroupsSummary
public GetLogAnalyticsLogGroupsSummaryResponse getLogAnalyticsLogGroupsSummary(GetLogAnalyticsLogGroupsSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of log groups in a compartment.- Specified by:
getLogAnalyticsLogGroupsSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogAnalyticsObjectCollectionRule
public GetLogAnalyticsObjectCollectionRuleResponse getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleRequest request)
Description copied from interface:LogAnalytics
Gets a configured object storage based collection rule by given id- Specified by:
getLogAnalyticsObjectCollectionRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLogSetsCount
public GetLogSetsCountResponse getLogSetsCount(GetLogSetsCountRequest request)
Description copied from interface:LogAnalytics
This API returns the count of distinct log sets.- Specified by:
getLogSetsCount
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLookup
public GetLookupResponse getLookup(GetLookupRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the lookup with the specified name.- Specified by:
getLookup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLookupSummary
public GetLookupSummaryResponse getLookupSummary(GetLookupSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of user created and oracle defined lookups.- Specified by:
getLookupSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getNamespace
public GetNamespaceResponse getNamespace(GetNamespaceRequest request)
Description copied from interface:LogAnalytics
This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application- Specified by:
getNamespace
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getParser
public GetParserResponse getParser(GetParserRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the parser with the specified name.- Specified by:
getParser
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getParserSummary
public GetParserSummaryResponse getParserSummary(GetParserSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of parsers.- Specified by:
getParserSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPreferences
public GetPreferencesResponse getPreferences(GetPreferencesRequest request)
Description copied from interface:LogAnalytics
Lists the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.- Specified by:
getPreferences
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getQueryResult
public GetQueryResultResponse getQueryResult(GetQueryResultRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
getQueryResult
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getQueryWorkRequest
public GetQueryWorkRequestResponse getQueryWorkRequest(GetQueryWorkRequestRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
getQueryWorkRequest
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRecallCount
public GetRecallCountResponse getRecallCount(GetRecallCountRequest request)
Description copied from interface:LogAnalytics
This API gets the number of recalls made and the maximum recalls that can be made- Specified by:
getRecallCount
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRecalledDataSize
public GetRecalledDataSizeResponse getRecalledDataSize(GetRecalledDataSizeRequest request)
Description copied from interface:LogAnalytics
This API gets the datasize of recalls for a given timeframe- Specified by:
getRecalledDataSize
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRulesSummary
public GetRulesSummaryResponse getRulesSummary(GetRulesSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of detection rules in a compartment.- Specified by:
getRulesSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getScheduledTask
public GetScheduledTaskResponse getScheduledTask(GetScheduledTaskRequest request)
Description copied from interface:LogAnalytics
Get the scheduled task for the specified task identifier.- Specified by:
getScheduledTask
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSource
public GetSourceResponse getSource(GetSourceRequest request)
Description copied from interface:LogAnalytics
Gets detailed information about the source with the specified name.- Specified by:
getSource
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSourceSummary
public GetSourceSummaryResponse getSourceSummary(GetSourceSummaryRequest request)
Description copied from interface:LogAnalytics
Returns the count of sources.- Specified by:
getSourceSummary
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getStorage
public GetStorageResponse getStorage(GetStorageRequest request)
Description copied from interface:LogAnalytics
This API gets the storage configuration of a tenancy- Specified by:
getStorage
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getStorageUsage
public GetStorageUsageResponse getStorageUsage(GetStorageUsageRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
getStorageUsage
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getStorageWorkRequest
public GetStorageWorkRequestResponse getStorageWorkRequest(GetStorageWorkRequestRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
getStorageWorkRequest
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getUnprocessedDataBucket
public GetUnprocessedDataBucketResponse getUnprocessedDataBucket(GetUnprocessedDataBucketRequest request)
Description copied from interface:LogAnalytics
This API retrieves details of the configured bucket that stores unprocessed payloads.- Specified by:
getUnprocessedDataBucket
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getUpload
public GetUploadResponse getUpload(GetUploadRequest request)
Description copied from interface:LogAnalytics
Gets an On-Demand Upload info by reference.- Specified by:
getUpload
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:LogAnalytics
Gets the status of the work request with the given ID.- Specified by:
getWorkRequest
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importCustomContent
public ImportCustomContentResponse importCustomContent(ImportCustomContentRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
importCustomContent
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAssociableEntities
public ListAssociableEntitiesResponse listAssociableEntities(ListAssociableEntitiesRequest request)
Description copied from interface:LogAnalytics
Lists the entities in the specified compartment which are (in)eligible for association with this source.- Specified by:
listAssociableEntities
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAssociatedEntities
public ListAssociatedEntitiesResponse listAssociatedEntities(ListAssociatedEntitiesRequest request)
Description copied from interface:LogAnalytics
Lists the association details of entities in the specified compartment that are associated with at least one source.- Specified by:
listAssociatedEntities
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAutoAssociations
public ListAutoAssociationsResponse listAutoAssociations(ListAutoAssociationsRequest request)
Description copied from interface:LogAnalytics
Gets information related to auto association for the source with the specified name.- Specified by:
listAutoAssociations
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCategories
public ListCategoriesResponse listCategories(ListCategoriesRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listCategories
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConfigWorkRequests
public ListConfigWorkRequestsResponse listConfigWorkRequests(ListConfigWorkRequestsRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listConfigWorkRequests
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEffectiveProperties
public ListEffectivePropertiesResponse listEffectiveProperties(ListEffectivePropertiesRequest request)
Description copied from interface:LogAnalytics
Returns a list of effective properties for the specified resource.- Specified by:
listEffectiveProperties
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEncryptionKeyInfo
public ListEncryptionKeyInfoResponse listEncryptionKeyInfo(ListEncryptionKeyInfoRequest request)
Description copied from interface:LogAnalytics
This API returns the list of customer owned encryption key info.- Specified by:
listEncryptionKeyInfo
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEntityAssociations
public ListEntityAssociationsResponse listEntityAssociations(ListEntityAssociationsRequest request)
Description copied from interface:LogAnalytics
Return a list of log analytics entities associated with input source log analytics entity.- Specified by:
listEntityAssociations
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEntitySourceAssociations
public ListEntitySourceAssociationsResponse listEntitySourceAssociations(ListEntitySourceAssociationsRequest request)
Description copied from interface:LogAnalytics
Returns the list of source associations for the specified entity.- Specified by:
listEntitySourceAssociations
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFields
public ListFieldsResponse listFields(ListFieldsRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listFields
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listIngestTimeRules
public ListIngestTimeRulesResponse listIngestTimeRules(ListIngestTimeRulesRequest request)
Description copied from interface:LogAnalytics
Returns a list of ingest time rules in a compartment.You may limit the number of rules, provide sorting options, and filter the results.
- Specified by:
listIngestTimeRules
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLabelPriorities
public ListLabelPrioritiesResponse listLabelPriorities(ListLabelPrioritiesRequest request)
Description copied from interface:LogAnalytics
Lists the available problem priorities that could be associated with a label.- Specified by:
listLabelPriorities
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLabelSourceDetails
public ListLabelSourceDetailsResponse listLabelSourceDetails(ListLabelSourceDetailsRequest request)
Description copied from interface:LogAnalytics
Lists sources using the label, along with configuration details like base field, operator and condition.- Specified by:
listLabelSourceDetails
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLabels
public ListLabelsResponse listLabels(ListLabelsRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listLabels
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLogAnalyticsEmBridges
public ListLogAnalyticsEmBridgesResponse listLogAnalyticsEmBridges(ListLogAnalyticsEmBridgesRequest request)
Description copied from interface:LogAnalytics
Return a list of log analytics enterprise manager bridges.- Specified by:
listLogAnalyticsEmBridges
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLogAnalyticsEntities
public ListLogAnalyticsEntitiesResponse listLogAnalyticsEntities(ListLogAnalyticsEntitiesRequest request)
Description copied from interface:LogAnalytics
Return a list of log analytics entities.- Specified by:
listLogAnalyticsEntities
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLogAnalyticsEntityTopology
public ListLogAnalyticsEntityTopologyResponse listLogAnalyticsEntityTopology(ListLogAnalyticsEntityTopologyRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
listLogAnalyticsEntityTopology
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLogAnalyticsEntityTypes
public ListLogAnalyticsEntityTypesResponse listLogAnalyticsEntityTypes(ListLogAnalyticsEntityTypesRequest request)
Description copied from interface:LogAnalytics
Return a list of log analytics entity types.- Specified by:
listLogAnalyticsEntityTypes
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLogAnalyticsLogGroups
public ListLogAnalyticsLogGroupsResponse listLogAnalyticsLogGroups(ListLogAnalyticsLogGroupsRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listLogAnalyticsLogGroups
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLogAnalyticsObjectCollectionRules
public ListLogAnalyticsObjectCollectionRulesResponse listLogAnalyticsObjectCollectionRules(ListLogAnalyticsObjectCollectionRulesRequest request)
Description copied from interface:LogAnalytics
Gets list of collection rules.- Specified by:
listLogAnalyticsObjectCollectionRules
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLogSets
public ListLogSetsResponse listLogSets(ListLogSetsRequest request)
Description copied from interface:LogAnalytics
This API returns a list of log sets.- Specified by:
listLogSets
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLookups
public ListLookupsResponse listLookups(ListLookupsRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listLookups
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMetaSourceTypes
public ListMetaSourceTypesResponse listMetaSourceTypes(ListMetaSourceTypesRequest request)
Description copied from interface:LogAnalytics
Lists the types of log sources supported.- Specified by:
listMetaSourceTypes
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listNamespaces
public ListNamespacesResponse listNamespaces(ListNamespacesRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listNamespaces
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOverlappingRecalls
public ListOverlappingRecallsResponse listOverlappingRecalls(ListOverlappingRecallsRequest request)
Description copied from interface:LogAnalytics
This API gets the list of overlapping recalls made in the given timeframe- Specified by:
listOverlappingRecalls
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listParserFunctions
public ListParserFunctionsResponse listParserFunctions(ListParserFunctionsRequest request)
Description copied from interface:LogAnalytics
Lists the parser functions defined for the specified parser.- Specified by:
listParserFunctions
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listParserMetaPlugins
public ListParserMetaPluginsResponse listParserMetaPlugins(ListParserMetaPluginsRequest request)
Description copied from interface:LogAnalytics
Lists the parser meta plugins available for defining parser functions.- Specified by:
listParserMetaPlugins
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listParsers
public ListParsersResponse listParsers(ListParsersRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listParsers
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPropertiesMetadata
public ListPropertiesMetadataResponse listPropertiesMetadata(ListPropertiesMetadataRequest request)
Description copied from interface:LogAnalytics
Returns a list of properties along with their metadata.- Specified by:
listPropertiesMetadata
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listQueryWorkRequests
public ListQueryWorkRequestsResponse listQueryWorkRequests(ListQueryWorkRequestsRequest request)
Description copied from interface:LogAnalytics
List active asynchronous queries.- Specified by:
listQueryWorkRequests
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRecalledData
public ListRecalledDataResponse listRecalledData(ListRecalledDataRequest request)
Description copied from interface:LogAnalytics
This API returns the list of recalled data of a tenancy.- Specified by:
listRecalledData
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceCategories
public ListResourceCategoriesResponse listResourceCategories(ListResourceCategoriesRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listResourceCategories
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRules
public ListRulesResponse listRules(ListRulesRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listRules
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listScheduledTasks
public ListScheduledTasksResponse listScheduledTasks(ListScheduledTasksRequest request)
Description copied from interface:LogAnalytics
Lists scheduled tasks.- Specified by:
listScheduledTasks
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSourceAssociations
public ListSourceAssociationsResponse listSourceAssociations(ListSourceAssociationsRequest request)
Description copied from interface:LogAnalytics
Returns the list of entity associations in the input compartment for the specified source.- Specified by:
listSourceAssociations
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSourceEventTypes
public ListSourceEventTypesResponse listSourceEventTypes(ListSourceEventTypesRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listSourceEventTypes
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSourceExtendedFieldDefinitions
public ListSourceExtendedFieldDefinitionsResponse listSourceExtendedFieldDefinitions(ListSourceExtendedFieldDefinitionsRequest request)
Description copied from interface:LogAnalytics
Lists the extended field definitions for the source with the specified name.- Specified by:
listSourceExtendedFieldDefinitions
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSourceLabelOperators
public ListSourceLabelOperatorsResponse listSourceLabelOperators(ListSourceLabelOperatorsRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listSourceLabelOperators
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSourceMetaFunctions
public ListSourceMetaFunctionsResponse listSourceMetaFunctions(ListSourceMetaFunctionsRequest request)
Description copied from interface:LogAnalytics
Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields.- Specified by:
listSourceMetaFunctions
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSourcePatterns
public ListSourcePatternsResponse listSourcePatterns(ListSourcePatternsRequest request)
Description copied from interface:LogAnalytics
Lists the source patterns for the source with the specified name.- Specified by:
listSourcePatterns
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSources
public ListSourcesResponse listSources(ListSourcesRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listSources
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listStorageWorkRequestErrors
public ListStorageWorkRequestErrorsResponse listStorageWorkRequestErrors(ListStorageWorkRequestErrorsRequest request)
Description copied from interface:LogAnalytics
This API returns the list of work request errors if any.- Specified by:
listStorageWorkRequestErrors
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listStorageWorkRequests
public ListStorageWorkRequestsResponse listStorageWorkRequests(ListStorageWorkRequestsRequest request)
Description copied from interface:LogAnalytics
This API lists storage work requests.Use query parameters to narrow down or sort the result list.
- Specified by:
listStorageWorkRequests
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSupportedCharEncodings
public ListSupportedCharEncodingsResponse listSupportedCharEncodings(ListSupportedCharEncodingsRequest request)
Description copied from interface:LogAnalytics
Gets list of character encodings which are supported by on-demand upload.- Specified by:
listSupportedCharEncodings
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSupportedTimezones
public ListSupportedTimezonesResponse listSupportedTimezones(ListSupportedTimezonesRequest request)
Description copied from interface:LogAnalytics
Gets list of timezones which are supported by on-demand upload.- Specified by:
listSupportedTimezones
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUploadFiles
public ListUploadFilesResponse listUploadFiles(ListUploadFilesRequest request)
Description copied from interface:LogAnalytics
Gets list of files in an upload along with its processing state.- Specified by:
listUploadFiles
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUploadWarnings
public ListUploadWarningsResponse listUploadWarnings(ListUploadWarningsRequest request)
Description copied from interface:LogAnalytics
Gets list of warnings in an upload caused by incorrect configuration.- Specified by:
listUploadWarnings
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUploads
public ListUploadsResponse listUploads(ListUploadsRequest request)
Description copied from interface:LogAnalytics
Gets a list of all On-demand uploads.To use this and other API operations, you must be authorized in an IAM policy.
- Specified by:
listUploads
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWarnings
public ListWarningsResponse listWarnings(ListWarningsRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
listWarnings
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:LogAnalytics
Return a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrors
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:LogAnalytics
Return a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogs
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:LogAnalytics
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
offboardNamespace
public OffboardNamespaceResponse offboardNamespace(OffboardNamespaceRequest request)
Description copied from interface:LogAnalytics
Off-boards a tenant from Logging Analytics- Specified by:
offboardNamespace
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
onboardNamespace
public OnboardNamespaceResponse onboardNamespace(OnboardNamespaceRequest request)
Description copied from interface:LogAnalytics
On-boards a tenant to Logging Analytics.- Specified by:
onboardNamespace
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
parseQuery
public ParseQueryResponse parseQuery(ParseQueryRequest request)
Description copied from interface:LogAnalytics
Describe query- Specified by:
parseQuery
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
pauseScheduledTask
public PauseScheduledTaskResponse pauseScheduledTask(PauseScheduledTaskRequest request)
Description copied from interface:LogAnalytics
Pause the scheduled task specified by {scheduledTaskId}.- Specified by:
pauseScheduledTask
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
purgeStorageData
public PurgeStorageDataResponse purgeStorageData(PurgeStorageDataRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
purgeStorageData
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
putQueryWorkRequestBackground
public PutQueryWorkRequestBackgroundResponse putQueryWorkRequestBackground(PutQueryWorkRequestBackgroundRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
putQueryWorkRequestBackground
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
query
public QueryResponse query(QueryRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
query
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
recallArchivedData
public RecallArchivedDataResponse recallArchivedData(RecallArchivedDataRequest request)
Description copied from interface:LogAnalytics
This API submits a work request to recall archived data based on time interval and data type.- Specified by:
recallArchivedData
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
registerLookup
public RegisterLookupResponse registerLookup(RegisterLookupRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
registerLookup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
releaseRecalledData
public ReleaseRecalledDataResponse releaseRecalledData(ReleaseRecalledDataRequest request)
Description copied from interface:LogAnalytics
This API submits a work request to release recalled data based on time interval and data type.- Specified by:
releaseRecalledData
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeEntityAssociations
public RemoveEntityAssociationsResponse removeEntityAssociations(RemoveEntityAssociationsRequest request)
Description copied from interface:LogAnalytics
Delete association between input source log analytics entity and destination entities.- Specified by:
removeEntityAssociations
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removePreferences
public RemovePreferencesResponse removePreferences(RemovePreferencesRequest request)
Description copied from interface:LogAnalytics
Removes the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.- Specified by:
removePreferences
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeResourceCategories
public RemoveResourceCategoriesResponse removeResourceCategories(RemoveResourceCategoriesRequest request)
Description copied from interface:LogAnalytics
Removes the category assignments of DASHBOARD and SAVEDSEARCH resources.- Specified by:
removeResourceCategories
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeSourceEventTypes
public RemoveSourceEventTypesResponse removeSourceEventTypes(RemoveSourceEventTypesRequest request)
Description copied from interface:LogAnalytics
Remove one or more event types from a source.- Specified by:
removeSourceEventTypes
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
resumeScheduledTask
public ResumeScheduledTaskResponse resumeScheduledTask(ResumeScheduledTaskRequest request)
Description copied from interface:LogAnalytics
Resume the scheduled task specified by {scheduledTaskId}.- Specified by:
resumeScheduledTask
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
run
public RunResponse run(RunRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
run
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
setUnprocessedDataBucket
public SetUnprocessedDataBucketResponse setUnprocessedDataBucket(SetUnprocessedDataBucketRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
setUnprocessedDataBucket
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
suggest
public SuggestResponse suggest(SuggestRequest request)
Description copied from interface:LogAnalytics
Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.- Specified by:
suggest
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
suppressWarning
public SuppressWarningResponse suppressWarning(SuppressWarningRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
suppressWarning
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
testParser
public TestParserResponse testParser(TestParserRequest request)
Description copied from interface:LogAnalytics
Tests the parser definition against the specified example content to ensure fields are successfully extracted.- Specified by:
testParser
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
unsuppressWarning
public UnsuppressWarningResponse unsuppressWarning(UnsuppressWarningRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
unsuppressWarning
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateIngestTimeRule
public UpdateIngestTimeRuleResponse updateIngestTimeRule(UpdateIngestTimeRuleRequest request)
Description copied from interface:LogAnalytics
Updates the specified ingest time rule’s description, defined tags, and free-form tags.- Specified by:
updateIngestTimeRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLogAnalyticsEmBridge
public UpdateLogAnalyticsEmBridgeResponse updateLogAnalyticsEmBridge(UpdateLogAnalyticsEmBridgeRequest request)
Description copied from interface:LogAnalytics
Update log analytics enterprise manager bridge with the given id.- Specified by:
updateLogAnalyticsEmBridge
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLogAnalyticsEntity
public UpdateLogAnalyticsEntityResponse updateLogAnalyticsEntity(UpdateLogAnalyticsEntityRequest request)
Description copied from interface:LogAnalytics
Update the log analytics entity with the given id.- Specified by:
updateLogAnalyticsEntity
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLogAnalyticsEntityType
public UpdateLogAnalyticsEntityTypeResponse updateLogAnalyticsEntityType(UpdateLogAnalyticsEntityTypeRequest request)
Description copied from interface:LogAnalytics
Update custom log analytics entity type.Out of box entity types cannot be udpated.
- Specified by:
updateLogAnalyticsEntityType
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLogAnalyticsLogGroup
public UpdateLogAnalyticsLogGroupResponse updateLogAnalyticsLogGroup(UpdateLogAnalyticsLogGroupRequest request)
Description copied from interface:LogAnalytics
Updates the specified log group’s display name, description, defined tags, and free-form tags.- Specified by:
updateLogAnalyticsLogGroup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLogAnalyticsObjectCollectionRule
public UpdateLogAnalyticsObjectCollectionRuleResponse updateLogAnalyticsObjectCollectionRule(UpdateLogAnalyticsObjectCollectionRuleRequest request)
Description copied from interface:LogAnalytics
Updates configuration of the object collection rule for the given id.- Specified by:
updateLogAnalyticsObjectCollectionRule
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLookup
public UpdateLookupResponse updateLookup(UpdateLookupRequest request)
Description copied from interface:LogAnalytics
Updates the metadata of the specified lookup, such as the lookup description.- Specified by:
updateLookup
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLookupData
public UpdateLookupDataResponse updateLookupData(UpdateLookupDataRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
updateLookupData
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePreferences
public UpdatePreferencesResponse updatePreferences(UpdatePreferencesRequest request)
Description copied from interface:LogAnalytics
Updates the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.- Specified by:
updatePreferences
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateResourceCategories
public UpdateResourceCategoriesResponse updateResourceCategories(UpdateResourceCategoriesRequest request)
Description copied from interface:LogAnalytics
Updates the category assignments of DASHBOARD and SAVEDSEARCH resources.- Specified by:
updateResourceCategories
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateScheduledTask
public UpdateScheduledTaskResponse updateScheduledTask(UpdateScheduledTaskRequest request)
Description copied from interface:LogAnalytics
Update the scheduled task.Schedules may be updated only for taskType SAVED_SEARCH and PURGE.
- Specified by:
updateScheduledTask
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateStorage
public UpdateStorageResponse updateStorage(UpdateStorageRequest request)
Description copied from interface:LogAnalytics
This API updates the archiving configuration- Specified by:
updateStorage
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
uploadDiscoveryData
public UploadDiscoveryDataResponse uploadDiscoveryData(UploadDiscoveryDataRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
uploadDiscoveryData
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
uploadLogEventsFile
public UploadLogEventsFileResponse uploadLogEventsFile(UploadLogEventsFileRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
uploadLogEventsFile
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
uploadLogFile
public UploadLogFileResponse uploadLogFile(UploadLogFileRequest request)
Description copied from interface:LogAnalytics
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.- Specified by:
uploadLogFile
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
upsertAssociations
public UpsertAssociationsResponse upsertAssociations(UpsertAssociationsRequest request)
Description copied from interface:LogAnalytics
Creates or updates associations between sources and entities.All entities should belong to the specified input compartment.
- Specified by:
upsertAssociations
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
upsertField
public UpsertFieldResponse upsertField(UpsertFieldRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
upsertField
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
upsertLabel
public UpsertLabelResponse upsertLabel(UpsertLabelRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
upsertLabel
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
upsertParser
public UpsertParserResponse upsertParser(UpsertParserRequest request)
Description copied from interface:LogAnalytics
Creates or updates a parser, which defines how fields are extracted from a log entry.- Specified by:
upsertParser
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
upsertSource
public UpsertSourceResponse upsertSource(UpsertSourceRequest request)
Description copied from interface:LogAnalytics
Creates or updates a log source.You may also specify parsers, labels, extended fields etc., for the source.
- Specified by:
upsertSource
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateAssociationParameters
public ValidateAssociationParametersResponse validateAssociationParameters(ValidateAssociationParametersRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
validateAssociationParameters
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateEndpoint
public ValidateEndpointResponse validateEndpoint(ValidateEndpointRequest request)
Description copied from interface:LogAnalytics
Validates the REST endpoint configuration.- Specified by:
validateEndpoint
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateFile
public ValidateFileResponse validateFile(ValidateFileRequest request)
Description copied from interface:LogAnalytics
Validates a log file to check whether it is eligible to be uploaded or not.- Specified by:
validateFile
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateLabelCondition
public ValidateLabelConditionResponse validateLabelCondition(ValidateLabelConditionRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
validateLabelCondition
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateSource
public ValidateSourceResponse validateSource(ValidateSourceRequest request)
Description copied from interface:LogAnalytics
Checks if the specified input is a valid log source definition.- Specified by:
validateSource
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateSourceExtendedFieldDetails
public ValidateSourceExtendedFieldDetailsResponse validateSourceExtendedFieldDetails(ValidateSourceExtendedFieldDetailsRequest request)
Description copied from interface:LogAnalytics
Checks if the specified input contains valid extended field definitions against the provided example content.- Specified by:
validateSourceExtendedFieldDetails
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateSourceMapping
public ValidateSourceMappingResponse validateSourceMapping(ValidateSourceMappingRequest request)
Description copied from interface:LogAnalytics
Validates the source mapping for a given file and provides match status and the parsed representation of log data.- Specified by:
validateSourceMapping
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
verify
public VerifyResponse verify(VerifyRequest request)
Description copied from interface:LogAnalytics
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.
- Specified by:
verify
in interfaceLogAnalytics
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public LogAnalyticsWaiters getWaiters()
Description copied from interface:LogAnalytics
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceLogAnalytics
- Returns:
- The service waiters.
-
getPaginators
public LogAnalyticsPaginators getPaginators()
Description copied from interface:LogAnalytics
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.- Specified by:
getPaginators
in interfaceLogAnalytics
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-