@google-cloud/chronicle
Version:
Chronicle API client for Node.js
1,085 lines (1,084 loc) • 382 kB
JSON
{
"nested": {
"google": {
"nested": {
"cloud": {
"nested": {
"chronicle": {
"nested": {
"v1": {
"options": {
"csharp_namespace": "Google.Cloud.Chronicle.V1",
"go_package": "cloud.google.com/go/chronicle/apiv1/chroniclepb;chroniclepb",
"java_multiple_files": true,
"java_outer_classname": "RuleExecutionErrorProto",
"java_package": "com.google.cloud.chronicle.v1",
"php_namespace": "Google\\Cloud\\Chronicle\\V1",
"ruby_package": "Google::Cloud::Chronicle::V1",
"(google.api.resource_definition).type": "chronicle.googleapis.com/CuratedRule",
"(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}",
"(google.api.resource_definition).plural": "contentHub",
"(google.api.resource_definition).singular": "contentHub"
},
"nested": {
"BigQueryExportService": {
"options": {
"(google.api.default_host)": "chronicle.googleapis.com",
"(google.api.oauth_scopes)": "https://www.googleapis.com/auth/chronicle,https://www.googleapis.com/auth/chronicle.readonly,https://www.googleapis.com/auth/cloud-platform"
},
"methods": {
"GetBigQueryExport": {
"requestType": "GetBigQueryExportRequest",
"responseType": "BigQueryExport",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/instances/*/bigQueryExport}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/instances/*/bigQueryExport}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"UpdateBigQueryExport": {
"requestType": "UpdateBigQueryExportRequest",
"responseType": "BigQueryExport",
"options": {
"(google.api.http).patch": "/v1/{big_query_export.name=projects/*/locations/*/instances/*/bigQueryExport}",
"(google.api.http).body": "big_query_export",
"(google.api.method_signature)": "big_query_export,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v1/{big_query_export.name=projects/*/locations/*/instances/*/bigQueryExport}",
"body": "big_query_export"
}
},
{
"(google.api.method_signature)": "big_query_export,update_mask"
}
]
},
"ProvisionBigQueryExport": {
"requestType": "ProvisionBigQueryExportRequest",
"responseType": "BigQueryExport",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*/instances/*}/bigQueryExport:provision",
"(google.api.http).body": "*",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*/instances/*}/bigQueryExport:provision",
"body": "*"
}
},
{
"(google.api.method_signature)": "parent"
}
]
}
}
},
"BigQueryExportPackage": {
"values": {
"BIG_QUERY_EXPORT_PACKAGE_UNSPECIFIED": 0,
"BIG_QUERY_EXPORT_PACKAGE_BYOBQ": 1,
"BIG_QUERY_EXPORT_PACKAGE_ADVANCED": 2
}
},
"LatestExportJobState": {
"values": {
"LATEST_EXPORT_JOB_STATE_UNSPECIFIED": 0,
"LATEST_EXPORT_JOB_STATE_SUCCESS": 1,
"LATEST_EXPORT_JOB_STATE_FAILED": 2
}
},
"BigQueryExport": {
"options": {
"(google.api.resource).type": "chronicle.googleapis.com/BigQueryExport",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/instances/{instance}/bigQueryExport",
"(google.api.resource).plural": "bigQueryExport",
"(google.api.resource).singular": "bigQueryExport"
},
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "IDENTIFIER"
}
},
"provisioned": {
"type": "bool",
"id": 2,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"bigQueryExportPackage": {
"type": "BigQueryExportPackage",
"id": 3,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"entityGraphSettings": {
"type": "DataSourceExportSettings",
"id": 4,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"iocMatchesSettings": {
"type": "DataSourceExportSettings",
"id": 5,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"ruleDetectionsSettings": {
"type": "DataSourceExportSettings",
"id": 6,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"udmEventsAggregatesSettings": {
"type": "DataSourceExportSettings",
"id": 7,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"udmEventsSettings": {
"type": "DataSourceExportSettings",
"id": 8,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"DataSourceExportSettings": {
"fields": {
"enabled": {
"type": "bool",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"retentionDays": {
"type": "int32",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"latestExportJobState": {
"type": "LatestExportJobState",
"id": 3,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"dataFreshnessTime": {
"type": "google.protobuf.Timestamp",
"id": 4,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"dataVolume": {
"type": "int64",
"id": 5,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
}
},
"GetBigQueryExportRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "chronicle.googleapis.com/BigQueryExport"
}
}
}
},
"UpdateBigQueryExportRequest": {
"fields": {
"bigQueryExport": {
"type": "BigQueryExport",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"updateMask": {
"type": "google.protobuf.FieldMask",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ProvisionBigQueryExportRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "chronicle.googleapis.com/BigQueryExport"
}
}
}
},
"DashboardChartService": {
"options": {
"(google.api.default_host)": "chronicle.googleapis.com",
"(google.api.oauth_scopes)": "https://www.googleapis.com/auth/chronicle,https://www.googleapis.com/auth/chronicle.readonly,https://www.googleapis.com/auth/cloud-platform"
},
"methods": {
"GetDashboardChart": {
"requestType": "GetDashboardChartRequest",
"responseType": "DashboardChart",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/instances/*/dashboardCharts/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/instances/*/dashboardCharts/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"BatchGetDashboardCharts": {
"requestType": "BatchGetDashboardChartsRequest",
"responseType": "BatchGetDashboardChartsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*/instances/*}/dashboardCharts:batchGet",
"(google.api.method_signature)": "parent,names"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*/instances/*}/dashboardCharts:batchGet"
}
},
{
"(google.api.method_signature)": "parent,names"
}
]
}
}
},
"TileType": {
"values": {
"TILE_TYPE_UNSPECIFIED": 0,
"TILE_TYPE_VISUALIZATION": 1,
"TILE_TYPE_BUTTON": 2,
"TILE_TYPE_MARKDOWN": 3
}
},
"RenderType": {
"values": {
"RENDER_TYPE_UNSPECIFIED": 0,
"RENDER_TYPE_TEXT": 1,
"RENDER_TYPE_ICON": 2,
"RENDER_TYPE_ICON_AND_TEXT": 3
}
},
"AxisType": {
"values": {
"AXIS_TYPE_UNSPECIFIED": 0,
"VALUE": 1,
"CATEGORY": 2,
"TIME": 3,
"LOG": 4
}
},
"SeriesType": {
"values": {
"SERIES_TYPE_UNSPECIFIED": 0,
"LINE": 1,
"BAR": 2,
"PIE": 3,
"TEXT": 4,
"MAP": 5,
"GAUGE": 6,
"SCATTERPLOT": 7
}
},
"SeriesStackStrategy": {
"values": {
"SERIES_STACK_STRATEGY_UNSPECIFIED": 0,
"SAMESIGN": 1,
"ALL": 2,
"POSITIVE": 3,
"NEGATIVE": 4
}
},
"ToolTipTrigger": {
"values": {
"TOOLTIP_TRIGGER_UNSPECIFIED": 0,
"TOOLTIP_TRIGGER_NONE": 1,
"TOOLTIP_TRIGGER_ITEM": 2,
"TOOLTIP_TRIGGER_AXIS": 3
}
},
"LegendOrient": {
"values": {
"LEGEND_ORIENT_UNSPECIFIED": 0,
"VERTICAL": 1,
"HORIZONTAL": 2
}
},
"LegendAlign": {
"values": {
"LEGEND_ALIGN_UNSPECIFIED": 0,
"AUTO": 1,
"LEFT": 2,
"RIGHT": 3
}
},
"ButtonStyle": {
"values": {
"BUTTON_STYLE_UNSPECIFIED": 0,
"BUTTON_STYLE_FILLED": 1,
"BUTTON_STYLE_OUTLINED": 2,
"BUTTON_STYLE_TRANSPARENT": 3
}
},
"PlotMode": {
"values": {
"PLOT_MODE_UNSPECIFIED": 0,
"PLOT_MODE_POINTS": 1,
"PLOT_MODE_HEATMAP": 2,
"PLOT_MODE_BOTH": 3
}
},
"PointSizeType": {
"values": {
"POINT_SIZE_TYPE_UNSPECIFIED": 0,
"POINT_SIZE_TYPE_FIXED": 1,
"POINT_SIZE_TYPE_PROPORTIONAL_TO_SIZE": 2
}
},
"MetricFormat": {
"values": {
"METRIC_FORMAT_UNSPECIFIED": 0,
"METRIC_FORMAT_NUMBER": 1,
"METRIC_FORMAT_PLAIN_TEXT": 2
}
},
"MetricDisplayTrend": {
"values": {
"METRIC_DISPLAY_TREND_UNSPECIFIED": 0,
"METRIC_DISPLAY_TREND_ABSOLUTE_VALUE": 2,
"METRIC_DISPLAY_TREND_PERCENTAGE": 3,
"METRIC_DISPLAY_TREND_ABSOLUTE_VALUE_AND_PERCENTAGE": 4
}
},
"MetricTrendType": {
"values": {
"METRIC_TREND_TYPE_UNSPECIFIED": 0,
"METRIC_TREND_TYPE_REGULAR": 1,
"METRIC_TREND_TYPE_INVERSE": 2
}
},
"VisualMapType": {
"values": {
"VISUAL_MAP_TYPE_UNSPECIFIED": 0,
"CONTINUOUS": 1,
"PIECEWISE": 2
}
},
"DashboardChart": {
"options": {
"(google.api.resource).type": "chronicle.googleapis.com/DashboardChart",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}",
"(google.api.resource).plural": "dashboardCharts",
"(google.api.resource).singular": "dashboardChart"
},
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"(google.api.resource_reference).type": "chronicle.googleapis.com/DashboardChart"
}
},
"displayName": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"description": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"nativeDashboard": {
"type": "string",
"id": 4,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"(google.api.resource_reference).type": "chronicle.googleapis.com/NativeDashboard"
}
},
"tileType": {
"type": "TileType",
"id": 7,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"chartDatasource": {
"type": "ChartDatasource",
"id": 5,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"visualization": {
"type": "Visualization",
"id": 6,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"etag": {
"type": "string",
"id": 8,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"drillDownConfig": {
"type": "DrillDownConfig",
"id": 9,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"tokens": {
"rule": "repeated",
"type": "string",
"id": 10,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
},
"nested": {
"ChartDatasource": {
"fields": {
"dashboardQuery": {
"type": "string",
"id": 1,
"options": {
"(google.api.resource_reference).type": "chronicle.googleapis.com/DashboardQuery"
}
},
"dataSources": {
"rule": "repeated",
"type": "DataSource",
"id": 3
}
}
},
"Visualization": {
"fields": {
"xAxes": {
"rule": "repeated",
"type": "Axis",
"id": 7
},
"yAxes": {
"rule": "repeated",
"type": "Axis",
"id": 8
},
"series": {
"rule": "repeated",
"type": "Series",
"id": 3
},
"tooltip": {
"type": "Tooltip",
"id": 4
},
"legends": {
"rule": "repeated",
"type": "Legend",
"id": 9
},
"columnDefs": {
"rule": "repeated",
"type": "ColumnDef",
"id": 10
},
"tableConfig": {
"type": "TableConfig",
"id": 18,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"button": {
"type": "Button",
"id": 11
},
"markdown": {
"type": "Markdown",
"id": 17,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"seriesColumn": {
"rule": "repeated",
"type": "string",
"id": 12,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"groupingType": {
"type": "string",
"id": 13,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"googleMapsConfig": {
"type": "GoogleMapsConfig",
"id": 14,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"thresholdColoringEnabled": {
"type": "bool",
"id": 15,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"visualMaps": {
"rule": "repeated",
"type": "VisualMap",
"id": 16,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
},
"nested": {
"Axis": {
"oneofs": {
"_min": {
"oneof": [
"min"
]
},
"_max": {
"oneof": [
"max"
]
}
},
"fields": {
"axisType": {
"type": "AxisType",
"id": 4
},
"displayName": {
"type": "string",
"id": 5
},
"min": {
"type": "int32",
"id": 6,
"options": {
"proto3_optional": true
}
},
"max": {
"type": "int32",
"id": 7,
"options": {
"proto3_optional": true
}
}
}
},
"Series": {
"fields": {
"seriesType": {
"type": "SeriesType",
"id": 8
},
"seriesName": {
"type": "string",
"id": 2
},
"showSymbol": {
"type": "bool",
"id": 4
},
"showBackground": {
"type": "bool",
"id": 5
},
"stack": {
"type": "string",
"id": 6
},
"seriesStackStrategy": {
"type": "SeriesStackStrategy",
"id": 9
},
"encode": {
"type": "Encode",
"id": 10
},
"label": {
"type": "string",
"id": 11
},
"field": {
"type": "string",
"id": 12
},
"dataLabel": {
"type": "DataLabel",
"id": 13,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"radius": {
"rule": "repeated",
"type": "string",
"id": 14,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"itemStyle": {
"type": "ItemStyle",
"id": 15,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"seriesUniqueValue": {
"type": "string",
"id": 16,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"areaStyle": {
"type": "AreaStyle",
"id": 17,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"itemColors": {
"type": "ItemColors",
"id": 18,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"gaugeConfig": {
"type": "GaugeConfig",
"id": 19,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"metricTrendConfig": {
"type": "MetricTrendConfig",
"id": 20,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
},
"nested": {
"Encode": {
"fields": {
"x": {
"type": "string",
"id": 1
},
"y": {
"type": "string",
"id": 2
},
"value": {
"type": "string",
"id": 3
},
"itemName": {
"type": "string",
"id": 4
}
}
},
"DataLabel": {
"fields": {
"show": {
"type": "bool",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ItemStyle": {
"fields": {
"borderWidth": {
"type": "int32",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"borderColor": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"color": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"AreaStyle": {
"fields": {
"color": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"origin": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"shadowBlur": {
"type": "int32",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"shadowColor": {
"type": "string",
"id": 4,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"shadowOffsetX": {
"type": "int32",
"id": 5,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"shadowOffsetY": {
"type": "int32",
"id": 6,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"opacity": {
"type": "int32",
"id": 7,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"UserSelectedValues": {
"fields": {
"color": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"label": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ChartSliceColor": {
"fields": {
"key": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"value": {
"type": "UserSelectedValues",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ItemColors": {
"fields": {
"colors": {
"rule": "repeated",
"type": "ChartSliceColor",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"GaugeValue": {
"fields": {
"value": {
"type": "int32",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"color": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"GaugeConfig": {
"fields": {
"baseValue": {
"type": "GaugeValue",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"limitValue": {
"type": "GaugeValue",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"thresholdValues": {
"rule": "repeated",
"type": "GaugeValue",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"MetricTrendConfig": {
"fields": {
"metricFormat": {
"type": "MetricFormat",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"showMetricTrend": {
"type": "bool",
"id": 5,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"metricDisplayTrend": {
"type": "MetricDisplayTrend",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"metricTrendType": {
"type": "MetricTrendType",
"id": 4,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
}
}
},
"Tooltip": {
"fields": {
"show": {
"type": "bool",
"id": 1
},
"tooltipTrigger": {
"type": "ToolTipTrigger",
"id": 3
}
}
},
"Legend": {
"fields": {
"id": {
"type": "string",
"id": 1
},
"show": {
"type": "bool",
"id": 2
},
"zLevel": {
"type": "int32",
"id": 3
},
"z": {
"type": "int32",
"id": 4
},
"left": {
"type": "int32",
"id": 5
},
"top": {
"type": "int32",
"id": 6
},
"right": {
"type": "int32",
"id": 7
},
"bottom": {
"type": "int32",
"id": 8
},
"legendOrient": {
"type": "LegendOrient",
"id": 12
},
"legendAlign": {
"type": "LegendAlign",
"id": 13
},
"padding": {
"rule": "repeated",
"type": "int32",
"id": 11
}
}
},
"ColumnDef": {
"fields": {
"field": {
"type": "string",
"id": 1
},
"header": {
"type": "string",
"id": 2
}
}
},
"ColumnRenderTypeSettings": {
"fields": {
"field": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"columnRenderType": {
"type": "RenderType",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ColumnTooltipSettings": {
"fields": {
"field": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"headerTooltipText": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"cellTooltipText": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"