// This is an automatically generated code sample.
// To make this code sample work in your Oracle Cloud tenancy,
// please replace the values for any parameters whose current values do not fit
// your use case (such as resource IDs, strings containing ‘EXAMPLE’ or ‘unique_id’, and
// boolean, number, and enum parameters with values not fitting your use case).
import * as loganalytics from "oci-loganalytics";
import common = require("oci-common");
// Create a default authentication provider that uses the DEFAULT
// profile in the configuration file.
// Refer to <see href="https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File>the public documentation</see> on how to prepare a configuration file.
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider();
(async () => {
try {
// Create a service client
const client = new loganalytics.LogAnalyticsClient({ authenticationDetailsProvider: provider });
// Create a request and dependent object(s).
const logAnalyticsParser = {
content: "EXAMPLE-content-Value",
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 430,
encoding: "EXAMPLE-encoding-Value",
exampleContent: "EXAMPLE-exampleContent-Value",
fieldMaps: [
{
field: {
ceeAlias: "EXAMPLE-ceeAlias-Value",
dataType: "EXAMPLE-dataType-Value",
regularExpression: "EXAMPLE-regularExpression-Value",
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 849,
facetPriority: 690,
name: "EXAMPLE-name-Value",
isFacetEligible: false,
isHighCardinality: true,
isLargeData: true,
isMultiValued: true,
isPrimary: true,
isSystem: false,
isSummarizable: false,
mappedValue: "EXAMPLE-mappedValue-Value",
isMetricKeyEligible: true,
isMetricValueEligible: false,
rangeFacetEligible: 869,
isTableEligible: false,
unitType: "EXAMPLE-unitType-Value"
},
parserFieldId: 130,
parserFieldExpression: "EXAMPLE-parserFieldExpression-Value",
parserFieldName: "EXAMPLE-parserFieldName-Value",
storageFieldName: "EXAMPLE-storageFieldName-Value",
parserFieldIntegratorName: "EXAMPLE-parserFieldIntegratorName-Value",
parserName: "EXAMPLE-parserName-Value",
parserFieldSequence: 373,
structuredColumnInfo: "EXAMPLE-structuredColumnInfo-Value"
}
],
footerContent: "EXAMPLE-footerContent-Value",
headerContent: "EXAMPLE-headerContent-Value",
name: "EXAMPLE-name-Value",
isDefault: false,
isSingleLineContent: true,
isSystem: false,
language: "EXAMPLE-language-Value",
timeUpdated: new Date("Sun Mar 28 19:33:38 UTC 2027"),
logTypeTestRequestVersion: 380,
parserIgnorelineCharacters: "EXAMPLE-parserIgnorelineCharacters-Value",
isHidden: false,
parserSequence: 932,
parserTimezone: "EXAMPLE-parserTimezone-Value",
parserFilter: {
id: "ocid1.test.oc1..<unique_ID>EXAMPLE-id-Value",
agentVersion: "EXAMPLE-agentVersion-Value",
isInUse: 536,
operatingSystem: "EXAMPLE-operatingSystem-Value",
parserId: 994,
version: "EXAMPLE-version-Value"
},
isParserWrittenOnce: false,
parserFunctions: [
{
parserMetaPlugin: {
metaPluginParameters: [
{
description: "EXAMPLE-description-Value",
name: "EXAMPLE-name-Value",
isMandatory: false,
isRepeatable: false,
pluginName: "EXAMPLE-pluginName-Value",
type: "EXAMPLE-type-Value"
}
],
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
name: "EXAMPLE-name-Value"
},
parserFunctionId: 297,
parserFunctionName: "EXAMPLE-parserFunctionName-Value",
isEnabled: true,
isSystem: true,
parserId: 197,
parserName: "EXAMPLE-parserName-Value",
parserMetaPluginName: "EXAMPLE-parserMetaPluginName-Value",
parserFunctionPriority: 166,
parserFunctionParameters: [
{
parserFunctionId: 702,
parserFunctionParameterName: "EXAMPLE-parserFunctionParameterName-Value",
parserFunctionParameterId: 277,
parserMetaPluginParameterName: "EXAMPLE-parserMetaPluginParameterName-Value",
parserMetaPluginParameterValue: "EXAMPLE-parserMetaPluginParameterValue-Value",
parserName: "EXAMPLE-parserName-Value",
parserMetaPluginParameter: {
description: "EXAMPLE-description-Value",
name: "EXAMPLE-name-Value",
isMandatory: true,
isRepeatable: false,
pluginName: "EXAMPLE-pluginName-Value",
type: "EXAMPLE-type-Value"
}
}
]
}
],
sourcesCount: 996,
sources: [
{
labelConditions: [
{
conditionString: "EXAMPLE-conditionString-Value",
conditionBlock: {
conditionBlocksOperator:
loganalytics.models.ConditionBlock.ConditionBlocksOperator.And,
fieldName: "EXAMPLE-fieldName-Value",
labelConditionOperator: "EXAMPLE-labelConditionOperator-Value",
labelConditionValue: "EXAMPLE-labelConditionValue-Value",
labelConditionValues: ["EXAMPLE--Value"]
},
message: "EXAMPLE-message-Value",
isVisible: true,
blockConditionField: "EXAMPLE-blockConditionField-Value",
blockConditionOperator: "EXAMPLE-blockConditionOperator-Value",
blockConditionValue: "EXAMPLE-blockConditionValue-Value",
labelConditionValue: "EXAMPLE-labelConditionValue-Value",
labelConditionValues: ["EXAMPLE--Value"],
contentExample: "EXAMPLE-contentExample-Value",
isEnabled: true,
fieldName: "EXAMPLE-fieldName-Value",
labelConditionId: 344,
isSystem: false,
labelConditionOperator: "EXAMPLE-labelConditionOperator-Value",
sourceId: 502,
labelDisplayName: "EXAMPLE-labelDisplayName-Value",
storageField: "EXAMPLE-storageField-Value",
labelName: "EXAMPLE-labelName-Value",
isInlineLabelExistingInDatabase: false
}
],
associationCount: 806,
associationEntity: [
{
failureMessage: "EXAMPLE-failureMessage-Value",
agentId: "ocid1.test.oc1..<unique_ID>EXAMPLE-agentId-Value",
timeLastAttempted: new Date("Wed Jan 30 12:47:56 UTC 2002"),
retryCount: 249,
sourceName: "EXAMPLE-sourceName-Value",
sourceDisplayName: "EXAMPLE-sourceDisplayName-Value",
sourceTypeName: "EXAMPLE-sourceTypeName-Value",
lifeCycleState: loganalytics.models.LogAnalyticsAssociation.LifeCycleState.Failed,
entityId: "ocid1.test.oc1..<unique_ID>EXAMPLE-entityId-Value",
entityName: "EXAMPLE-entityName-Value",
entityTypeName: "EXAMPLE-entityTypeName-Value",
host: "EXAMPLE-host-Value",
agentEntityName: "EXAMPLE-agentEntityName-Value",
entityTypeDisplayName: "EXAMPLE-entityTypeDisplayName-Value",
logGroupId: "ocid1.test.oc1..<unique_ID>EXAMPLE-logGroupId-Value",
logGroupName: "EXAMPLE-logGroupName-Value",
logGroupCompartment: "EXAMPLE-logGroupCompartment-Value",
associationProperties: [
{
name: "EXAMPLE-name-Value",
value: "EXAMPLE-value-Value",
patterns: [
{
id: "ocid1.test.oc1..<unique_ID>EXAMPLE-id-Value",
value: "EXAMPLE-value-Value",
effectiveLevel: "EXAMPLE-effectiveLevel-Value"
}
]
}
]
}
],
dataFilterDefinitions: [
{
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 38,
isEnabled: true,
fieldName: "EXAMPLE-fieldName-Value",
hashType: 806,
dataFilterId: 64,
isSystem: false,
matchRegularExpression: "EXAMPLE-matchRegularExpression-Value",
order: 842,
path: "EXAMPLE-path-Value",
replacementString: "EXAMPLE-replacementString-Value",
sourceId: 791,
filterType: loganalytics.models.LogAnalyticsSourceDataFilter.FilterType.Mask
}
],
databaseCredential: "EXAMPLE-databaseCredential-Value",
extendedFieldDefinitions: [
{
field: {
ceeAlias: "EXAMPLE-ceeAlias-Value",
dataType: "EXAMPLE-dataType-Value",
regularExpression: "EXAMPLE-regularExpression-Value",
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 815,
facetPriority: 136,
name: "EXAMPLE-name-Value",
isFacetEligible: false,
isHighCardinality: true,
isLargeData: true,
isMultiValued: true,
isPrimary: false,
isSystem: false,
isSummarizable: false,
mappedValue: "EXAMPLE-mappedValue-Value",
isMetricKeyEligible: false,
isMetricValueEligible: false,
rangeFacetEligible: 513,
isTableEligible: false,
unitType: "EXAMPLE-unitType-Value"
},
displayRegularExpression: "EXAMPLE-displayRegularExpression-Value",
extendedFields: [
{
field: {
ceeAlias: "EXAMPLE-ceeAlias-Value",
dataType: "EXAMPLE-dataType-Value",
regularExpression: "EXAMPLE-regularExpression-Value",
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 256,
facetPriority: 84,
name: "EXAMPLE-name-Value",
isFacetEligible: false,
isHighCardinality: true,
isLargeData: true,
isMultiValued: false,
isPrimary: false,
isSystem: true,
isSummarizable: true,
mappedValue: "EXAMPLE-mappedValue-Value",
isMetricKeyEligible: false,
isMetricValueEligible: false,
rangeFacetEligible: 852,
isTableEligible: true,
unitType: "EXAMPLE-unitType-Value"
},
extendedFieldDefinitionId: 713,
fieldName: "EXAMPLE-fieldName-Value",
fieldDisplayName: "EXAMPLE-fieldDisplayName-Value",
savedRegularExpressionName: "EXAMPLE-savedRegularExpressionName-Value",
extendedFieldId: 422
}
],
baseFieldName: "EXAMPLE-baseFieldName-Value",
baseFieldLogText: "EXAMPLE-baseFieldLogText-Value",
conditionDataType: "EXAMPLE-conditionDataType-Value",
conditionField: "EXAMPLE-conditionField-Value",
conditionOperator: "EXAMPLE-conditionOperator-Value",
conditionValue: "EXAMPLE-conditionValue-Value",
convertedRegularExpression: "EXAMPLE-convertedRegularExpression-Value",
isEnabled: false,
extendedFieldDefinitionId: 661,
isSystem: false,
regularExpression: "EXAMPLE-regularExpression-Value",
sourceId: 81,
timeUpdated: new Date("Tue Feb 28 03:54:38 UTC 2023")
}
],
isForCloud: true,
labels: [
{
aliases: [
{
alias: "EXAMPLE-alias-Value",
aliasDisplayName: "EXAMPLE-aliasDisplayName-Value",
isSystem: true,
displayName: "EXAMPLE-displayName-Value",
name: "EXAMPLE-name-Value",
priority: loganalytics.models.LogAnalyticsLabelAlias.Priority.Medium
}
],
countUsageInAlertRule: 902,
countUsageInSource: 105,
id: "EXAMPLE-id-Value",
suggestType: 201,
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 318,
impact: "EXAMPLE-impact-Value",
isSystem: false,
name: "EXAMPLE-name-Value",
priority: loganalytics.models.LogAnalyticsLabelView.Priority.Medium,
recommendation: "EXAMPLE-recommendation-Value",
type: 99,
isUserDeleted: false
}
],
metricDefinitions: [
{
aggregationField: "EXAMPLE-aggregationField-Value",
bucketMetadata: "EXAMPLE-bucketMetadata-Value",
clockPeriod: "EXAMPLE-clockPeriod-Value",
description: "EXAMPLE-description-Value",
editVersion: 5,
fieldName: "EXAMPLE-fieldName-Value",
fieldValues: ["EXAMPLE--Value"],
groupingField: "EXAMPLE-groupingField-Value",
isEnabled: true,
isSystem: false,
displayName: "EXAMPLE-displayName-Value",
metricReference: 405,
name: "EXAMPLE-name-Value",
metricType: loganalytics.models.LogAnalyticsMetric.MetricType.Count,
isMetricSourceEnabled: true,
operator: loganalytics.models.LogAnalyticsMetric.Operator.InIgnoreCase,
entityType: "EXAMPLE-entityType-Value",
timeUpdated: new Date("Fri Nov 27 11:26:00 UTC 2020"),
unitType: "EXAMPLE-unitType-Value",
isUserCustomized: false
}
],
metrics: [
{
isMetricSourceEnabled: false,
metricName: "EXAMPLE-metricName-Value",
sourceName: "EXAMPLE-sourceName-Value",
entityType: "EXAMPLE-entityType-Value"
}
],
parameters: [
{
defaultValue: "EXAMPLE-defaultValue-Value",
description: "EXAMPLE-description-Value",
isActive: true,
name: "EXAMPLE-name-Value",
sourceId: 530
}
],
patternCount: 536,
patterns: [
{
convertedText: "EXAMPLE-convertedText-Value",
dbParserId: 615,
dbPatternDateTimeColumns: "EXAMPLE-dbPatternDateTimeColumns-Value",
dbPatternDateTimeField: "EXAMPLE-dbPatternDateTimeField-Value",
dbPatternSequenceColumn: "EXAMPLE-dbPatternSequenceColumn-Value",
fields: [
{
field: {
ceeAlias: "EXAMPLE-ceeAlias-Value",
dataType: "EXAMPLE-dataType-Value",
regularExpression: "EXAMPLE-regularExpression-Value",
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 979,
facetPriority: 247,
name: "EXAMPLE-name-Value",
isFacetEligible: false,
isHighCardinality: true,
isLargeData: true,
isMultiValued: false,
isPrimary: false,
isSystem: false,
isSummarizable: false,
mappedValue: "EXAMPLE-mappedValue-Value",
isMetricKeyEligible: false,
isMetricValueEligible: false,
rangeFacetEligible: 644,
isTableEligible: true,
unitType: "EXAMPLE-unitType-Value"
},
parserFieldId: 405,
parserFieldExpression: "EXAMPLE-parserFieldExpression-Value",
parserFieldName: "EXAMPLE-parserFieldName-Value",
storageFieldName: "EXAMPLE-storageFieldName-Value",
parserFieldIntegratorName: "EXAMPLE-parserFieldIntegratorName-Value",
parserName: "EXAMPLE-parserName-Value",
parserFieldSequence: 706,
structuredColumnInfo: "EXAMPLE-structuredColumnInfo-Value"
}
],
isInclude: true,
isDefault: true,
patternFilter: {
agentVersion: "EXAMPLE-agentVersion-Value",
isInUse: false,
operatingSystem: "EXAMPLE-operatingSystem-Value",
patternId: 2,
sourceId: 736,
version: "EXAMPLE-version-Value"
},
alias: "EXAMPLE-alias-Value",
description: "EXAMPLE-description-Value",
isEnabled: false,
patternId: 320,
isSystem: false,
sourceId: 849,
isAgentWarningSuppressed: true,
patternText: "EXAMPLE-patternText-Value",
patternType: 799,
entityType: ["EXAMPLE--Value"],
patternProperties: [
{
name: "EXAMPLE-name-Value",
value: "EXAMPLE-value-Value"
}
]
}
],
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
editVersion: 437,
functions: [
{
arguments: [
{
isOverrideOutputFields: true,
argumentDisplayName: "EXAMPLE-argumentDisplayName-Value",
argumentExample: "EXAMPLE-argumentExample-Value",
argumentService: "EXAMPLE-argumentService-Value",
argumentDataType: "EXAMPLE-argumentDataType-Value",
argumentDescription: "EXAMPLE-argumentDescription-Value",
argumentName: "EXAMPLE-argumentName-Value",
argumentOrder: 258,
argumentType: 118,
argumentId: 478,
argumentLookupColumn: "EXAMPLE-argumentLookupColumn-Value",
argumentLookupColumnPosition: 508,
argumentValue: "EXAMPLE-argumentValue-Value",
argumentReference: "EXAMPLE-argumentReference-Value"
}
],
isEnabled: true,
function: {
metaFunctionArgument: [
{
isOverrideOutputFields: false,
argumentDisplayName: "EXAMPLE-argumentDisplayName-Value",
argumentExample: "EXAMPLE-argumentExample-Value",
argumentService: "EXAMPLE-argumentService-Value",
argumentDataType: "EXAMPLE-argumentDataType-Value",
argumentDescription: "EXAMPLE-argumentDescription-Value",
argumentName: "EXAMPLE-argumentName-Value",
argumentOrder: 179,
argumentType: 182,
argumentId: 995,
argumentLookupColumn: "EXAMPLE-argumentLookupColumn-Value",
argumentLookupColumnPosition: 842,
argumentValue: "EXAMPLE-argumentValue-Value",
argumentReference: "EXAMPLE-argumentReference-Value"
}
],
component: "EXAMPLE-component-Value",
description: "EXAMPLE-description-Value",
editVersion: 373,
metaFunctionId: 912,
javaClassName: "EXAMPLE-javaClassName-Value",
name: "EXAMPLE-name-Value"
},
functionName: loganalytics.models.LogAnalyticsSourceFunction.FunctionName.Geolocation,
functionReference: "EXAMPLE-functionReference-Value",
sourceReference: "EXAMPLE-sourceReference-Value",
features: ["EXAMPLE--Value"],
functionId: 457,
order: 200,
isSystem: false,
lookupColumn: "EXAMPLE-lookupColumn-Value",
lookupColumnPosition: 183,
lookupDisplayName: "EXAMPLE-lookupDisplayName-Value",
lookupMode: 696,
lookupTable: "EXAMPLE-lookupTable-Value",
sourceId: 566
}
],
sourceId: 686,
name: "EXAMPLE-name-Value",
isSecureContent: false,
isSystem: true,
isAutoAssociationEnabled: false,
isAutoAssociationOverride: true,
ruleId: 405,
typeName: "EXAMPLE-typeName-Value",
typeDisplayName: "EXAMPLE-typeDisplayName-Value",
warningConfig: 676,
metadataFields: [
{
fieldName: "EXAMPLE-fieldName-Value",
isEnabled: true,
isSystem: true,
key: "EXAMPLE-key-Value",
sourceName: "EXAMPLE-sourceName-Value"
}
],
labelDefinitions: [
{
editVersion: 77,
isSystem: false,
sourceId: 648,
labelName: "EXAMPLE-labelName-Value"
}
],
entityTypes: [
{
sourceId: 960,
entityType: "EXAMPLE-entityType-Value",
entityTypeCategory: "EXAMPLE-entityTypeCategory-Value",
entityTypeDisplayName: "EXAMPLE-entityTypeDisplayName-Value"
}
],
isTimezoneOverride: false,
timeUpdated: new Date("Tue Nov 11 03:29:55 UTC 2003"),
eventTypes: [
{
eventTypeName: "EXAMPLE-eventTypeName-Value",
specVersion: "EXAMPLE-specVersion-Value",
isEnabled: true,
isSystem: true,
timeUpdated: new Date("Tue Apr 10 09:54:33 UTC 2007")
}
],
categories: [
{
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
type: "EXAMPLE-type-Value",
isSystem: false
}
],
endpoints: [
{
endpointType: "LOG",
logEndpoint: {
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value",
model: "EXAMPLE-model-Value",
endpointId: 572,
request: {
method: loganalytics.requests.EndpointRequest.Method.Post,
url: "EXAMPLE-url-Value",
contentType: "EXAMPLE-contentType-Value",
payload: "EXAMPLE-payload-Value",
headers: [
{
name: "EXAMPLE-name-Value",
value: "EXAMPLE-value-Value"
}
],
formParameters: [
{
name: "EXAMPLE-name-Value",
value: "EXAMPLE-value-Value"
}
]
},
response: {
contentType: "EXAMPLE-contentType-Value",
example: "EXAMPLE-example-Value"
},
credentials: {
credentialType: loganalytics.models.EndpointCredentials.CredentialType.BasicAuth,
credentialName: "EXAMPLE-credentialName-Value",
credentialEndpoint: {
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value",
model: "EXAMPLE-model-Value",
endpointId: 696,
response: {
contentType: "EXAMPLE-contentType-Value",
example: "EXAMPLE-example-Value"
},
proxy: {
url: "EXAMPLE-url-Value",
credentialName: "EXAMPLE-credentialName-Value",
credentialType: loganalytics.models.EndpointProxy.CredentialType.None
}
}
},
proxy: {
url: "EXAMPLE-url-Value",
credentialName: "EXAMPLE-credentialName-Value",
credentialType: loganalytics.models.EndpointProxy.CredentialType.Token
},
isEnabled: true,
isSystem: true,
endpointProperties: [
{
name: "EXAMPLE-name-Value",
value: "EXAMPLE-value-Value"
}
]
}
}
],
sourceProperties: [
{
name: "EXAMPLE-name-Value",
value: "EXAMPLE-value-Value"
}
]
}
],
shouldTokenizeOriginalText: true,
fieldDelimiter: "EXAMPLE-fieldDelimiter-Value",
fieldQualifier: "EXAMPLE-fieldQualifier-Value",
type: loganalytics.models.LogAnalyticsParser.Type.Xml,
isUserDeleted: false,
isNamespaceAware: false,
categories: [
{
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value",
displayName: "EXAMPLE-displayName-Value",
type: "EXAMPLE-type-Value",
isSystem: true
}
],
isPositionAware: false,
dependentSources: [
{
sourceName: "EXAMPLE-sourceName-Value",
sourceDisplayName: "EXAMPLE-sourceDisplayName-Value",
sourceId: 704,
sourceType: "EXAMPLE-sourceType-Value",
isSystem: true,
isAutoAssociationEnabled: true,
entityTypes: [
{
sourceId: 968,
entityType: "EXAMPLE-entityType-Value",
entityTypeCategory: "EXAMPLE-entityTypeCategory-Value",
entityTypeDisplayName: "EXAMPLE-entityTypeDisplayName-Value"
}
],
dependencies: [
{
type: "EXAMPLE-type-Value",
referenceType: "EXAMPLE-referenceType-Value",
referenceId: 494
}
]
}
],
dependentParsers: [
{
parserName: "EXAMPLE-parserName-Value",
parserDisplayName: "EXAMPLE-parserDisplayName-Value",
parserId: 284,
isSystem: false,
parserType: loganalytics.models.DependentParser.ParserType.Delimited,
dependencies: [
{
type: "EXAMPLE-type-Value",
referenceType: "EXAMPLE-referenceType-Value",
referenceId: 326
}
]
}
]
};
const extractStructuredLogHeaderPathsRequest: loganalytics.requests.ExtractStructuredLogHeaderPathsRequest = {
namespaceName: "EXAMPLE-namespaceName-Value",
loganParserDetails: logAnalyticsParser,
parserType: loganalytics.requests.ExtractStructuredLogHeaderPathsRequest.ParserType.Xml,
opcRetryToken: "EXAMPLE-opcRetryToken-Value",
opcRequestId: "SEJHHWQAMEMEML4HBSZ6<unique_ID>"
};
// Send request to the Client.
const extractStructuredLogHeaderPathsResponse = await client.extractStructuredLogHeaderPaths(
extractStructuredLogHeaderPathsRequest
);
} catch (error) {
console.log("extractStructuredLogHeaderPaths Failed with error " + error);
}
})();