LogAnalyticsClient

class oci.log_analytics.LogAnalyticsClient(config, **kwargs)

The LogAnalytics API for the LogAnalytics service.

Methods

__init__(config, **kwargs) Creates a new service client
add_entity_association(namespace_name, …) Adds association between input source log analytics entity and one or more existing destination entities.
add_source_event_types(namespace_name, …) Add one or more event types to a source.
append_lookup_data(namespace_name, …) Appends data to the lookup content.
batch_get_basic_info(namespace_name, …) Lists basic information about a specified set of labels in batch.
cancel_query_work_request(namespace_name, …) Cancel/Remove query job work request.
change_log_analytics_em_bridge_compartment(…) Update the compartment of the log analytics enterprise manager bridge with the given id.
change_log_analytics_entity_compartment(…) Update the compartment of the log analytics entity with the given id.
change_log_analytics_log_group_compartment(…) Moves the specified log group to a different compartment.
change_log_analytics_object_collection_rule_compartment(…) Move the rule from it’s current compartment to the given compartment.
change_scheduled_task_compartment(…) Move the scheduled task into a different compartment within the same tenancy.
clean(namespace_name, scheduled_task_id, …) Clean accumulated acceleration data stored for the accelerated saved search.
create_log_analytics_em_bridge(…) Add configuration for enterprise manager bridge.
create_log_analytics_entity(namespace_name, …) Create a new log analytics entity.
create_log_analytics_entity_type(…) Add custom log analytics entity type.
create_log_analytics_log_group(…) Creates a new log group in the specified compartment with the input display name.
create_log_analytics_object_collection_rule(…) Creates a rule to collect logs from an object storage bucket.
create_scheduled_task(namespace_name, …) Schedule a task as specified and return task info.
delete_associations(namespace_name, …) Deletes the associations between the sources and entities specified.
delete_field(namespace_name, field_name, …) Deletes field with the specified name.
delete_label(namespace_name, label_name, …) Deletes label with the specified name.
delete_log_analytics_em_bridge(…) Delete log analytics enterprise manager bridge with the given id.
delete_log_analytics_entity(namespace_name, …) Delete log analytics entity with the given id.
delete_log_analytics_entity_type(…) Delete log analytics entity type with the given name.
delete_log_analytics_log_group(…) Deletes the specified log group.
delete_log_analytics_object_collection_rule(…) Deletes the configured object storage bucket based collection rule and stop the log collection.
delete_lookup(namespace_name, lookup_name, …) Deletes lookup with the specified name.
delete_parser(namespace_name, parser_name, …) Deletes parser with the specified name.
delete_scheduled_task(namespace_name, …) Delete the scheduled task.
delete_source(namespace_name, source_name, …) Deletes source with the specified name.
delete_upload(namespace_name, …) Deletes an Upload by its reference.
delete_upload_file(namespace_name, …) Deletes a specific log file inside an upload by upload file reference.
delete_upload_warning(namespace_name, …) Suppresses a specific warning inside an upload.
disable_archiving(namespace_name, **kwargs) This API disables archiving.
disable_auto_association(namespace_name, …) Disables auto association for a log source.
disable_source_event_types(namespace_name, …) Disable one or more event types in a source.
enable_archiving(namespace_name, **kwargs) THis API enables archiving.
enable_auto_association(namespace_name, …) Enables auto association for a log source.
enable_source_event_types(namespace_name, …) Enable one or more event types in a source.
estimate_purge_data_size(namespace_name, …) This API estimates the size of data to be purged based based on time interval, purge query etc.
estimate_recall_data_size(namespace_name, …) This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.
estimate_release_data_size(namespace_name, …) This API gives an active storage usage estimate for recalled data to be released and the time range of such data.
export_custom_content(namespace_name, …) Exports all custom details of the specified sources, parsers, fields and labels, in zip format.
export_query_result(namespace_name, …) Export data based on query.
extract_structured_log_field_paths(…) Extracts the field paths from the example json or xml content.
extract_structured_log_header_paths(…) Extracts the header paths from the example json or xml content.
filter(namespace_name, filter_details, **kwargs) Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.
get_association_summary(namespace_name, …) Returns the count of source associations for entities in the specified compartment.
get_column_names(namespace_name, sql_query, …) Extracts column names from the input SQL query.
get_config_work_request(namespace_name, …) Returns detailed information about the configuration work request with the specified id.
get_field(namespace_name, field_name, **kwargs) Gets detailed information about the field with the specified name.
get_fields_summary(namespace_name, **kwargs) Returns the count of fields.
get_label(namespace_name, label_name, **kwargs) Gets detailed information about the label with the specified name.
get_label_summary(namespace_name, **kwargs) Returns the count of labels.
get_log_analytics_em_bridge(namespace_name, …) Retrieve the log analytics enterprise manager bridge with the given id.
get_log_analytics_em_bridge_summary(…) Returns log analytics enterprise manager bridges summary report.
get_log_analytics_entities_summary(…) Returns log analytics entities count summary report.
get_log_analytics_entity(namespace_name, …) Retrieve the log analytics entity with the given id.
get_log_analytics_entity_type(…) Retrieve the log analytics entity type with the given name.
get_log_analytics_log_group(namespace_name, …) Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.
get_log_analytics_log_groups_summary(…) Returns the count of log groups in a compartment.
get_log_analytics_object_collection_rule(…) Gets a configured object storage based collection rule by given id
get_log_sets_count(namespace_name, **kwargs) This API returns the count of distinct log sets.
get_lookup(namespace_name, lookup_name, **kwargs) Gets detailed information about the lookup with the specified name.
get_lookup_summary(namespace_name, **kwargs) Returns the count of user created and oracle defined lookups.
get_namespace(namespace_name, **kwargs) This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application
get_parser(namespace_name, parser_name, **kwargs) Gets detailed information about the parser with the specified name.
get_parser_summary(namespace_name, **kwargs) Returns the count of parsers.
get_preferences(namespace_name, **kwargs) Lists the preferences of the tenant.
get_query_result(namespace_name, …) 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.
get_query_work_request(namespace_name, …) Retrieve work request details by workRequestId.
get_scheduled_task(namespace_name, …) Get the scheduled task for the specified task identifier.
get_source(namespace_name, source_name, …) Gets detailed information about the source with the specified name.
get_source_summary(namespace_name, **kwargs) Returns the count of sources.
get_storage(namespace_name, **kwargs) This API gets the storage configuration of a tenancy
get_storage_usage(namespace_name, **kwargs) This API gets storage usage information of a tenancy.
get_storage_work_request(work_request_id, …) This API returns work request details specified by {workRequestId}.
get_unprocessed_data_bucket(namespace_name, …) This API retrieves details of the configured bucket that stores unprocessed payloads.
get_upload(namespace_name, upload_reference, …) Gets an On-Demand Upload info by reference.
get_work_request(namespace_name, …) Gets the status of the work request with the given ID.
import_custom_content(namespace_name, …) Imports the specified custom content from the input in zip format.
list_associable_entities(namespace_name, …) Lists the entities in the specified compartment which are (in)eligible for association with this source.
list_associated_entities(namespace_name, …) Lists the association details of entities in the specified compartment that are associated with at least one source.
list_auto_associations(namespace_name, …) Gets information related to auto association for the source with the specified name.
list_config_work_requests(namespace_name, …) Returns the list of configuration work requests such as association or lookup operations, containing detailed information about them.
list_entity_associations(namespace_name, …) Return a list of log analytics entities associated with input source log analytics entity.
list_entity_source_associations(…) Returns the list of source associations for the specified entity.
list_fields(namespace_name, **kwargs) Returns a list of log fields, containing detailed information about them.
list_label_priorities(namespace_name, **kwargs) Lists the available problem priorities that could be associated with a label.
list_label_source_details(namespace_name, …) Lists sources using the label, along with configuration details like base field, operator and condition.
list_labels(namespace_name, **kwargs) Returns a list of labels, containing detailed information about them.
list_log_analytics_em_bridges(…) Return a list of log analytics enterprise manager bridges.
list_log_analytics_entities(namespace_name, …) Return a list of log analytics entities.
list_log_analytics_entity_types(…) Return a list of log analytics entity types.
list_log_analytics_log_groups(…) Returns a list of log groups in a compartment.
list_log_analytics_object_collection_rules(…) Gets list of collection rules.
list_log_sets(namespace_name, **kwargs) This API returns a list of log sets.
list_lookups(namespace_name, type, **kwargs) Returns a list of lookups, containing detailed information about them.
list_meta_source_types(namespace_name, **kwargs) Lists the types of log sources supported.
list_namespaces(compartment_id, **kwargs) Given a tenancy OCID, this API returns the namespace of the tenancy if it is valid and subscribed to the region.
list_parser_functions(namespace_name, **kwargs) Lists the parser functions defined for the specified parser.
list_parser_meta_plugins(namespace_name, …) Lists the parser meta plugins available for defining parser functions.
list_parsers(namespace_name, **kwargs) Returns a list of parsers, containing detailed information about them.
list_query_work_requests(namespace_name, …) List active asynchronous queries.
list_recalled_data(namespace_name, **kwargs) This API returns the list of recalled data of a tenancy.
list_scheduled_tasks(namespace_name, …) Lists scheduled tasks.
list_source_associations(namespace_name, …) Returns the list of entity associations in the input compartment for the specified source.
list_source_event_types(namespace_name, …) Lists the event types mapped to the source with the specified name.
list_source_extended_field_definitions(…) Lists the extended field definitions for the source with the specified name.
list_source_label_operators(namespace_name, …) Lists the supported conditional operators that could be used for matching log field values to generate a label.
list_source_meta_functions(namespace_name, …) Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields.
list_source_patterns(namespace_name, …) Lists the source patterns for the source with the specified name.
list_sources(namespace_name, compartment_id, …) Returns a list of sources, containing detailed information about them.
list_storage_work_request_errors(…) This API returns the list of work request errors if any.
list_storage_work_requests(compartment_id, …) This API lists storage work requests.
list_supported_char_encodings(…) Gets list of character encodings which are supported by on-demand upload.
list_supported_timezones(namespace_name, …) Gets list of timezones which are supported by on-demand upload.
list_upload_files(namespace_name, …) Gets list of files in an upload along with its processing state.
list_upload_warnings(namespace_name, …) Gets list of warnings in an upload caused by incorrect configuration.
list_uploads(namespace_name, **kwargs) Gets a list of all On-demand uploads.
list_warnings(namespace_name, …) Returns a list of collection warnings, containing detailed information about them.
list_work_request_errors(namespace_name, …) Return a (paginated) list of errors for a given work request.
list_work_request_logs(namespace_name, …) Return a (paginated) list of logs for a given work request.
list_work_requests(namespace_name, …) Lists the work requests in a compartment.
offboard_namespace(namespace_name, **kwargs) Off-boards a tenant from Logging Analytics
onboard_namespace(namespace_name, **kwargs) On-boards a tenant to Logging Analytics.
parse_query(namespace_name, …) Describe query
pause_scheduled_task(namespace_name, …) Pause the scheduled task specified by {scheduledTaskId}.
purge_storage_data(namespace_name, …) This API submits a work request to purge data.
put_query_work_request_background(…) Put the work request specified by {workRequestId} into the background.
query(namespace_name, query_details, **kwargs) Performs a log analytics search, if shouldRunAsync is false returns the query results once they become available subject to 60 second timeout.
recall_archived_data(namespace_name, …) This API submits a work request to recall archived data based on time interval and data type.
register_lookup(namespace_name, type, …) Creates a lookup with the specified name, type and description.
release_recalled_data(namespace_name, …) This API submits a work request to release recalled data based on time interval and data type.
remove_entity_associations(namespace_name, …) Delete association between input source log analytics entity and destination entities.
remove_preferences(namespace_name, …) Removes the tenant preferences.
remove_source_event_types(namespace_name, …) Remove one or more event types from a source.
resume_scheduled_task(namespace_name, …) Resume the scheduled task specified by {scheduledTaskId}.
run(namespace_name, scheduled_task_id, **kwargs) Execute the saved search acceleration task in the foreground.
set_unprocessed_data_bucket(namespace_name, …) This API configures a bucket to store unprocessed payloads.
suggest(namespace_name, suggest_details, …) Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.
suppress_warning(namespace_name, …) Supresses a list of warnings.
test_parser(namespace_name, …) Tests the parser definition against the specified example content to ensure fields are successfully extracted.
unsuppress_warning(namespace_name, …) Unsupresses a list of warnings.
update_log_analytics_em_bridge(…) Update log analytics enterprise manager bridge with the given id.
update_log_analytics_entity(namespace_name, …) Update the log analytics entity with the given id.
update_log_analytics_entity_type(…) Update custom log analytics entity type.
update_log_analytics_log_group(…) Updates the specified log group’s display name, description, defined tags, and free-form tags.
update_log_analytics_object_collection_rule(…) Updates configuration of the object collection rule for the given id.
update_lookup(namespace_name, lookup_name, …) Updates the metadata of the specified lookup, such as the lookup description.
update_lookup_data(namespace_name, …) Updates the lookup content.
update_preferences(namespace_name, …) Updates the tenant preferences.
update_scheduled_task(namespace_name, …) Update the scheduled task.
update_storage(namespace_name, …) This API updates the archiving configuration
upload_log_events_file(namespace_name, …) Accepts log events for processing by Logging Analytics.
upload_log_file(namespace_name, upload_name, …) Accepts log data for processing by Logging Analytics.
upsert_associations(namespace_name, …) Creates or updates associations between sources and entities.
upsert_field(namespace_name, …) Creates or updates a field that could be used in parser expressions to extract and assign value.
upsert_label(namespace_name, …) Creates or updates a label that could be used to tag a log entry.
upsert_parser(namespace_name, …) Creates or updates a parser, which defines how fields are extracted from a log entry.
upsert_source(namespace_name, …) Creates or updates a log source.
validate_association_parameters(…) Checks if the passed in entities could be associated with the specified sources.
validate_file(namespace_name, …) Validates a log file to check whether it is eligible to be uploaded or not.
validate_source(namespace_name, …) Checks if the specified input is a valid log source definition.
validate_source_extended_field_details(…) Checks if the specified input contains valid extended field definitions against the provided example content.
validate_source_mapping(namespace_name, …) Validates the source mapping for a given file and provides match status and the parsed representation of log data.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client will not have circuit breakers enabled by default, users can use their own circuit breaker strategy or the convenient DEFAULT_CIRCUIT_BREAKER_STRATEGY provided by the SDK to enable it. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
add_entity_association(namespace_name, log_analytics_entity_id, add_entity_association_details, **kwargs)

Adds association between input source log analytics entity and one or more existing destination entities.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • add_entity_association_details (oci.log_analytics.models.AddEntityAssociationDetails) – (required) This parameter specifies the destination entity OCIDs with which associations are to be created.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_entity_association API.

add_source_event_types(namespace_name, source_name, add_event_type_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • add_event_type_details (oci.log_analytics.models.EventTypeDetails) – (required) Details of event types to be added to the source. The specified event type string could be the fully qualified name or a prefix that matches the event type.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_source_event_types API.

append_lookup_data(namespace_name, lookup_name, append_lookup_file_body, **kwargs)

Appends data to the lookup content. The csv file containing the content to be appended is passed in as binary data in the request.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • append_lookup_file_body (stream) – (required) The file to append.
  • is_force (bool) – (optional) is force
  • char_encoding (str) – (optional) The character encoding of the uploaded file.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • expect (str) – (optional) A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent. If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • buffer_limit (int) –

    (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

    The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use append_lookup_data API.

batch_get_basic_info(namespace_name, basic_details, is_include_deleted, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • basic_details (oci.log_analytics.models.LabelNames) – (required) List of label names to get information on
  • is_include_deleted (bool) – (required) A flag specifying whether or not to include information on deleted labels.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • basic_label_sort_by (str) –

    (optional) The attribute used to sort the returned labels

    Allowed values are: “name”, “priority”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLabelCollection

Return type:

Response

Example:

Click here to see an example of how to use batch_get_basic_info API.

cancel_query_work_request(namespace_name, work_request_id, **kwargs)

Cancel/Remove query job work request.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use cancel_query_work_request API.

change_log_analytics_em_bridge_compartment(namespace_name, log_analytics_em_bridge_id, change_log_analytics_em_bridge_compartment_details, **kwargs)

Update the compartment of the log analytics enterprise manager bridge with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_em_bridge_id (str) – (required) The log analytics enterprise manager bridge OCID.
  • change_log_analytics_em_bridge_compartment_details (oci.log_analytics.models.ChangeLogAnalyticsEmBridgeCompartmentDetails) – (required) Log analytics enterprise manager bridge compartment Id to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_log_analytics_em_bridge_compartment API.

change_log_analytics_entity_compartment(namespace_name, log_analytics_entity_id, change_log_analytics_entity_compartment_details, **kwargs)

Update the compartment of the log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • change_log_analytics_entity_compartment_details (oci.log_analytics.models.ChangeLogAnalyticsEntityCompartmentDetails) – (required) Log analytics entity compartment Id to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_log_analytics_entity_compartment API.

change_log_analytics_log_group_compartment(namespace_name, log_analytics_log_group_id, change_log_analytics_log_group_compartment_details, **kwargs)

Moves the specified log group to a different compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • change_log_analytics_log_group_compartment_details (oci.log_analytics.models.ChangeLogAnalyticsLogGroupCompartmentDetails) – (required) The information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_log_analytics_log_group_compartment API.

change_log_analytics_object_collection_rule_compartment(namespace_name, log_analytics_object_collection_rule_id, change_log_analytics_object_collection_rule_compartment_details, **kwargs)

Move the rule from it’s current compartment to the given compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • change_log_analytics_object_collection_rule_compartment_details (oci.log_analytics.models.ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails) – (required) The new compartment this Object Collection Rule will be moved to.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_log_analytics_object_collection_rule_compartment API.

change_scheduled_task_compartment(namespace_name, scheduled_task_id, change_scheduled_task_compartment_details, **kwargs)

Move the scheduled task into a different compartment within the same tenancy.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • change_scheduled_task_compartment_details (oci.log_analytics.models.ChangeScheduledTaskCompartmentDetails) – (required) The destination compartment identifier.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_scheduled_task_compartment API.

clean(namespace_name, scheduled_task_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • time_start (datetime) – (optional) Optional parameter to specify start of time range, in the format defined by RFC3339. Default value is beginning of time.
  • time_end (datetime) – (optional) Optional parameter to specify end of time range, in the format defined by RFC3339. Default value is end of time.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use clean API.

create_log_analytics_em_bridge(namespace_name, create_log_analytics_em_bridge_details, **kwargs)

Add configuration for enterprise manager bridge. Enterprise manager bridge is used to automatically add selected entities from enterprise manager cloud control. A corresponding OCI bridge configuration is required in enterprise manager.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_em_bridge_details (oci.log_analytics.models.CreateLogAnalyticsEmBridgeDetails) – (required) Details for the enterprise manager bridge.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEmBridge

Return type:

Response

Example:

Click here to see an example of how to use create_log_analytics_em_bridge API.

create_log_analytics_entity(namespace_name, create_log_analytics_entity_details, **kwargs)

Create a new log analytics entity.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_entity_details (oci.log_analytics.models.CreateLogAnalyticsEntityDetails) – (required) Details for the new log analytics entity.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntity

Return type:

Response

Example:

Click here to see an example of how to use create_log_analytics_entity API.

create_log_analytics_entity_type(namespace_name, create_log_analytics_entity_type_details, **kwargs)

Add custom log analytics entity type.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_entity_type_details (oci.log_analytics.models.CreateLogAnalyticsEntityTypeDetails) – (required) Definition for custom log analytics entity type.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use create_log_analytics_entity_type API.

create_log_analytics_log_group(namespace_name, create_log_analytics_log_group_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_log_group_details (oci.log_analytics.models.CreateLogAnalyticsLogGroupDetails) – (required) Details for the new Log-Analytics group.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLogGroup

Return type:

Response

Example:

Click here to see an example of how to use create_log_analytics_log_group API.

create_log_analytics_object_collection_rule(namespace_name, create_log_analytics_object_collection_rule_details, **kwargs)

Creates a rule to collect logs from an object storage bucket.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_object_collection_rule_details (oci.log_analytics.models.CreateLogAnalyticsObjectCollectionRuleDetails) – (required) Details of the rule to be created.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsObjectCollectionRule

Return type:

Response

Example:

Click here to see an example of how to use create_log_analytics_object_collection_rule API.

create_scheduled_task(namespace_name, create_scheduled_task_details, **kwargs)

Schedule a task as specified and return task info.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_scheduled_task_details (oci.log_analytics.models.CreateScheduledTaskDetails) – (required) Scheduled task to be created.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ScheduledTask

Return type:

Response

Example:

Click here to see an example of how to use create_scheduled_task API.

delete_associations(namespace_name, delete_log_analytics_association_details, **kwargs)

Deletes the associations between the sources and entities specified.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • delete_log_analytics_association_details (oci.log_analytics.models.DeleteLogAnalyticsAssociationDetails) – (required) details for association
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_associations API.

delete_field(namespace_name, field_name, **kwargs)

Deletes field with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • field_name (str) – (required) The field name.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_field API.

delete_label(namespace_name, label_name, **kwargs)

Deletes label with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (required) The label name.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_label API.

delete_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, **kwargs)

Delete log analytics enterprise manager bridge with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_em_bridge_id (str) – (required) The log analytics enterprise manager bridge OCID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_log_analytics_em_bridge API.

delete_log_analytics_entity(namespace_name, log_analytics_entity_id, **kwargs)

Delete log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_log_analytics_entity API.

delete_log_analytics_entity_type(namespace_name, entity_type_name, **kwargs)

Delete log analytics entity type with the given name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • entity_type_name (str) – (required) Log analytics entity type name.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_log_analytics_entity_type API.

delete_log_analytics_log_group(namespace_name, log_analytics_log_group_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_log_analytics_log_group API.

delete_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_log_analytics_object_collection_rule API.

delete_lookup(namespace_name, lookup_name, **kwargs)

Deletes lookup with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • is_force (bool) – (optional) is force
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_lookup API.

delete_parser(namespace_name, parser_name, **kwargs)

Deletes parser with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parser_name (str) – (required) The parser name.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_parser API.

delete_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Delete the scheduled task.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_scheduled_task API.

delete_source(namespace_name, source_name, **kwargs)

Deletes source with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_source API.

delete_upload(namespace_name, upload_reference, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_upload API.

delete_upload_file(namespace_name, upload_reference, file_reference, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • file_reference (str) – (required) Unique internal identifier to refer upload file.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_upload_file API.

delete_upload_warning(namespace_name, upload_reference, warning_reference, **kwargs)

Suppresses a specific warning inside an upload.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • warning_reference (str) – (required) Unique internal identifier to refer upload warning.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_upload_warning API.

disable_archiving(namespace_name, **kwargs)

This API disables archiving.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Success

Return type:

Response

Example:

Click here to see an example of how to use disable_archiving API.

disable_auto_association(namespace_name, source_name, disable_auto_association_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • disable_auto_association_details (oci.log_analytics.models.DisableAutoAssociationDetails) – (required) Details required to disable auto association for the log source.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_auto_association API.

disable_source_event_types(namespace_name, source_name, disable_event_type_details, **kwargs)

Disable one or more event types in a source.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • disable_event_type_details (oci.log_analytics.models.EventTypeDetails) – (required) Details of event types to be disabled in the source.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_source_event_types API.

enable_archiving(namespace_name, **kwargs)

THis API enables archiving.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Success

Return type:

Response

Example:

Click here to see an example of how to use enable_archiving API.

enable_auto_association(namespace_name, source_name, enable_auto_association_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • enable_auto_association_details (oci.log_analytics.models.EnableAutoAssociationDetails) – (required) Details required to enable auto association for the log source.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_auto_association API.

enable_source_event_types(namespace_name, source_name, enable_event_type_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • enable_event_type_details (oci.log_analytics.models.EventTypeDetails) – (required) Details of event types to be enabled in the source.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_source_event_types API.

estimate_purge_data_size(namespace_name, estimate_purge_data_size_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • estimate_purge_data_size_details (oci.log_analytics.models.EstimatePurgeDataSizeDetails) – (required) This is the input to estimate the size of data to be purged.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EstimatePurgeDataSizeResult

Return type:

Response

Example:

Click here to see an example of how to use estimate_purge_data_size API.

estimate_recall_data_size(namespace_name, estimate_recall_data_size_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • estimate_recall_data_size_details (oci.log_analytics.models.EstimateRecallDataSizeDetails) – (required) This is the input to estimate the size of data to be recalled.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EstimateRecallDataSizeResult

Return type:

Response

Example:

Click here to see an example of how to use estimate_recall_data_size API.

estimate_release_data_size(namespace_name, estimate_release_data_size_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • estimate_release_data_size_details (oci.log_analytics.models.EstimateReleaseDataSizeDetails) – (required) This is the input to estimate the size of recalled data to be released.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EstimateReleaseDataSizeResult

Return type:

Response

Example:

Click here to see an example of how to use estimate_release_data_size API.

export_custom_content(namespace_name, export_custom_content_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • export_custom_content_details (oci.log_analytics.models.ExportContent) – (required) content to export
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use export_custom_content API.

export_query_result(namespace_name, export_details, **kwargs)

Export data based on query. Endpoint returns a stream of data. Endpoint is synchronous. Queries must deliver first result within 60 seconds or calls are subject to timeout.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • export_details (oci.log_analytics.models.ExportDetails) – (required) Query to be exported
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use export_query_result API.

extract_structured_log_field_paths(namespace_name, logan_parser_details, **kwargs)

Extracts the field paths from the example json or xml content.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • logan_parser_details (oci.log_analytics.models.LogAnalyticsParser) – (required) parser definition
  • parser_type (str) –

    (optional) The parser type - possible values are XML, JSON or DELIMITED.

    Allowed values are: “XML”, “JSON”, “DELIMITED”

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExtractLogFieldResults

Return type:

Response

Example:

Click here to see an example of how to use extract_structured_log_field_paths API.

extract_structured_log_header_paths(namespace_name, logan_parser_details, **kwargs)

Extracts the header paths from the example json or xml content.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • logan_parser_details (oci.log_analytics.models.LogAnalyticsParser) – (required) parser definition
  • parser_type (str) –

    (optional) The parser type - possible values are XML, JSON or DELIMITED.

    Allowed values are: “XML”, “JSON”, “DELIMITED”

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExtractLogHeaderResults

Return type:

Response

Example:

Click here to see an example of how to use extract_structured_log_header_paths API.

filter(namespace_name, filter_details, **kwargs)

Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • filter_details (oci.log_analytics.models.FilterDetails) – (required) Query string and filters to add or remove
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FilterOutput

Return type:

Response

Example:

Click here to see an example of how to use filter API.

get_association_summary(namespace_name, compartment_id, **kwargs)

Returns the count of source associations for entities in the specified compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AssociationSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_association_summary API.

get_column_names(namespace_name, sql_query, **kwargs)

Extracts column names from the input SQL query.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • sql_query (str) – (required) The SQL query from which column names are to be extracted.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ColumnNameCollection

Return type:

Response

Example:

Click here to see an example of how to use get_column_names API.

get_config_work_request(namespace_name, work_request_id, **kwargs)

Returns detailed information about the configuration work request with the specified id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsConfigWorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_config_work_request API.

get_field(namespace_name, field_name, **kwargs)

Gets detailed information about the field with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • field_name (str) – (required) The field name.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsField

Return type:

Response

Example:

Click here to see an example of how to use get_field API.

get_fields_summary(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • is_show_detail (bool) – (optional) A boolean indicating whether or not to display detailed field summary information
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FieldSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_fields_summary API.

get_label(namespace_name, label_name, **kwargs)

Gets detailed information about the label with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (required) The label name.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLabel

Return type:

Response

Example:

Click here to see an example of how to use get_label API.

get_label_summary(namespace_name, **kwargs)

Returns the count of labels.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LabelSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_label_summary API.

get_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, **kwargs)

Retrieve the log analytics enterprise manager bridge with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_em_bridge_id (str) – (required) The log analytics enterprise manager bridge OCID.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEmBridge

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_em_bridge API.

get_log_analytics_em_bridge_summary(namespace_name, compartment_id, **kwargs)

Returns log analytics enterprise manager bridges summary report.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEmBridgeSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_em_bridge_summary API.

get_log_analytics_entities_summary(namespace_name, compartment_id, **kwargs)

Returns log analytics entities count summary report.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntitySummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_entities_summary API.

get_log_analytics_entity(namespace_name, log_analytics_entity_id, **kwargs)

Retrieve the log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntity

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_entity API.

get_log_analytics_entity_type(namespace_name, entity_type_name, **kwargs)

Retrieve the log analytics entity type with the given name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • entity_type_name (str) – (required) Log analytics entity type name.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntityType

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_entity_type API.

get_log_analytics_log_group(namespace_name, log_analytics_log_group_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLogGroup

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_log_group API.

get_log_analytics_log_groups_summary(namespace_name, compartment_id, **kwargs)

Returns the count of log groups in a compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogGroupSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_log_groups_summary API.

get_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, **kwargs)

Gets a configured object storage based collection rule by given id

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsObjectCollectionRule

Return type:

Response

Example:

Click here to see an example of how to use get_log_analytics_object_collection_rule API.

get_log_sets_count(namespace_name, **kwargs)

This API returns the count of distinct log sets.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogSetsCount

Return type:

Response

Example:

Click here to see an example of how to use get_log_sets_count API.

get_lookup(namespace_name, lookup_name, **kwargs)

Gets detailed information about the lookup with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLookup

Return type:

Response

Example:

Click here to see an example of how to use get_lookup API.

get_lookup_summary(namespace_name, **kwargs)

Returns the count of user created and oracle defined lookups.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LookupSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_lookup_summary API.

get_namespace(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Namespace

Return type:

Response

Example:

Click here to see an example of how to use get_namespace API.

get_parser(namespace_name, parser_name, **kwargs)

Gets detailed information about the parser with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parser_name (str) – (required) The parser name.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsParser

Return type:

Response

Example:

Click here to see an example of how to use get_parser API.

get_parser_summary(namespace_name, **kwargs)

Returns the count of parsers.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ParserSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_parser_summary API.

get_preferences(namespace_name, **kwargs)

Lists the preferences of the tenant. Currently, only “DEFAULT_HOMEPAGE” is supported.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned preferences.

    Allowed values are: “name”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsPreferenceCollection

Return type:

Response

Example:

Click here to see an example of how to use get_preferences API.

get_query_result(namespace_name, work_request_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) Maximum number of results to return in this request. Note a limit=-1 returns all results from pageId onwards up to maxtotalCount.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • should_include_columns (bool) – (optional) Include columns in response
  • should_include_fields (bool) – (optional) Include fields in response
  • output_mode (str) –

    (optional) Specifies the format for the returned results.

    Allowed values are: “JSON_ROWS”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type QueryAggregation

Return type:

Response

Example:

Click here to see an example of how to use get_query_result API.

get_query_work_request(namespace_name, work_request_id, **kwargs)

Retrieve work request details by workRequestId. This endpoint can be polled for status tracking of work request. Clients should poll using the interval returned in the retry-after header.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type QueryWorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_query_work_request API.

get_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Get the scheduled task for the specified task identifier.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ScheduledTask

Return type:

Response

Example:

Click here to see an example of how to use get_scheduled_task API.

get_source(namespace_name, source_name, compartment_id, **kwargs)

Gets detailed information about the source with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsSource

Return type:

Response

Example:

Click here to see an example of how to use get_source API.

get_source_summary(namespace_name, **kwargs)

Returns the count of sources.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SourceSummaryReport

Return type:

Response

Example:

Click here to see an example of how to use get_source_summary API.

get_storage(namespace_name, **kwargs)

This API gets the storage configuration of a tenancy

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Storage

Return type:

Response

Example:

Click here to see an example of how to use get_storage API.

get_storage_usage(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type StorageUsage

Return type:

Response

Example:

Click here to see an example of how to use get_storage_usage API.

get_storage_work_request(work_request_id, namespace_name, **kwargs)

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

Parameters:
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type StorageWorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_storage_work_request API.

get_unprocessed_data_bucket(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UnprocessedDataBucket

Return type:

Response

Example:

Click here to see an example of how to use get_unprocessed_data_bucket API.

get_upload(namespace_name, upload_reference, **kwargs)

Gets an On-Demand Upload info by reference.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Upload

Return type:

Response

Example:

Click here to see an example of how to use get_upload API.

get_work_request(namespace_name, work_request_id, **kwargs)

Gets the status of the work request with the given ID.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

import_custom_content(namespace_name, import_custom_content_file_body, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • import_custom_content_file_body (stream) – (required) The file to upload which contains the custom content.
  • is_overwrite (bool) – (optional) A flag indicating whether or not to overwrite existing content if a conflict is found during import content operation.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • expect (str) – (optional) A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent. If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • buffer_limit (int) –

    (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

    The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns:

A Response object with data of type LogAnalyticsImportCustomContent

Return type:

Response

Example:

Click here to see an example of how to use import_custom_content API.

list_associable_entities(namespace_name, source_name, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • type (str) –

    (optional) The entity type - either eligible or ineligible for association.

    Allowed values are: “ELIGIBLE”, “INELIGIBLE”

  • search_text (str) – (optional) The text used for filtering returned entities. Search text is applicable to the entity name and the entity description.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned entities

    Allowed values are: “entityName”, “entityTypeName”, “host”, “agentId”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AssociableEntityCollection

Return type:

Response

Example:

Click here to see an example of how to use list_associable_entities API.

list_associated_entities(namespace_name, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_id (str) – (optional) The entity OCID.
  • entity_type (str) – (optional) The entity type used for filtering. Only associations on an entity with the specified type will be returned.
  • entity_type_display_name (str) – (optional) The entity type display name used for filtering. Only items associated with the entity with the specified type display name will be returned.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned entities

    Allowed values are: “entityName”, “entityTypeDisplayName”, “associationCount”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsAssociatedEntityCollection

Return type:

Response

Example:

Click here to see an example of how to use list_associated_entities API.

list_auto_associations(namespace_name, source_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned auto association information.

    Allowed values are: “isEnabled”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutoAssociationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_auto_associations API.

list_config_work_requests(namespace_name, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned work requests

    Allowed values are: “timeAccepted”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsConfigWorkRequestCollection

Return type:

Response

Example:

Click here to see an example of how to use list_config_work_requests API.

list_entity_associations(namespace_name, log_analytics_entity_id, **kwargs)

Return a list of log analytics entities associated with input source log analytics entity.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • direct_or_all_associations (str) –

    (optional) Indicates whether to return direct associated entities or direct and inferred associated entities.

    Allowed values are: “DIRECT”, “ALL”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort entities by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntityCollection

Return type:

Response

Example:

Click here to see an example of how to use list_entity_associations API.

list_entity_source_associations(namespace_name, compartment_id, **kwargs)

Returns the list of source associations for the specified entity.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_id (str) – (optional) The entity OCID.
  • entity_type (str) – (optional) The entity type used for filtering. Only associations on an entity with the specified type will be returned.
  • entity_type_display_name (str) – (optional) The entity type display name used for filtering. Only items associated with the entity with the specified type display name will be returned.
  • life_cycle_state (str) –

    (optional) The life cycle state used for filtering. Only associations with the specified life cycle state will be returned.

    Allowed values are: “ALL”, “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”

  • is_show_total (bool) – (optional) A flag indicating whether or not to return the total number of items returned.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned associations

    Allowed values are: “sourceDisplayName”, “timeLastAttempted”, “status”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsAssociationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_entity_source_associations API.

list_fields(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • is_match_all (bool) – (optional) A flag indicating how to handle filtering when multiple filter criteria are specified. A value of true will always result in the most expansive list of items being returned. For example, if two field lists are supplies as filter criteria, a value of true will result in any item matching a field in either list being returned, while a value of false will result in a list of items which only have fields contained in both input lists.
  • source_ids (str) – (optional) A list of source IDs used for filtering. Only fields used by the specified sources will be returned.
  • source_names (str) – (optional) A list of source names used for filtering. Only fields used by the specified sources will be returned.
  • parser_type (str) –

    (optional) The parser type used for filtering. Only items with, or associated with, parsers of the specified type will be returned.

    Allowed values are: “ALL”, “REGEX”, “XML”, “JSON”, “ODL”, “DELIMITED”

  • parser_ids (str) – (optional) A list of parser names used for filtering. Only fields used by the specified parsers will be returned.
  • parser_names (str) – (optional) A list of parser names used for filtering. Only fields used by the specified parsers will be returned.
  • is_include_parser (bool) – (optional) isIncludeParser
  • filter (str) – (optional) filter
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned fields

    Allowed values are: “name”, “dataType”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsFieldCollection

Return type:

Response

Example:

Click here to see an example of how to use list_fields API.

list_label_priorities(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LabelPriorityCollection

Return type:

Response

Example:

Click here to see an example of how to use list_label_priorities API.

list_label_source_details(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (optional) The label name used for filtering. Only items with, or associated with, the specified label name will be returned.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • label_source_sort_by (str) –

    (optional) The attribute used to sort the returned sources

    Allowed values are: “sourceDisplayName”, “labelFieldDisplayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LabelSourceCollection

Return type:

Response

Example:

Click here to see an example of how to use list_label_source_details API.

list_labels(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (optional) The label name used for filtering. Only items with, or associated with, the specified label name will be returned.
  • label_display_text (str) – (optional) The label display text used for filtering. Only labels with the specified name or description will be returned.
  • is_system (str) –

    (optional) The system value used for filtering. Only items with the specified system value will be returned. Valid values are built in, custom (for user defined items), or all (for all items, regardless of system value).

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • label_priority (str) –

    (optional) The label priority used for filtering. Only labels with the specified priority will be returned.

    Allowed values are: “NONE”, “LOW”, “MEDIUM”, “HIGH”

  • is_count_pop (bool) – (optional) A flag indicating whether or not to count the label usage per source and per rule.
  • is_alias_pop (bool) – (optional) A flag indicating whether or not return the aliases used by each label.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • label_sort_by (str) –

    (optional) The attribute used to sort the returned labels

    Allowed values are: “name”, “priority”, “sourceUsing”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLabelCollection

Return type:

Response

Example:

Click here to see an example of how to use list_labels API.

list_log_analytics_em_bridges(namespace_name, compartment_id, **kwargs)

Return a list of log analytics enterprise manager bridges.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only log analytics enterprise manager bridge name whose name matches the entire name given. The match is case-insensitive.
  • lifecycle_state (list[str]) –

    (optional) A filter to return only log analytics enterprise manager bridges matching all the lifecycle states specified for this parameter.

    Allowed values are: “CREATING”, “ACTIVE”, “DELETED”, “NEEDS_ATTENTION”

  • lifecycle_details_contains (str) – (optional) A filter to return only log analytics enterprise manager bridges whose lifecycleDetails contains the specified string.
  • import_status (list[str]) –

    (optional) Filter by the processing status of the latest upload from enterprise manager.

    Allowed values are: “NOT_STARTED”, “SUCCESS”, “IN_PROGRESS”, “FAILED”, “PARTIAL_SUCCESS”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort enterprise manager bridges by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for enterprise manager name is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEmBridgeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_log_analytics_em_bridges API.

list_log_analytics_entities(namespace_name, compartment_id, **kwargs)

Return a list of log analytics entities.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • name (str) – (optional) A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.
  • name_contains (str) – (optional) A filter to return only log analytics entities whose name contains the name given. The match is case-insensitive.
  • entity_type_name (list[str]) – (optional) A filter to return only log analytics entities whose entityTypeName matches the entire log analytics entity type name of one of the entityTypeNames given in the list. The match is case-insensitive.
  • cloud_resource_id (str) – (optional) A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.
  • lifecycle_state (str) –

    (optional) A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”, “DELETED”

  • lifecycle_details_contains (str) – (optional) A filter to return only log analytics entities whose lifecycleDetails contains the specified string.
  • is_management_agent_id_null (str) –

    (optional) A filter to return only those log analytics entities whose managementAgentId is null or is not null.

    Allowed values are: “true”, “false”

  • hostname (str) – (optional) A filter to return only log analytics entities whose hostname matches the entire hostname given.
  • hostname_contains (str) – (optional) A filter to return only log analytics entities whose hostname contains the substring given. The match is case-insensitive.
  • source_id (str) – (optional) A filter to return only log analytics entities whose sourceId matches the sourceId given.
  • creation_source_type (list[str]) –

    (optional) A filter to return only those log analytics entities with the specified auto-creation source.

    Allowed values are: “EM_BRIDGE”, “SERVICE_CONNECTOR_HUB”, “NONE”

  • creation_source_details (str) – (optional) A filter to return only log analytics entities whose auto-creation source details contains the specified string.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort entities by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntityCollection

Return type:

Response

Example:

Click here to see an example of how to use list_log_analytics_entities API.

list_log_analytics_entity_types(namespace_name, **kwargs)

Return a list of log analytics entity types.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • name (str) – (optional) A filter to return only log analytics entity types whose name matches the entire name given. The match is case-insensitive.
  • name_contains (str) – (optional) A filter to return only log analytics entity types whose name or internalName contains name given. The match is case-insensitive.
  • cloud_type (str) –

    (optional) A filter to return CLOUD or NON_CLOUD entity types.

    Allowed values are: “CLOUD”, “NON_CLOUD”, “ALL”

  • lifecycle_state (str) –

    (optional) A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”, “DELETED”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for name is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntityTypeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_log_analytics_entity_types API.

list_log_analytics_log_groups(namespace_name, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only log analytics log groups whose displayName matches the entire display name given. The match is case-insensitive.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLogGroupSummaryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_log_analytics_log_groups API.

list_log_analytics_object_collection_rules(namespace_name, compartment_id, **kwargs)

Gets list of collection rules.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • name (str) – (optional) A filter to return rules only matching with this name.
  • lifecycle_state (str) –

    (optional) Lifecycle state filter.

    Allowed values are: “ACTIVE”, “DELETED”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for name is ascending. If no value is specified timeUpdated is default.

    Allowed values are: “timeUpdated”, “timeCreated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsObjectCollectionRuleCollection

Return type:

Response

Example:

Click here to see an example of how to use list_log_analytics_object_collection_rules API.

list_log_sets(namespace_name, **kwargs)

This API returns a list of log sets.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • log_set_name_contains (list[str]) – (optional) If this filter is present, each of the logsets returned must contain the value of this filter.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogSetCollection

Return type:

Response

Example:

Click here to see an example of how to use list_log_sets API.

list_lookups(namespace_name, type, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • type (str) –

    (required) The lookup type. Valid values are Lookup or Dictionary.

    Allowed values are: “Lookup”, “Dictionary”

  • lookup_display_text (str) – (optional) The lookup text used for filtering. Only lookups with the specified name or description will be returned.
  • is_system (str) –

    (optional) The system value used for filtering. Only items with the specified system value will be returned. Valid values are built in, custom (for user defined items), or all (for all items, regardless of system value).

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “displayName”, “status”, “type”, “updatedTime”, “creationType”

  • status (str) –

    (optional) The lookup status used for filtering when fetching a list of lookups.

    Allowed values are: “ALL”, “SUCCESSFUL”, “FAILED”, “INPROGRESS”

  • is_hide_special (bool) – (optional) A flag indicating whether or not to return OMC annotated or hidden lookups.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLookupCollection

Return type:

Response

Example:

Click here to see an example of how to use list_lookups API.

list_meta_source_types(namespace_name, **kwargs)

Lists the types of log sources supported.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned items

    Allowed values are: “name”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsMetaSourceTypeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_meta_source_types API.

list_namespaces(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NamespaceCollection

Return type:

Response

Example:

Click here to see an example of how to use list_namespaces API.

list_parser_functions(namespace_name, **kwargs)

Lists the parser functions defined for the specified parser.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parser_name (str) – (optional) The parser name used for filtering.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned items

    Allowed values are: “name”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsParserFunctionCollection

Return type:

Response

Example:

Click here to see an example of how to use list_parser_functions API.

list_parser_meta_plugins(namespace_name, **kwargs)

Lists the parser meta plugins available for defining parser functions.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned items

    Allowed values are: “name”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsParserMetaPluginCollection

Return type:

Response

Example:

Click here to see an example of how to use list_parser_meta_plugins API.

list_parsers(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • is_match_all (bool) – (optional) A flag indicating how to handle filtering when multiple filter criteria are specified. A value of true will always result in the most expansive list of items being returned. For example, if two field lists are supplies as filter criteria, a value of true will result in any item matching a field in either list being returned, while a value of false will result in a list of items which only have fields contained in both input lists.
  • source_type (str) –

    (optional) The source type used for filtering. Only parsers associated with a source of the specified type will be returned.

    Allowed values are: “OS_FILE”, “SYSLOG”, “ODL”, “OS_WINDOWS_SYS”

  • parser_name (str) – (optional) The parser name used for filtering.
  • parser_display_text (str) – (optional) The parser display text used for filtering. Only parsers with the specified name or description will be returned.
  • parser_type (str) –

    (optional) The parser type used for filtering. Only items with, or associated with, parsers of the specified type will be returned.

    Allowed values are: “ALL”, “REGEX”, “XML”, “JSON”, “ODL”, “DELIMITED”

  • is_system (str) –

    (optional) The system value used for filtering. Only items with the specified system value will be returned. Valid values are built in, custom (for user defined items), or all (for all items, regardless of system value).

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned parsers

    Allowed values are: “name”, “type”, “sourcesCount”, “timeUpdated”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsParserCollection

Return type:

Response

Example:

Click here to see an example of how to use list_parsers API.

list_query_work_requests(namespace_name, compartment_id, **kwargs)

List active asynchronous queries.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • mode (str) –

    (optional) Filter based on job execution mode

    Allowed values are: “ALL”, “FOREGROUND”, “BACKGROUND”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeStarted is descending. If no value is specified timeStarted is default.

    Allowed values are: “timeStarted”, “timeExpires”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type QueryWorkRequestCollection

Return type:

Response

Example:

Click here to see an example of how to use list_query_work_requests API.

list_recalled_data(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) This is the query parameter of which field to sort by. Only one sort order may be provided. Default order for timeDataStarted is descending. If no value is specified timeDataStarted is default.

    Allowed values are: “timeStarted”, “timeDataStarted”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • time_data_started_greater_than_or_equal (datetime) – (optional) This is the start of the time range for recalled data
  • time_data_ended_less_than (datetime) – (optional) This is the end of the time range for recalled data
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecalledDataCollection

Return type:

Response

Example:

Click here to see an example of how to use list_recalled_data API.

list_scheduled_tasks(namespace_name, task_type, compartment_id, **kwargs)

Lists scheduled tasks.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • task_type (str) –

    (required) Required parameter to specify schedule task type.

    Allowed values are: “SAVED_SEARCH”, “ACCELERATION”, “PURGE”, “ACCELERATION_MAINTENANCE”

  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “displayName”

  • saved_search_id (str) – (optional) A filter to return only scheduled tasks whose stream action savedSearchId matches the given ManagementSavedSearch id [OCID] exactly.
  • display_name_contains (str) – (optional) A filter to return only resources whose display name contains the substring.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ScheduledTaskCollection

Return type:

Response

Example:

Click here to see an example of how to use list_scheduled_tasks API.

list_source_associations(namespace_name, source_name, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The souce name used for filtering associations.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_id (str) – (optional) The entity OCID.
  • life_cycle_state (str) –

    (optional) The life cycle state used for filtering. Only associations with the specified life cycle state will be returned.

    Allowed values are: “ALL”, “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”

  • is_show_total (bool) – (optional) A flag indicating whether or not to return the total number of items returned.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned associations

    Allowed values are: “entityName”, “timeLastAttempted”, “status”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsAssociationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_source_associations API.

list_source_event_types(namespace_name, source_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • display_text (str) – (optional) The text used for filtering event types by name or description.
  • is_system (str) –

    (optional) The system value used for filtering. Only items with the specified system value will be returned. Valid values are built in, custom (for user defined items), or all (for all items, regardless of system value).

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • is_enabled (bool) – (optional) The enabled flag used for filtering. Only items with the specified enabled value will be returned.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned source event types.

    Allowed values are: “eventType”, “timeUpdated”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EventTypeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_source_event_types API.

list_source_extended_field_definitions(namespace_name, source_name, **kwargs)

Lists the extended field definitions for the source with the specified name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned source patterns

    Allowed values are: “baseFieldName”, “regularExpression”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsSourceExtendedFieldDefinitionCollection

Return type:

Response

Example:

Click here to see an example of how to use list_source_extended_field_definitions API.

list_source_label_operators(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned items

    Allowed values are: “name”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLabelOperatorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_source_label_operators API.

list_source_meta_functions(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned items

    Allowed values are: “name”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsMetaFunctionCollection

Return type:

Response

Example:

Click here to see an example of how to use list_source_meta_functions API.

list_source_patterns(namespace_name, source_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • is_include (bool) – (optional) is included source patterns
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) The attribute used to sort the returned source patterns

    Allowed values are: “patternText”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsSourcePatternCollection

Return type:

Response

Example:

Click here to see an example of how to use list_source_patterns API.

list_sources(namespace_name, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_type (str) – (optional) A filter to return only sources associated with entities of the specified type. The match is case-insensitive.
  • source_display_text (str) – (optional) The source display text used for filtering. Only sources with the specified name or description will be returned.
  • is_system (str) –

    (optional) The system value used for filtering. Only items with the specified system value will be returned. Valid values are built in, custom (for user defined items), or all (for all items, regardless of system value).

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • is_auto_associated (bool) – (optional) An auto-associate flag used for filtering. Only sources which are marked for automatic association will be returned.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned sources

    Allowed values are: “name”, “timeUpdated”, “associationCount”, “sourceType”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • name (str) – (optional) A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.
  • is_simplified (bool) – (optional) A flag specifying whether or not to return all source information, or a subset of the information about each source. A value of true will return only the source unique identifier and the source name. A value of false will return all source information (such as author, updated date, system flag, etc.)
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsSourceCollection

Return type:

Response

Example:

Click here to see an example of how to use list_sources API.

list_storage_work_request_errors(compartment_id, work_request_id, namespace_name, **kwargs)

This API returns the list of work request errors if any.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_storage_work_request_errors API.

list_storage_work_requests(compartment_id, namespace_name, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This is the query parameter of which field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default.

    Allowed values are: “timeAccepted”, “timeExpires”, “timeFinished”

  • operation_type (str) –

    (optional) The is the work request type query parameter

    Allowed values are: “OFFBOARD_TENANCY”, “PURGE_STORAGE_DATA”, “RECALL_ARCHIVED_STORAGE_DATA”, “RELEASE_RECALLED_STORAGE_DATA”, “ARCHIVE_STORAGE_DATA”, “CLEANUP_ARCHIVAL_STORAGE_DATA”

  • status (str) –

    (optional) The is the work request status query parameter

    Allowed values are: “ACCEPTED”, “CANCELED”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”

  • time_started (datetime) – (optional) The is the query parameter of when the processing of work request was started
  • time_finished (datetime) – (optional) The is the query parameter of when the processing of work request was finished
  • policy_name (str) – (optional) This is the query parameter of purge policy name
  • policy_id (str) – (optional) This is the query parameter of purge policy ID
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type StorageWorkRequestCollection

Return type:

Response

Example:

Click here to see an example of how to use list_storage_work_requests API.

list_supported_char_encodings(namespace_name, **kwargs)

Gets list of character encodings which are supported by on-demand upload.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CharEncodingCollection

Return type:

Response

Example:

Click here to see an example of how to use list_supported_char_encodings API.

list_supported_timezones(namespace_name, **kwargs)

Gets list of timezones which are supported by on-demand upload.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TimezoneCollection

Return type:

Response

Example:

Click here to see an example of how to use list_supported_timezones API.

list_upload_files(namespace_name, upload_reference, **kwargs)

Gets list of files in an upload along with its processing state.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeStarted is descending. timeCreated, fileName and logGroup are deprecated. Instead use timestarted, name, logGroup accordingly.

    Allowed values are: “timeStarted”, “name”, “logGroupName”, “sourceName”, “status”, “timeCreated”, “fileName”, “logGroup”

  • search_str (str) – (optional) This can be used to filter upload files based on the file, log group and log source names.
  • status (list[str]) –

    (optional) Upload File processing state.

    Allowed values are: “IN_PROGRESS”, “SUCCESSFUL”, “FAILED”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UploadFileCollection

Return type:

Response

Example:

Click here to see an example of how to use list_upload_files API.

list_upload_warnings(namespace_name, upload_reference, **kwargs)

Gets list of warnings in an upload caused by incorrect configuration.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UploadWarningCollection

Return type:

Response

Example:

Click here to see an example of how to use list_upload_warnings API.

list_uploads(namespace_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • name (str) – (optional) Name of the upload container.
  • name_contains (str) – (optional) A filter to return only uploads whose name contains the given name.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for name is ascending. If no value is specified timeUpdated is default.

    Allowed values are: “timeUpdated”, “timeCreated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • warnings_filter (str) –

    (optional) Use this for filtering uploads w.r.t warnings. Only one value is allowed. If no value is specified then ALL is taken as default, which means that all the uploads with and without warnings will be returned.

    Allowed values are: “WITH_WARNINGS”, “WITHOUT_WARNINGS”, “ALL”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UploadCollection

Return type:

Response

Example:

Click here to see an example of how to use list_uploads API.

list_warnings(namespace_name, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • warning_state (str) –

    (optional) The warning state used for filtering. A value of SUPPRESSED will return only suppressed warnings, a value of UNSUPPRESSED will return only unsuppressed warnings, and a value of ALL will return all warnings regardless of their suppression state. Default is UNSUPPRESSED.

    Allowed values are: “ALL”, “SUPPRESSED”, “UNSUPPRESSED”

  • source_name (str) – (optional) The source name.
  • source_pattern (str) – (optional) The source pattern used for filtering. Only warnings associated with a source with the specified pattern will be returned.
  • warning_message (str) – (optional) warning message query parameter
  • entity_name (str) – (optional) The entity name used for filtering. Only warnings associated with an entity with the specified name will be returned.
  • entity_type (str) – (optional) The entity type used for filtering. Only associations on an entity with the specified type will be returned.
  • warning_type (str) – (optional) The warning type query parameter.
  • is_no_source (bool) – (optional) A flag indicating whether to filter warnings based on source display name or on warning level. A value of true will filter based on warning level (rule, source, or pattern), while a value of false will filter based on source display name.
  • start_time (str) – (optional) The warning start date query parameter.
  • end_time (str) – (optional) The warning end date query parameter.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned warnings

    Allowed values are: “EntityType”, “SourceName”, “PatternText”, “FirstReported”, “WarningMessage”, “Host”, “EntityName”, “InitialWarningDate”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsWarningCollection

Return type:

Response

Example:

Click here to see an example of how to use list_warnings API.

list_work_request_errors(namespace_name, work_request_id, **kwargs)

Return a (paginated) list of errors for a given work request.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(namespace_name, work_request_id, **kwargs)

Return a (paginated) list of logs for a given work request.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequestLogCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(namespace_name, compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequestCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

offboard_namespace(namespace_name, **kwargs)

Off-boards a tenant from Logging Analytics

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use offboard_namespace API.

onboard_namespace(namespace_name, **kwargs)

On-boards a tenant to Logging Analytics.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use onboard_namespace API.

parse_query(namespace_name, parse_query_details, **kwargs)

Describe query

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parse_query_details (oci.log_analytics.models.ParseQueryDetails) – (required) Query string to be parsed
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ParseQueryOutput

Return type:

Response

Example:

Click here to see an example of how to use parse_query API.

pause_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Pause the scheduled task specified by {scheduledTaskId}.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ScheduledTask

Return type:

Response

Example:

Click here to see an example of how to use pause_scheduled_task API.

purge_storage_data(namespace_name, purge_storage_data_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • purge_storage_data_details (oci.log_analytics.models.PurgeStorageDataDetails) – (required) This is the input to purge old data.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use purge_storage_data API.

put_query_work_request_background(namespace_name, work_request_id, **kwargs)

Put the work request specified by {workRequestId} into the background. Backgrounded queries will preserve query results on query completion for up to 7 days for recall. After 7 days the results and query expire.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type QueryWorkRequest

Return type:

Response

Example:

Click here to see an example of how to use put_query_work_request_background API.

query(namespace_name, query_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • query_details (oci.log_analytics.models.QueryDetails) – (required) Query to be executed.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) Maximum number of results to return in this request. Note a limit=-1 returns all results from pageId onwards up to maxtotalCount.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type QueryAggregation

Return type:

Response

Example:

Click here to see an example of how to use query API.

recall_archived_data(namespace_name, recall_archived_data_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • recall_archived_data_details (oci.log_analytics.models.RecallArchivedDataDetails) – (required) This is the input to recall archived data.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use recall_archived_data API.

register_lookup(namespace_name, type, register_lookup_content_file_body, **kwargs)

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.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • type (str) –

    (required) The lookup type. Valid values are Lookup or Dictionary.

    Allowed values are: “Lookup”, “Dictionary”

  • register_lookup_content_file_body (stream) – (required) file containing data for lookup creation
  • name (str) – (optional) A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.
  • description (str) – (optional) The description for a created lookup.
  • char_encoding (str) – (optional) The character encoding of the uploaded file.
  • is_hidden (bool) – (optional) A flag indicating whether or not the new lookup should be hidden.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • expect (str) – (optional) A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent. If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • buffer_limit (int) –

    (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

    The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns:

A Response object with data of type LogAnalyticsLookup

Return type:

Response

Example:

Click here to see an example of how to use register_lookup API.

release_recalled_data(namespace_name, release_recalled_data_details, **kwargs)

This API submits a work request to release recalled data based on time interval and data type.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • release_recalled_data_details (oci.log_analytics.models.ReleaseRecalledDataDetails) – (required) This is the input to release recalled data
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use release_recalled_data API.

remove_entity_associations(namespace_name, log_analytics_entity_id, remove_entity_associations_details, **kwargs)

Delete association between input source log analytics entity and destination entities.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • remove_entity_associations_details (oci.log_analytics.models.RemoveEntityAssociationsDetails) – (required) This parameter specifies the entity OCIDs with which associations are to be deleted.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_entity_associations API.

remove_preferences(namespace_name, remove_preferences_details, **kwargs)

Removes the tenant preferences. Currently, only “DEFAULT_HOMEPAGE” is supported.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • remove_preferences_details (oci.log_analytics.models.LogAnalyticsPreferenceDetails) – (required) Details of the tenant preferences to delete.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_preferences API.

remove_source_event_types(namespace_name, source_name, remove_event_type_details, **kwargs)

Remove one or more event types from a source.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) The source name.
  • remove_event_type_details (oci.log_analytics.models.EventTypeDetails) – (required) Details of event types to be removed from the source.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_source_event_types API.

resume_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Resume the scheduled task specified by {scheduledTaskId}.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ScheduledTask

Return type:

Response

Example:

Click here to see an example of how to use resume_scheduled_task API.

run(namespace_name, scheduled_task_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • time_start (datetime) – (optional) Optional parameter to specify start of time range, in the format defined by RFC3339. Default value is beginning of time.
  • time_end (datetime) – (optional) Optional parameter to specify end of time range, in the format defined by RFC3339. Default value is end of time.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use run API.

set_unprocessed_data_bucket(namespace_name, bucket_name, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • bucket_name (str) – (required) Name of the Object Storage bucket.
  • is_enabled (bool) – (optional) The enabled flag used for filtering. Only items with the specified enabled value will be returned.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UnprocessedDataBucket

Return type:

Response

Example:

Click here to see an example of how to use set_unprocessed_data_bucket API.

suggest(namespace_name, suggest_details, **kwargs)

Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • suggest_details (oci.log_analytics.models.SuggestDetails) – (required) Query string seeking suggestions for.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SuggestOutput

Return type:

Response

Example:

Click here to see an example of how to use suggest API.

suppress_warning(namespace_name, warning_reference_details, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • warning_reference_details (oci.log_analytics.models.WarningReferenceDetails) – (required) list of agent warning references to suppress
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use suppress_warning API.

test_parser(namespace_name, test_parser_payload_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • test_parser_payload_details (oci.log_analytics.models.TestParserPayloadDetails) – (required) Details for test payload
  • scope (str) –

    (optional) The scope used when testing a parser.

    Allowed values are: “LOG_LINES”, “LOG_ENTRIES”, “LOG_LINES_LOG_ENTRIES”

  • req_origin_module (str) – (optional) The module to test. A value of ‘ParserFunctionTest’ will result in testing of the parser functions.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ParserTestResult

Return type:

Response

Example:

Click here to see an example of how to use test_parser API.

unsuppress_warning(namespace_name, warning_reference_details, compartment_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • warning_reference_details (oci.log_analytics.models.WarningReferenceDetails) – (required) warnings list
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use unsuppress_warning API.

update_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, update_log_analytics_em_bridge_details, **kwargs)

Update log analytics enterprise manager bridge with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_em_bridge_id (str) – (required) The log analytics enterprise manager bridge OCID.
  • update_log_analytics_em_bridge_details (oci.log_analytics.models.UpdateLogAnalyticsEmBridgeDetails) – (required) Log analytics enterprise manager information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEmBridge

Return type:

Response

Example:

Click here to see an example of how to use update_log_analytics_em_bridge API.

update_log_analytics_entity(namespace_name, log_analytics_entity_id, update_log_analytics_entity_details, **kwargs)

Update the log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • update_log_analytics_entity_details (oci.log_analytics.models.UpdateLogAnalyticsEntityDetails) – (required) Log analytics entity information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsEntity

Return type:

Response

Example:

Click here to see an example of how to use update_log_analytics_entity API.

update_log_analytics_entity_type(namespace_name, update_log_analytics_entity_type_details, entity_type_name, **kwargs)

Update custom log analytics entity type. Out of box entity types cannot be udpated.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • update_log_analytics_entity_type_details (oci.log_analytics.models.UpdateLogAnalyticsEntityTypeDetails) – (required) Log analytics entity type update details.
  • entity_type_name (str) – (required) Log analytics entity type name.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_log_analytics_entity_type API.

update_log_analytics_log_group(namespace_name, log_analytics_log_group_id, update_log_analytics_log_group_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • update_log_analytics_log_group_details (oci.log_analytics.models.UpdateLogAnalyticsLogGroupDetails) – (required) The information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLogGroup

Return type:

Response

Example:

Click here to see an example of how to use update_log_analytics_log_group API.

update_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, update_log_analytics_object_collection_rule_details, **kwargs)

Updates configuration of the object collection rule for the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • update_log_analytics_object_collection_rule_details (oci.log_analytics.models.UpdateLogAnalyticsObjectCollectionRuleDetails) – (required) The rule config to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsObjectCollectionRule

Return type:

Response

Example:

Click here to see an example of how to use update_log_analytics_object_collection_rule API.

update_lookup(namespace_name, lookup_name, update_lookup_metadata_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • update_lookup_metadata_details (oci.log_analytics.models.UpdateLookupMetadataDetails) – (required) The information required to update a lookup.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLookup

Return type:

Response

Example:

Click here to see an example of how to use update_lookup API.

update_lookup_data(namespace_name, lookup_name, update_lookup_file_body, **kwargs)

Updates the lookup content. The csv file containing the content to be updated is passed in as binary data in the request.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • update_lookup_file_body (stream) – (required) The file to use for the lookup update.
  • is_force (bool) – (optional) is force
  • char_encoding (str) – (optional) The character encoding of the uploaded file.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • expect (str) – (optional) A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent. If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • buffer_limit (int) –

    (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

    The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_lookup_data API.

update_preferences(namespace_name, update_preferences_details, **kwargs)

Updates the tenant preferences. Currently, only “DEFAULT_HOMEPAGE” is supported.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • update_preferences_details (oci.log_analytics.models.LogAnalyticsPreferenceDetails) – (required) Details of the tenant preferences to update.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_preferences API.

update_scheduled_task(namespace_name, scheduled_task_id, update_scheduled_task_details, **kwargs)

Update the scheduled task. Schedules may be updated only for taskType SAVED_SEARCH and PURGE.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • update_scheduled_task_details (oci.log_analytics.models.UpdateScheduledTaskDetails) – (required) Update details. Schedules may be updated only for taskType SAVED_SEARCH and PURGE.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ScheduledTask

Return type:

Response

Example:

Click here to see an example of how to use update_scheduled_task API.

update_storage(namespace_name, update_storage_details, **kwargs)

This API updates the archiving configuration

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • update_storage_details (oci.log_analytics.models.UpdateStorageDetails) – (required) This is the archiving configuration
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Storage

Return type:

Response

Example:

Click here to see an example of how to use update_storage API.

upload_log_events_file(namespace_name, log_group_id, upload_log_events_file_details, **kwargs)

Accepts log events for processing by Logging Analytics.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_group_id (str) – (required) The log group OCID that gets mapped to the uploaded logs.
  • upload_log_events_file_details (stream) –

    (required) Log events data to be uploaded. The data could be uploaded with or without logSet information depending on whether logSet is enabled for the tenancy or not. Supported formats include 1. json file : logSet (if needed) should be sent as “logSet” query parameter 2. gzip file : logSet (if needed) should be sent as “logSet” query parameter 3. zip file : containing multiple json files. LogSet information (if needed) should be appended to every filename in the zip.

    Supported filename format with logSet detail is <filename>_logSet=<logset>.json
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • log_set (str) – (optional) The log set that gets associated with the uploaded logs.
  • payload_type (str) –

    (optional) Identifies the type of request payload.

    Allowed values are: “JSON”, “GZIP”, “ZIP”

  • content_type (str) – (optional) The content type of the log data.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • expect (str) – (optional) A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent. If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • buffer_limit (int) –

    (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

    The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use upload_log_events_file API.

upload_log_file(namespace_name, upload_name, log_source_name, filename, opc_meta_loggrpid, upload_log_file_body, **kwargs)

Accepts log data for processing by Logging Analytics.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_name (str) – (required) The name of the upload. This can be considered as a container name where different kind of logs will be collected and searched together. This upload name/id can further be used for retrieving the details of the upload, including its status or deleting the upload.
  • log_source_name (str) – (required) Name of the log source that will be used to process the files being uploaded.
  • filename (str) – (required) The name of the file being uploaded. The extension of the filename part will be used to detect the type of file (like zip, tar).
  • opc_meta_loggrpid (str) – (required) The log group OCID to which the log data in this upload will be mapped to.
  • upload_log_file_body (stream) – (required) Log data
  • entity_id (str) – (optional) The entity OCID.
  • timezone (str) – (optional) Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used
  • char_encoding (str) – (optional) Character encoding to be used to detect the encoding type of file(s) being uploaded. When this property is not specified, system detected character encoding will be used.
  • date_format (str) – (optional) This property is used to specify the format of the date. This is to be used for ambiguous dates like 12/11/10. This property can take any of the following values - MONTH_DAY_YEAR, DAY_MONTH_YEAR, YEAR_MONTH_DAY, MONTH_DAY, DAY_MONTH.
  • date_year (str) – (optional) Used to indicate the year where the log entries timestamp do not mention year (Ex: Nov 8 20:45:56).
  • invalidate_cache (bool) – (optional) This property can be used to reset configuration cache in case of an issue with the upload.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • content_md5 (str) –

    (optional) The base-64 encoded MD5 hash of the body. If the Content-MD5 header is present, Logging Analytics performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the log data is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message:

    ”The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)”

  • content_type (str) – (optional) The content type of the log data.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • log_set (str) – (optional) The log set that gets associated with the uploaded logs.
  • expect (str) – (optional) A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent. If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • buffer_limit (int) –

    (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

    The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns:

A Response object with data of type Upload

Return type:

Response

Example:

Click here to see an example of how to use upload_log_file API.

upsert_associations(namespace_name, upsert_log_analytics_association_details, **kwargs)

Creates or updates associations between sources and entities. All entities should belong to the specified input compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_association_details (oci.log_analytics.models.UpsertLogAnalyticsAssociationDetails) – (required) list of association details
  • is_from_republish (bool) – (optional) isFromRepublish
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use upsert_associations API.

upsert_field(namespace_name, upsert_log_analytics_field_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_field_details (oci.log_analytics.models.UpsertLogAnalyticsFieldDetails) – (required) Details for the new LogAnalyticsFieldDetails.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsField

Return type:

Response

Example:

Click here to see an example of how to use upsert_field API.

upsert_label(namespace_name, upsert_log_analytics_label_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_label_details (oci.log_analytics.models.UpsertLogAnalyticsLabelDetails) – (required) Details for the new LogAnalyticsTagDetails.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsLabel

Return type:

Response

Example:

Click here to see an example of how to use upsert_label API.

upsert_parser(namespace_name, upsert_log_analytics_parser_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_parser_details (oci.log_analytics.models.UpsertLogAnalyticsParserDetails) – (required) Details for the new LoganParserDetails.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsParser

Return type:

Response

Example:

Click here to see an example of how to use upsert_parser API.

upsert_source(namespace_name, upsert_log_analytics_source_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_source_details (oci.log_analytics.models.UpsertLogAnalyticsSourceDetails) – (required) Details for the new LoganSourceDetails.
  • create_like_source_id (int) – (optional) The unique identifier of the source to use as the reference for a create like operation.
  • is_incremental (bool) – (optional) A flag indicating whether or not the update of a source is incremental or not. If incremental, the name of the source must be specified.
  • is_ignore_warning (bool) – (optional) is ignore warning
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsSource

Return type:

Response

Example:

Click here to see an example of how to use upsert_source API.

validate_association_parameters(namespace_name, upsert_log_analytics_association_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_association_details (oci.log_analytics.models.UpsertLogAnalyticsAssociationDetails) – (required) Details for the new log analytics associations.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned association parameters

    Allowed values are: “sourceDisplayName”, “status”

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LogAnalyticsAssociationParameterCollection

Return type:

Response

Example:

Click here to see an example of how to use validate_association_parameters API.

validate_file(namespace_name, object_location, filename, **kwargs)

Validates a log file to check whether it is eligible to be uploaded or not.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • object_location (str) – (required) Location of the log file.
  • filename (str) – (required) The name of the file being uploaded. The extension of the filename part will be used to detect the type of file (like zip, tar).
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FileValidationResponse

Return type:

Response

Example:

Click here to see an example of how to use validate_file API.

validate_source(namespace_name, upsert_log_analytics_source_details, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_source_details (oci.log_analytics.models.UpsertLogAnalyticsSourceDetails) – (required) Details for the new LoganSourceDetails.
  • create_like_source_id (int) – (optional) The unique identifier of the source to use as the reference for a create like operation.
  • is_incremental (bool) – (optional) A flag indicating whether or not the update of a source is incremental or not. If incremental, the name of the source must be specified.
  • is_ignore_warning (bool) – (optional) is ignore warning
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SourceValidateResults

Return type:

Response

Example:

Click here to see an example of how to use validate_source API.

validate_source_extended_field_details(namespace_name, log_analytics_source, **kwargs)

Checks if the specified input contains valid extended field definitions against the provided example content.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_source (oci.log_analytics.models.LogAnalyticsSource) – (required) Details for the new LogAnalyticsSource.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExtendedFieldsValidationResult

Return type:

Response

Example:

Click here to see an example of how to use validate_source_extended_field_details API.

validate_source_mapping(namespace_name, object_location, filename, log_source_name, **kwargs)

Validates the source mapping for a given file and provides match status and the parsed representation of log data.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • object_location (str) – (required) Location of the log file.
  • filename (str) – (required) The name of the file being uploaded. The extension of the filename part will be used to detect the type of file (like zip, tar).
  • log_source_name (str) – (required) Name of the log source that will be used to process the files being uploaded.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SourceMappingResponse

Return type:

Response

Example:

Click here to see an example of how to use validate_source_mapping API.