Show / Hide Table of Contents

Namespace Oci.LoganalyticsService.Models

Classes

AbstractColumn

Generic column defining all attributes common to all querylanguage columns.

AbstractColumnModelConverter

AbstractCommandDescriptor

Generic command descriptor defining all attributes common to all querylanguage commands for parse output.

AbstractCommandDescriptorModelConverter

AbstractField

Generic field defining all attributes common to all querylanguage fields.

AbstractFieldModelConverter

AbstractParserTestResultLogEntry

AbstractParserTestResultLogEntry

AbstractParserTestResultLogLine

AbstractParserTestResultLogLine

Action

Action for scheduled task.

ActionModelConverter

AddEntityAssociationDetails

Information about the associations to be added between a source log analytics entity and other existing destination entities.

AddFieldsCommandDescriptor

Command descriptor for querylanguage ADDFIELDS command.

AddInsightsCommandDescriptor

Command descriptor for querylanguage ADDINSIGHTS command.

AnomalyCommandDescriptor

Command descriptor for querylanguage ANOMALY command.

ArchivingConfiguration

This is the configuration for data archiving in object storage

Argument

Generic queryString argument.

ArgumentModelConverter

AssignEncryptionKeyDetails

This is the input used to assign customer encryption key.

AssociableEntity

Entity details including whether or not it is eligible for association with the source.

AssociableEntityCollection

The collection of entities that are eligible or ineligible to be associated to the source.

AssociationProperty

A property represented as a name-value pair.

AssociationSummaryReport

AssociationSummaryReport

AutoAssociationCollection

Auto association details of the source.

AutoAssociationState

Auto association state of the source.

AutoLookups

AutoLookups

AutoSchedule

Auto Fixed frequency schedule for a scheduled task.

BottomCommandDescriptor

Command descriptor for querylanguage BOTTOM command.

BucketCommandDescriptor

Command descriptor for querylanguage BUCKET command.

BucketRange

Represents querylanguage bucket command input arguments in parse output.

ChangeIngestTimeRuleCompartmentDetails

The information required to change the compartment of an ingest time rule.

ChangeLogAnalyticsEmBridgeCompartmentDetails

Log analytics enterprise manager bridge compartment to be updated.

ChangeLogAnalyticsEntityCompartmentDetails

Log analytics entity compartment to be updated.

ChangeLogAnalyticsLogGroupCompartmentDetails

The information required to change a log group compartment.

ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails

New compartment details.

ChangeLookupCompartmentDetails

The information required to change the compartment of a lookup.

ChangeScheduledTaskCompartmentDetails

The details for changing the compartment of a scheduled task.

CharEncodingCollection

List of supported character encodings.

ChartColumn

Column returned by querylanguage link command.

ChartDataColumn

A data series specific to a particular link output field.

ClassifyColumn

Column containing query results produced by the query language classify command.

ClassifyCommandDescriptor

Command descriptor for querylanguage CLASSIFY command.

ClusterCommandDescriptor

Command descriptor for querylanguage CLUSTER command.

ClusterCompareCommandDescriptor

Command descriptor for querylanguage CLUSTERCOMPARE command.

ClusterDetailsCommandDescriptor

Command descriptor for querylanguage CLUSTERDETAILS command.

ClusterSplitCommandDescriptor

Command descriptor for querylanguage CLUSTERSPLIT command.

Column

Default column object representing querylanguage result columns.

ColumnName

Column Names from a SQL Query

ColumnNameCollection

Column Name Collection

CommandDescriptor

Generic catch-all command descriptor

CompareCommandDescriptor

Command descriptor for querylanguage COMPARE command.

CompareContentDetails

The two strings to compare.

CompareContentResult

The intraline diff result.

CompareLineResult

The result of a comparison of two lines in the two content input strings.

ConditionBlock

A condition block. This could represent a single condition, or have nested condition blocks under it. To form a single condition, specify the fieldName, labelConditionOperator and labelConditionValue(s). To form nested conditions, specify the conditions in conditionBlocks, and how to join them in conditionBlocksOperator.

CreateAccelerationTaskDetails

Details for creating a scheduled task to accelerate a saved search. The client must specify the savedSearchId, and the service will supply other details. The resulting scheduled task will have TaskType ACCELERATION.

CreateIngestTimeRuleDetails

The information required to create an ingest time rule.

CreateLogAnalyticsEmBridgeDetails

Details for a new enterprise manager bridge to be added.

CreateLogAnalyticsEntityDetails

Details for new log analytics entity to be added.

CreateLogAnalyticsEntityTypeDetails

Details for new log analytics entity type to be added.

CreateLogAnalyticsLogGroupDetails

Information about a new log group.

CreateLogAnalyticsObjectCollectionRuleDetails

The configuration details of collection rule to enable automatic log collection from an object storage bucket.

CreateScheduledTaskDetails

Details for creating a scheduled task.

CreateScheduledTaskDetailsModelConverter

CreateStandardTaskDetails

Details for creating a scheduled task. The client must fully specify the details. Not supported for TaskType ACCELERATION.

CreateTableCommandDescriptor

Command descriptor for querylanguage CREATETABLE command.

CreateViewCommandDescriptor

Command descriptor for querylanguage CREATEVIEW command.

CreationSource

Details for auto-created entity.

CredentialEndpoint

The endpoint from where to fetch a credential, for example, the OAuth 2.0 token.

CronSchedule

Cron schedule for a scheduled task.

DedupCommandDescriptor

Command descriptor for querylanguage DEDUP command.

DeleteCommandDescriptor

Command descriptor for querylanguage DELETE command.

DeleteLogAnalyticsAssociation

DeleteLogAnalyticsAssociation

DeleteLogAnalyticsAssociationDetails

The information required to delete a list of associations.

DeltaCommandDescriptor

Command descriptor for querylanguage DELTA command.

DemoModeCommandDescriptor

Command descriptor for querylanguage DEMOMODE command.

Dependency

Details of a dependency an object or feature defines on another. For example, a source may depend on a parser either directly or indirectly.

DependentParser

A parser that depends on or uses the resource such as a field or another parser.

DependentSource

A source that depends on or uses the resource such as a field or a parser

DisableAutoAssociationDetail

The information required to disable log source auto-association.

DisableAutoAssociationDetails

The information required to disable log source auto-association.

DistinctCommandDescriptor

Command descriptor for querylanguage DISTINCT command.

EfdRegexResult

EfdRegexResult

EffectivePropertyCollection

A collection of effective properties.

EffectivePropertySummary

A property and its effective value details.

EnableAutoAssociationDetail

The information required to enable log source auto-association.

EnableAutoAssociationDetails

The information required to enable log source auto-association.

EncryptionKeyInfoCollection

This is a list of encryption key info.

EncryptionKeyInfoSummary

This is the summary of an encryption key.

EndpointCredentials

An object containing credential details to authenticate/authorize a REST request.

EndpointProxy

An object containing the endpoint proxy details.

EndpointRequest

An object containing details to make a REST request.

EndpointResponse

An object containing details of a REST response.

EndpointResult

The validation status of a specified endpoint.

EntityTypeProperty

Properties used in file patterns specified in log sources.

ErrorDetails

Error Information.

EstimatePurgeDataSizeDetails

This is the input used to estimate the size of data that might be purged

EstimatePurgeDataSizeResult

purge data size in bytes

EstimateRecallDataSizeDetails

This is the input used to estimate the size of data to be recalled

EstimateRecallDataSizeResult

This is the size and time range of data to be recalled

EstimateReleaseDataSizeDetails

This is the input used to estimate the size of data to be released

EstimateReleaseDataSizeResult

This is the size and time range of data to be released

EvalCommandDescriptor

Command descriptor for querylanguage EVAL command.

EventStatsCommandDescriptor

Command descriptor for querylanguage EVENTSTATS command.

EventType

The event type.

EventTypeCollection

The collection of event types and corresponding versions mapped to the source.

EventTypeDetails

The collection of event types and corresponding versions mapped to the source.

ExportContent

The content to export.

ExportDetails

Input arguments for running a query synchronosly and streaming the results as soon as they become available.

ExtendedFieldsValidationResult

ExtendedFieldsValidationResult

ExtractCommandDescriptor

Command descriptor for querylanguage EXTRACT command.

ExtractLogFieldResults

log field path values

ExtractLogHeaderDetails

log header values

ExtractLogHeaderResults

log header values

Field

Default field object representing fields specified in the queryString.

FieldArgument

QueryString argument of type field.

FieldSummaryCommandDescriptor

Command descriptor for querylanguage FIELDSUMMARY command.

FieldSummaryReport

FieldSummaryReport

FieldValue

Field value representing and entry in a list-of-values field.

FieldsAddRemoveField

Field denoting a field specified in querylanguage FIELDS command.

FieldsCommandDescriptor

Command descriptor for querylanguage FIELDS command.

FileValidationResponse

Response object containing details about file upload eligibility.

Filter

Query builder filter action to apply edit to queryString.

FilterDetails

Query builder edit request details.

FilterOutput

Query builder api response object containing updated querystring's

FixedFrequencySchedule

Fixed frequency schedule for a scheduled task.

FrequentCommandDescriptor

Command descriptor for querylanguage FREQUENT command.

FunctionField

Field outlining queryString aggregate function entries.

GenericConditionBlock

A condition block. This could represent a single condition, or have nested condition blocks under it. To form a single condition, specify the name, operator and value(s). To form nested conditions, specify the conditions in conditionBlocks, and how to join them in conditionBlocksOperator.

GeoStatsCommandDescriptor

Command descriptor for querylanguage GEOSTATS command. This is similiar to STATS with some built in functions for City, State and Country by Coordinates.

HeadCommandDescriptor

Command descriptor for querylanguage HEAD command.

HighlightCommandDescriptor

Command descriptor for querylanguage HIGHLIGHT command.

HighlightGroupsCommandDescriptor

Command descriptor for querylanguage HIGHLIGHTGROUPS command.

HighlightRowsCommandDescriptor

Command descriptor for querylanguage HIGHLIGHTROWS command.

Indexes

Indexes

IngestTimeRule

An ingest time rule object.

IngestTimeRuleAction

The action to be performed if the ingest time rule condition(s) are satisfied.

IngestTimeRuleActionModelConverter

IngestTimeRuleAdditionalFieldCondition

The additional field condition(s) to evaluate for an ingest time rule.

IngestTimeRuleCondition

The condition(s) to evaluate for an ingest time rule.

IngestTimeRuleConditionModelConverter

IngestTimeRuleFieldCondition

The field condition(s) to evaluate for an ingest time rule.

IngestTimeRuleMetricExtractionAction

Details of metric to post to OCI Monitoring if ingest time rule condition(s) are satisfied.

IngestTimeRuleResource

Ingest Time Rule Resource authorization container for IngestTimeRule resources

IngestTimeRuleSummary

Summary of an ingest time rule.

IngestTimeRuleSummaryCollection

A collection of Logging Analytics ingest time rules.

JsonExtractCommandDescriptor

Command descriptor for querylanguage JSONEXTRACT command.

LabelNames

LabelName

LabelPriority

The label priority.

LabelPriorityCollection

Label Priority Info List

LabelSourceCollection

LogAnalytics Label Source Collection

LabelSourceSummary

source summary

LabelSummaryReport

LabelSummaryReport

Level

An object used to represent a level at which a property or resource or constraint is defined.

LinkCommandDescriptor

Command descriptor for querylanguage LINK command.

LinkDetailsCommandDescriptor

Command descriptor for querylanguage LINKDETAILS command.

LiteralArgument

QueryString argument of type literal.

LogAnalyticsAssociatedEntity

LogAnalyticsAssociatedEntity

LogAnalyticsAssociatedEntityCollection

LogAnalytics Associated Entity Collection

LogAnalyticsAssociation

LogAnalyticsAssociation

LogAnalyticsAssociationCollection

A collection of associations.

LogAnalyticsAssociationParameter

LogAnalyticsAssociationParameter

LogAnalyticsAssociationParameterCollection

LogAnalytics Association Parameter Collection

LogAnalyticsCategory

A category into which resources can be placed.

LogAnalyticsCategoryCollection

A collection of categories.

LogAnalyticsConfigWorkRequest

LogAnalyticsConfigWorkRequest

LogAnalyticsConfigWorkRequestCollection

LogAnalyticsConfigWorkRequestCollection

LogAnalyticsConfigWorkRequestPayload

LogAnalyticsConfigWorkRequestPayload

LogAnalyticsConfigWorkRequestSummary

LogAnalyticsConfigWorkRequestSummary

LogAnalyticsEmBridge

Configuration details for enterprise manager bridge.

LogAnalyticsEmBridgeCollection

Collection of log analytics enterprise manager bridges.

LogAnalyticsEmBridgeSummary

Enterprise manager bridge summary.

LogAnalyticsEmBridgeSummaryReport

Log-Analytics EM Bridge counts summary.

LogAnalyticsEndpoint

Endpoint configuration for REST API based log collection.

LogAnalyticsEndpointModelConverter

LogAnalyticsEntity

Description of a log analytics entity.

LogAnalyticsEntityCollection

Collection of log analytics entities.

LogAnalyticsEntitySummary

Summary of a log analytics entity.

LogAnalyticsEntitySummaryReport

Log-Analytics entity counts summary.

LogAnalyticsEntityTopologyCollection

Collection of log analytics entity topologies.

LogAnalyticsEntityTopologyLink

Log Analytics entity relationship link used in hierarchical representation of entity relationships topology.

LogAnalyticsEntityTopologyLinkCollection

Collection of log analytics entity relationship links.

LogAnalyticsEntityTopologySummary

Log Analytics Entity topology that contains a set of log analytics entities and a set of relationships between those.

LogAnalyticsEntityType

Description of log analytics entity type.

LogAnalyticsEntityTypeCollection

Collection of log analytics entities.

LogAnalyticsEntityTypeSummary

Summary of a log analytics entity type.

LogAnalyticsExtendedField

LogAnalyticsExtendedField

LogAnalyticsField

Field Details

LogAnalyticsFieldCollection

LogAnalytics Field Collection

LogAnalyticsFieldSummary

A summary of a field.

LogAnalyticsFieldUsages

Contains information about resources such as parsers and sources that use the field.

LogAnalyticsImportCustomChangeList

LogAnalyticsImportCustomChangeList

LogAnalyticsImportCustomContent

LogAnalyticsImportCustomContent

LogAnalyticsLabel

LogAnalytics label

LogAnalyticsLabelAlias

Label alias mapping view

LogAnalyticsLabelCollection

A collection of LogAnalytics Labels.

LogAnalyticsLabelDefinition

LogAnalyticsLabelDefinition

LogAnalyticsLabelOperator

LogAnalyticsLabelOperator

LogAnalyticsLabelOperatorCollection

LogAnalyticsLabelOperatorCollection

LogAnalyticsLabelSummary

LogAnalytics label

LogAnalyticsLabelView

LogAnalyticsLabelView

LogAnalyticsLogGroup

Summary of an Log-Analytics log group.

LogAnalyticsLogGroupSummary

Summary of a Log-Analytics log group.

LogAnalyticsLogGroupSummaryCollection

A collection of Log-Analytics log groups.

LogAnalyticsLookup

LogAnalyticsLookup

LogAnalyticsLookupCollection

LogAnalytics Lookup Collection

LogAnalyticsLookupFields

LogAnalyticsLookupFields

LogAnalyticsMetaFunction

LogAnalyticsMetaFunction

LogAnalyticsMetaFunctionArgument

LogAnalyticsMetaFunctionArgument

LogAnalyticsMetaFunctionCollection

LogAnalyticsMetaFunctionCollection

LogAnalyticsMetaSourceType

LogAnalyticsMetaSourceType

LogAnalyticsMetaSourceTypeCollection

Source Meta Type List

LogAnalyticsMetadata

Entity metadata information.

LogAnalyticsMetadataCollection

A collection of entity metadata information.

LogAnalyticsMetadataDetails

Details of Entity Metadata.

LogAnalyticsMetadataSummary

Details of entity metadata information.

LogAnalyticsMetric

LogAnalyticsMetric

LogAnalyticsObjectCollectionRule

The configuration details of an Object Storage based collection rule.

LogAnalyticsObjectCollectionRuleCollection

Collection of LogAnalyticsObjectCollectionRuleSummary objects.

LogAnalyticsObjectCollectionRuleSummary

The summary of an Object Storage based collection rule.

LogAnalyticsParameter

LogAnalyticsParameter

LogAnalyticsParser

LogAnalyticsParser

LogAnalyticsParserCollection

LogAnalyticsParserCollection

LogAnalyticsParserField

LogAnalyticsParserField

LogAnalyticsParserFilter

LogAnalyticsParserFilter

LogAnalyticsParserFunction

LogAnalyticsParserFunction

LogAnalyticsParserFunctionCollection

LogAnalyticsParserFunctionCollection

LogAnalyticsParserFunctionParameter

LogAnalyticsParserFunctionParameter

LogAnalyticsParserMetaPlugin

LogAnalyticsParserMetaPlugin

LogAnalyticsParserMetaPluginCollection

LogAnalyticsParserMetaPluginCollection

LogAnalyticsParserMetaPluginParameter

LogAnalyticsParserMetaPluginParameter

LogAnalyticsParserSummary

LogAnalyticsParserSummary

LogAnalyticsPatternFilter

LogAnalyticsPatternFilter

LogAnalyticsPreference

The preference information

LogAnalyticsPreferenceCollection

A collection of preference information.

LogAnalyticsPreferenceDetails

Preference information used to update preference settings.

LogAnalyticsProperty

A property represented as a name-value pair.

LogAnalyticsResourceCategory

A resource and its category.

LogAnalyticsResourceCategoryCollection

A collection of resources and their category assignments.

LogAnalyticsResourceCategoryDetails

Details of resource category assignments.

LogAnalyticsSource

LogAnalyticsSource

LogAnalyticsSourceCollection

LogAnalyticsSourceCollection

LogAnalyticsSourceDataFilter

LogAnalyticsSourceDataFilter

LogAnalyticsSourceEntityType

LogAnalyticsSourceEntityType

LogAnalyticsSourceExtendedFieldDefinition

LogAnalyticsSourceExtendedFieldDefinition

LogAnalyticsSourceExtendedFieldDefinitionCollection

LogAnalyticsSourceExtendedFieldDefinitionCollection

LogAnalyticsSourceFunction

LogAnalyticsSourceFunction

LogAnalyticsSourceLabelCondition

LogAnalyticsSourceLabelCondition

LogAnalyticsSourceMetadataField

LogAnalyticsSourceMetadataField

LogAnalyticsSourceMetric

LogAnalyticsSourceMetric

LogAnalyticsSourcePattern

LogAnalyticsSourcePattern

LogAnalyticsSourcePatternCollection

LogAnalyticsSourcePatternCollection

LogAnalyticsSourceSummary

LogAnalyticsSourceSummary

LogAnalyticsTemplate

A template object.

LogAnalyticsTemplateCollection

A collection of template summary objects.

LogAnalyticsTemplateSummary

Summary of a template object.

LogAnalyticsWarning

LogAnalyticsWarning

LogAnalyticsWarningCollection

A collection of warnings.

LogEndpoint

An endpoint used to fetch logs.

LogGroupSummaryReport

A LogAnalytics Log Group summary report.

LogListEndpoint

An endpoint used to fetch a list of log URLs.

LogListTypeEndpoint

The LOG_LIST type endpoint configuration. The list of logs is first fetched using the listEndpoint configuration, and then the logs are subsequently fetched using the logEndpoints, which reference the list endpoint response. For time based incremental collection, specify the START_TIME macro with the desired time format, Example: {START_TIME:yyMMddHHmmssZ}.For offset based incremental collection, specify the START_OFFSET macro with offset identifier in the API response,

LogSetCollection

It contains a list of log sets

LogSetsCount

total number of log sets

LogTypeEndpoint

The LOG type endpoint configuration. Logs are fetched from the specified endpoint. For time based incremental collection, specify the START_TIME macro with the desired time format, Example: {START_TIME:yyMMddHHmmssZ}.For offset based incremental collection, specify the START_OFFSET macro with offset identifier in the API response,

LookupCommandDescriptor

Command descriptor for querylanguage LOOKUP command.

LookupField

LookupField

LookupSummaryReport

Summary report of lookups in the tenancy.

MacroCommandDescriptor

Command descriptor for querylanguage MACRO command.

MapCommandDescriptor

Command descriptor for querylanguage MAP command.

MatchInfo

MatchInfo

MetricExtraction

Specify metric extraction for SAVED_SEARCH scheduled task execution to post to OCI Monitoring.

ModuleCommandDescriptor

Command descriptor for querylanguage MODULE command.

MultiSearchCommandDescriptor

Command descriptor for querylanguage MULTISEARCH command.

NameValuePair

An object representing a name-value pair.

Namespace

This is the namespace details of a tenancy in Logging Analytics application

NamespaceCollection

This is a list of NamespaceSummary: there is at most one item in the list.

NamespaceSummary

The is the namespace summary of a tenancy in Logging Analytics application

NlpCommandDescriptor

Command descriptor for querylanguage NLP command.

OutlierCommandDescriptor

Command descriptor for querylanguage OUTLIER command.

OverlappingRecallCollection

This is the list of overlapping recall requests

OverlappingRecallSummary

This is the information about overlapping recall requests

ParseQueryDetails

Input information to submit parse query request.

ParseQueryOutput

Returns a parser agnostic breakdown of a query string for client query string introspection.

ParsedContent

Parsed representation of the log file.

ParsedField

Parsed field response.

ParserAction

A parser action. Typically refers to an operation to be performed while fetching or parsing the logs. Example: Unzip.

ParserActionSummary

A parser action summary object.

ParserActionSummaryCollection

A collection of parser action summary objects.

ParserSummaryReport

ParserSummaryReport

ParserTestResult

ParserTestResult

PatternOverride

Details of pattern level override for a property.

PropertyDefinition

Defines an property of a macro, variable or query.

PropertyMetadataSummary

Summary of property metadata details.

PropertyMetadataSummaryCollection

A collection of property metadata objects.

PropertyOverride

Property overrides at the scope of objects. For example, if you want to use logSourceName as 'xyz' for all objects that conatins string 'abc/' then define matchType as 'contains', matchValue as 'abc/', propertyName as 'logSourceName' and propertyValue as 'xyz'.

PurgeAction

Purge action for scheduled task.

PurgeStorageDataDetails

This is the input used to purge data

QueryAggregation

Query results.

QueryDetails

Input arguments for running a log anlaytics query. If the request is set to run in asynchronous mode then shouldIncludeColumns and shouldIncludeFields can be overwritten when retrieving the results.

QueryWorkRequest

Job details outlining parameters specified when job was submitted.

QueryWorkRequestCollection

Collection of query work requests.

QueryWorkRequestSummary

High level summary of query job work request.

RareCommandDescriptor

Command descriptor for querylanguage RARE command.

RecallArchivedDataDetails

This is the input used to recall archived data

RecallCount

This is the recall count statistics for a given tenant

RecallDefinition

Defines a recall in a query.

RecalledData

This is the information about recalled data

RecalledDataCollection

This is the list of recalled data

RecalledDataInfo

This is the synchronous result of a recall of archived data

RecalledDataSize

This is the recall related data size for the given timeframe

RecalledInfo

This is the information about data recalled

RecalledInfoCollection

This is the list of recalled data for log explorer

RegexCommandDescriptor

Command descriptor for querylanguage REGEX command.

RegexMatchResult

RegexMatchResult

ReleaseRecalledDataDetails

This is the input used to release recalled data

RemoveEntityAssociationsDetails

Information about the associations to be deleted between source entity and other existing destination entities.

RenameCommandDescriptor

Command descriptor for querylanguage RENAME command.

ResultColumn

Querylanguage result column.

Rule

A generic rule object - represents an ingest time rule or a scheduled task.

RuleSummary

A generic rule summary object - represents an ingest time rule or a scheduled task.

RuleSummaryCollection

A collection of Logging Analytics rules.

RuleSummaryReport

A summary count of detection rules.

Schedule

Schedule for scheduled task.

ScheduleModelConverter

ScheduledTask

Log analytics scheduled task resource.

ScheduledTaskCollection

Collection of scheduled tasks.

ScheduledTaskModelConverter

ScheduledTaskSummary

Summary information about a scheduled task.

SchedulerResource

Scheduler Resource authorization container for ScheduledTask resources

ScopeFilter

Scope filter to reduce the scope of the query.

SearchCommandDescriptor

Command descriptor for querylanguage SEARCH command.

SearchLookupCommandDescriptor

Command descriptor for querylanguage SEARCHLOOKUP command.

SequenceCommandDescriptor

Command descriptor for querylanguage SEQUENCE command.

SortCommandDescriptor

Command descriptor for querylanguage SORT command.

SortField

Field outlining queryString sort command fields and their corresponding sort order.

SourceMappingResponse

Response object containing match status and parsed representation of log data.

SourceSummaryReport

SourceSummaryReport

SourceValidateDetails

source validation details

SourceValidateResults

results of source validation

StandardTask

Log analytics scheduled task resource.

StatsCommandDescriptor

Command descriptor for querylanguage STATS command.

StatusSummary

StatusSummary

StepInfo

StepInfo

Storage

This is the storage configuration and status of a tenancy in Logging Analytics application

StorageUsage

This is the storage usage information of a tenancy in Logging Analytics application

StorageWorkRequest

This shows the storage work request details.

StorageWorkRequestCollection

This is a list of work request summaries.

StorageWorkRequestSummary

This is the summary of a storage work request.

StreamAction

Stream action for scheduled task.

Success

Success Information.

SuggestDetails

Typeahead input.

SuggestOutput

Typeahead results

TableColumn

Result column that contains a table within each row.

TailCommandDescriptor

Command descriptor for querylanguage TAIL command.

TemplateDetails

details for scheduled task using template

TemplateFacet

A facet of a template that may help in searching or filtering.

TemplateParams

Template key value params which can store template details like macro name and its parameter.

TestParserPayloadDetails

TestParserPayloadDetails

TimeClusterColumn

Column returned by querylanguage TIMECLUSTER command.

TimeClusterCommandDescriptor

Command descriptor for querylanguage TIMECLUSTER command.

TimeClusterDataColumn

A data series specific to a particular TIMECLUSTER output field.

TimeColumn

Time column returned when the shape of a queries results contsin a time series.

TimeCompareCommandDescriptor

Command descriptor for querylanguage TIMECOMPARE command.

TimeRange

Specify time range. This paramter can be overwritten if time criteria is specified in the query string. If no time criteria are found in query string this time range is used.

TimeStatsCluster

Object representing a timeseries cluster.

TimeStatsColumn

Column returned by querylanguage TIMESTATS command.

TimeStatsCommandDescriptor

Command descriptor for querylanguage TIMESTATS command.

TimeStatsDataColumn

A data series specific to a particular TIMESTATS output field.

TimezoneCollection

List of supported timezones.

TopCommandDescriptor

Command descriptor for querylanguage TOP command.

TrendColumn

Result column, that contains time series data points in each row. The column includes the time stamps as additional field in column header.

UiParserTestMetadata

UiParserTestMetadata

UnprocessedDataBucket

Configuration details of the bucket that stores unprocessed payloads.

UpdateLogAnalyticsEmBridgeDetails

Log analytics entity type definition to be updated.

UpdateLogAnalyticsEntityDetails

Details of log analytics entity to be updated.

UpdateLogAnalyticsEntityTypeDetails

Log analytics entity type definition to be updated.

UpdateLogAnalyticsLogGroupDetails

Information needed to update an existing log group.

UpdateLogAnalyticsObjectCollectionRuleDetails

Configuration of the collection rule to be updated.

UpdateLookupMetadataDetails

UpdateLookupMetadataDetails

UpdateScheduledTaskDetails

The details for updating a schedule task.

UpdateScheduledTaskDetailsModelConverter

UpdateStandardTaskDetails

The details for updating a schedule task.

UpdateStorageDetails

This is the input to update storage configuration of a tenancy in Logging Analytics application

UpdateTableCommandDescriptor

Command descriptor for querylanguage UPDATETABLE command.

Upload

Upload is a container that can be used to put all the relevant and related on-demand upload based log files together.

UploadCollection

Collection of UploadSummary objects.

UploadFileCollection

Collection of UploadFileSummary objects.

UploadFileStatus

Upload File Status

UploadFileSummary

Details of Upload File.

UploadSummary

Summary of the Upload.

UploadWarningCollection

Collection of UploadWarningSummary objects.

UploadWarningSummary

Summary of Upload warnings.

UpsertLogAnalyticsAssociation

UpsertLogAnalyticsAssociation

UpsertLogAnalyticsAssociationDetails

The required information to update or create a list of associations.

UpsertLogAnalyticsFieldDetails

Upsert LogAnalytics Field Details

UpsertLogAnalyticsLabelDetails

Upsert LogAnalytics Label Details

UpsertLogAnalyticsParserDetails

UpsertLogAnalyticsParserDetails

UpsertLogAnalyticsSourceDetails

UpsertLogAnalyticsSourceDetails

UsageStatusItem

UsageStatusItem

ValidateEndpointResult

The result of the endpoint configuration validation

ValidateLabelConditionDetails

Required information needed to evaluate a source label condition.

ValidateLabelConditionResult

The result of the label condition validation

VariableDefinition

Defines a variable used in a macro or the initization section of a query.

VerifyOutput

Verify acceleration output.

Violation

Violation

WarningReferenceDetails

A list of LogAnalyticsWarning references. Used as input to APIs which operate on a list. For example, the suppress warning API accepts a list of warning references and will suppress all warnings in the input list.

WhereCommandDescriptor

Command descriptor for querylanguage WHERE command.

WorkRequest

A description of workrequest status

WorkRequestCollection

Collection of control plane work requests.

WorkRequestError

An error encountered while executing a work request.

WorkRequestErrorCollection

This is a list of errors for the work request.

WorkRequestLog

This is a log message from the execution of a work request.

WorkRequestLogCollection

This is a list of logs for the work request.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestSummary

High level summary of control plane job work request.

XmlExtractCommandDescriptor

Command descriptor for querylanguage XMLEXTRACT command.

Enums

AbstractColumn.TypeEnum

AbstractCommandDescriptor.NameEnum

AbstractField.NameEnum

Action.TypeEnum

ActionTypes

Possible types of actions.

Argument.TypeEnum

AssociableEntity.EligibilityStatusEnum

ConditionBlock.ConditionBlocksOperatorEnum

ConfigLifecycleState

Lifecycle state. Supported states are ACTIVE, DELETED.

CreateScheduledTaskDetails.KindEnum

CreationSourceType

Entities are auto-created when enterprise manager bridge is configured in logging analytics, or when logs are forwarded from service connector or through bulk discovery from object store.

DependentParser.ParserTypeEnum

EmBridgeLatestImportProcessingStatus

Processing status of the latest upload from enterprise manager. Supported values are NOT_STARTED, SUCCESS, IN_PROGRESS, FAILED, PARTIAL_SUCCESS

EmBridgeLifecycleStates

Enterprise manager lifecycle state. Supported states are CREATING, ACTIVE, DELETED, NEEDS_ATTENTION

EncryptionKeySource

The source of encryption key.

EncryptionKeyType

The type of encrytion key.

EndpointCredentials.CredentialTypeEnum

EndpointProxy.CredentialTypeEnum

EndpointRequest.MethodEnum

EntityCloudType

Log analytics entity type group. This can be CLOUD (OCI) or NON_CLOUD otherwise.

EntityLifecycleStates

Log analytics entity lifecycle state. Supported states are ACTIVE, DELETED

ExportDetails.OutputFormatEnum

FieldsAddRemoveField.OperationEnum

Filter.OperatorEnum

GenericConditionBlock.ConditionBlocksOperatorEnum

GeoStatsCommandDescriptor.IncludeEnum

IngestTimeRuleAction.TypeEnum

IngestTimeRuleAdditionalFieldCondition.ConditionOperatorEnum

IngestTimeRuleCondition.KindEnum

IngestTimeRuleFieldCondition.FieldOperatorEnum

IngestTimeRuleSummary.ConditionKindEnum

JobMode

Job execution mode

JobModeFilter

Job execution mode

LabelPriority.PriorityEnum

LastExecutionStatus

Last execution status of a scheduled task

LifecycleStates

Possible lifecycle states.

LogAnalyticsAssociation.LifeCycleStateEnum

LogAnalyticsAssociationParameter.StatusEnum

LogAnalyticsConfigWorkRequest.LifecycleStateEnum

LogAnalyticsConfigWorkRequest.OperationTypeEnum

LogAnalyticsConfigWorkRequestSummary.LifecycleStateEnum

LogAnalyticsConfigWorkRequestSummary.OperationTypeEnum

LogAnalyticsEndpoint.EndpointTypeEnum

LogAnalyticsEntityType.ManagementAgentEligibilityStatusEnum

LogAnalyticsEntityTypeSummary.ManagementAgentEligibilityStatusEnum

LogAnalyticsLabel.PriorityEnum

LogAnalyticsLabel.TypeEnum

LogAnalyticsLabelAlias.PriorityEnum

LogAnalyticsLabelSummary.PriorityEnum

LogAnalyticsLabelSummary.TypeEnum

LogAnalyticsLabelView.PriorityEnum

LogAnalyticsLookup.TypeEnum

LogAnalyticsMetric.MetricTypeEnum

LogAnalyticsMetric.OperatorEnum

LogAnalyticsOperationTypes

Possible operation types.

LogAnalyticsParser.TypeEnum

LogAnalyticsParserSummary.TypeEnum

LogAnalyticsSourceDataFilter.FilterTypeEnum

LogAnalyticsSourceFunction.FunctionNameEnum

LogSetKeyTypes

Allowed values for logSetKey.

LogTypes

Allowed values for logType.

ObjectCollectionRuleCollectionTypes

The type of Object Collection Rule that needs to be performed with the rule being created. LIVE : Using this type will prompt the process to collect all the logs that gets uploaded to the object store bucket from the time the rule gets registered HISTORIC: This specifies that it is a one off collection request from one time (pollSince) to a second time period (pollTill). In this colletion the pollTill >pollSince HISTORIC_LIVE: This specifies that the collection of objects from the object store bucket needs to be started from a specific time stamp (pollSince) and should collect all the objects that ever gets into this bucket till this rule is configured and active.

ObjectCollectionRuleLifecycleStates

Possible object collection rule life cycle states.

OperationStatus

Possible operation status.

PayloadType

Possible payload types.

PropertyDefinition.TypeEnum

QueryOperationType

Asynchronous operation name for a work Request

RecallStatus

These are the possible statuses for recall

RecalledData.StatusEnum

Rule.LastExecutionStatusEnum

RuleKind

Logging Analytics rule kinds. Supported values are INGEST_TIME and SAVED_SEARCH.

RuleSummary.LastExecutionStatusEnum

Schedule.MisfirePolicyEnum

Schedule.TypeEnum

ScheduledTask.KindEnum

ScheduledTask.LifecycleStateEnum

ScheduledTask.PauseReasonEnum

ScheduledTask.TaskStatusEnum

ScheduledTaskSummary.LastExecutionStatusEnum

ScheduledTaskSummary.ScheduleTypeEnum

ScheduledTaskSummary.TaskStatusEnum

SortField.DirectionEnum

StandardTask.LastExecutionStatusEnum

StorageDataType

The storage data types.

StorageOperationType

These are the asynchronous operation name for a storage work Request

StreamCursorTypes

Allowed values for stream cursor types.

SubSystemName

Each subsystem has its own namespace for fields it contains. This means two fields in different subsystems can have the same name; for example, log.status and security.status refer to two different fields. The subsystem parameter identifies the default subsystem to use when validating/querying a field that is not explicitly qualified by its subsystem.

TaskType

Task type

TestParserPayloadDetails.TypeEnum

UpdateScheduledTaskDetails.KindEnum

UploadFileSummary.StatusEnum

UpsertLogAnalyticsLabelDetails.PriorityEnum

UpsertLogAnalyticsLabelDetails.TypeEnum

UpsertLogAnalyticsParserDetails.TypeEnum

ValueType

Data type for fields, columns or parameters.

VariableDefinition.TypeEnum

Violation.RuleTypeEnum

WorkRequestStatus

Status of query job work request.

In this article
Back to top