API documentation for chronicle_v1.types package.
Classes
AddChartRequest
Request message to add chart in a dashboard.
AddChartResponse
Response message for adding chart in a dashboard.
AdvancedFilterConfig
Advanced filter configuration for the filter widget.
AxisType
BatchGetDashboardChartsRequest
Request message to get dashboard charts in batch.
BatchGetDashboardChartsResponse
Response message for getting dashboard charts in batch.
BigQueryExport
This resource represents the BigQuery export configuration for a Chronicle instance which includes Google Cloud Platform resources like Cloud Storage buckets, BigQuery datasets etc and the export settings for each data source.
BigQueryExportPackage
The BigQueryExportPackage entitled for the Chronicle instance.
BulkCreateDataTableRowsRequest
Request to create data table rows in bulk.
BulkCreateDataTableRowsResponse
Response message with created data table rows.
BulkGetDataTableRowsRequest
Request to get data table rows in bulk.
BulkGetDataTableRowsResponse
Response message with data table rows.
BulkReplaceDataTableRowsRequest
Request to replace data table rows in bulk.
BulkReplaceDataTableRowsResponse
Response message with data table rows that replaced existing data table rows.
BulkUpdateDataTableRowsRequest
Request to update data table rows in bulk.
BulkUpdateDataTableRowsResponse
Response message with updated data table rows.
Button
Button config for a chart.
ButtonStyle
ColumnMetadata
Metadata of the column.
CompilationDiagnostic
CompilationDiagnostic represents a compilation diagnostic generated during a rule's compilation, such as a compilation error or a compilation warning.
CompilationPosition
CompilationPosition represents the location of a compilation diagnostic in rule text.
ComputeAllFindingsRefinementActivitiesRequest
Request message for ComputeAllFindingsRefinementActivities method.
ComputeAllFindingsRefinementActivitiesResponse
Response message for ComputeAllFindingsRefinementActivities method.
ComputeFindingsRefinementActivityRequest
Request message for ComputeFindingsRefinementActivity method.
ComputeFindingsRefinementActivityResponse
Response message for ComputeFindingsRefinementActivity method.
CreateDataAccessLabelRequest
Request message for CreateDataAccessLabel.
CreateDataAccessScopeRequest
Request message for CreateDataAccessScope.
CreateDataTableRequest
A request to create DataTable.
CreateDataTableRowRequest
Request to create data table row.
CreateFindingsRefinementRequest
Request message for CreateFindingsRefinement method.
CreateNativeDashboardRequest
Request message to create a dashboard.
CreateReferenceListRequest
A request to create a reference list.
CreateRetrohuntRequest
Request message for CreateRetrohunt method.
CreateRuleRequest
Request message for CreateRule method.
CreateWatchlistRequest
Request message for creating watchlist.
DashboardAccess
AccessType of the dashboard.
DashboardChart
DashboardChart resource.
DashboardDefinition
Definition of the dashboard including filters, layout, charts' configurations.
DashboardFilter
Dashboard level filter that can be used in native dashboards as well as inputs to execute query.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DashboardQuery
DashboardQuery resource.
DashboardType
Type of the dashboard.
DashboardUserData
User Data for Native Dashboard
DataAccessLabel
A DataAccessLabel is a label on events to define user access to data.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataAccessLabelReference
Reference object to a data access label.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataAccessScope
A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.
DataSource
LINT.IfChange(data_sources)
DataSourceExportSettings
The export settings for a data source.
DataTable
DataTable represents the data table resource.
DataTableColumnInfo
DataTableColumnInfo represents the column metadata of the datatable. The column_index represents the ordering of the values in DataTableRow.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataTableOperationErrors
The message containing the errors for a data table operation.
DataTableRow
DataTableRow represents a single row in a data table.
DataTableScopeInfo
DataTableScopeInfo specifies the scope info of the data table.
DataTableUpdateSource
DataTableUpdateSource denotes the source that updated the data table.
DeleteDataAccessLabelRequest
Request message to delete a data access label.
DeleteDataAccessScopeRequest
Request message to delete a data access scope.
DeleteDataTableRequest
Request message for deleting data tables.
DeleteDataTableRowRequest
Request to delete data table row.
DeleteNativeDashboardRequest
Request message to delete a dashboard.
DeleteRuleRequest
Request message for the DeleteRule method.
DeleteWatchlistRequest
Request message for deleting watchlist.
DetectionExclusionActivity
The activity for a findings refinement that is a detection exclusion. The activity is broken down per detector.
DetectionExclusionApplication
Describes the detectors a detection exclusion is applied to.
DuplicateChartRequest
Request message to duplicate chart in a dashboard.
DuplicateChartResponse
Response message for duplicating chart in a dashboard.
DuplicateNativeDashboardRequest
Request message to duplicate a dashboard.
EditChartRequest
Request message to edit chart in a dashboard.
EditChartResponse
Response message for editing chart in a dashboard.
ExecuteDashboardQueryRequest
Request message to execute a dashboard query.
ExecuteDashboardQueryResponse
Response message for executing a dashboard query.
ExportNativeDashboardsRequest
Request message to export list of dashboard.
ExportNativeDashboardsResponse
Response message for exporting a dashboard.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FeaturedContentMetadata
FeaturedContentMetadata holds metadata about the Featured Content.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FeaturedContentNativeDashboard
FeaturedContentNativeDashboard resource.
FilterOperator
FilterOperatorAndValues
FindingsRefinement
Represents a set of logic conditions used to refine various types of findings such as curated rule detections.
FindingsRefinementActivity
The activity for a specific findings refinement.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FindingsRefinementDeployment
The FindingsRefinementDeployment resource represents the deployment state of a findings refinement.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FindingsRefinementType
The type of findings refinement, which determines what the findings refinement runs over and the mechanism by which it runs.
GetBigQueryExportRequest
The request message to fetch BigQuery Export configuration.
GetDashboardChartRequest
Request message to get a dashboard chart.
GetDashboardQueryRequest
Request message to get a dashboard query.
GetDataAccessLabelRequest
Request message to retrieve a data access label.
GetDataAccessScopeRequest
Request message to retrieve a data access scope.
GetDataTableOperationErrorsRequest
The request message for GetDataTableOperationErrors.
GetDataTableRequest
A request to get details about a data table.
GetDataTableRowRequest
Request to get data table row.
GetFeaturedContentNativeDashboardRequest
Request message to get a FeaturedContentNativeDashboard.
GetFindingsRefinementDeploymentRequest
Request message for GetFindingsRefinementDeployment method.
GetFindingsRefinementRequest
Request message for GetFindingsRefinement method.
GetInstanceRequest
Request to get a Instance.
GetNativeDashboardRequest
Request message to get a dashboard.
GetReferenceListRequest
A request to get details about a reference list.
GetRetrohuntRequest
Request message for GetRetrohunt method.
GetRuleDeploymentRequest
Request message for GetRuleDeployment.
GetRuleRequest
Request message for GetRule method.
GetWatchlistRequest
Request message for getting a watchlist.
ImportExportStatus
ImportExportStatus is a wrapper for dashboard name and status.
ImportNativeDashboardsInlineSource
Inline source for importing dashboards.
ImportNativeDashboardsRequest
Request message to import dashboards.
ImportNativeDashboardsResponse
Response message for importing dashboards.
InAppLink
In app linking start
IngestionLabel
Representation of an ingestion label type.
InlineDestination
InlineDestination for exporting a dashboard.
InputsUsed
InputsUsed is a convenience field that tells us which sources of events (if any) were used in the rule. NEXT TAG: 4
InstallFeaturedContentNativeDashboardRequest
Request message to install a FeaturedContentNativeDashboard.
InstallFeaturedContentNativeDashboardResponse
Response message for installing a FeaturedContentNativeDashboard.
Instance
A Instance represents an instantiation of the Instance product.
LanguageFeature
A language feature describes a specific capability or syntax of the
query language used in a dashboard query, such as JOINS,
STAGES, or DATA_TABLES.
LatestExportJobState
The state of the latest data source export job.
LegendAlign
LegendOrient
ListAllFindingsRefinementDeploymentsRequest
Request message for ListAllFindingsRefinementDeployments method.
ListAllFindingsRefinementDeploymentsResponse
Response message for ListAllFindingsRefinementDeployments method.
ListDataAccessLabelsRequest
Request message for ListDataAccessLabels.
ListDataAccessLabelsResponse
Response message for ListDataAccessLabels.
ListDataAccessScopesRequest
Request message for ListDataAccessScopes.
ListDataAccessScopesResponse
Response message for ListDataAccessScopes.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListDataTableRowsRequest
Request to list data table rows.
ListDataTableRowsResponse
Response message for listing data table rows.
ListDataTablesRequest
A request for a list of data tables.
ListDataTablesResponse
Response message for listing data tables.
ListFeaturedContentNativeDashboardsRequest
Request message to list FeaturedContentNativeDashboards.
ListFeaturedContentNativeDashboardsResponse
Response message for listing FeaturedContentNativeDashboards.
ListFindingsRefinementsRequest
Request message for ListFindingsRefinements method.
ListFindingsRefinementsResponse
Response message for ListFindingsRefinements method.
ListNativeDashboardsRequest
Request message to list dashboards.
ListNativeDashboardsResponse
Response message for listing dashboards.
ListReferenceListsRequest
A request for a list of reference lists.
ListReferenceListsResponse
A response to a request for a list of reference lists.
ListRetrohuntsRequest
Request message for ListRetrohunts method.
ListRetrohuntsResponse
Response message for ListRetrohunts method.
ListRuleDeploymentsRequest
Request message for ListRuleDeployments.
ListRuleDeploymentsResponse
Response message for ListRuleDeployments.
ListRuleExecutionErrorsRequest
Request message for ListRuleExecutionErrors.
ListRuleExecutionErrorsResponse
Response message for ListRuleExecutionErrors.
ListRuleRevisionsRequest
Request message for ListRuleRevisions method.
ListRuleRevisionsResponse
Response message for ListRuleRevisions method.
ListRulesRequest
Request message for ListRules method.
ListRulesResponse
Response message for ListRules method.
ListWatchlistsRequest
Request message for listing watchlists.
ListWatchlistsResponse
Response message for listing watchlists.
Markdown
Markdown config for a dashboard tile.
MetricDisplayTrend
Trend to be displayed for the metric charts as.
MetricFormat
Metric format to be displayed for the metric charts.
MetricTrendType
Trend to be displayed for the metric charts as.
NativeDashboard
NativeDashboard resource.
NativeDashboardView
NativeDashboardView indicates the scope of fields to populate when returning the dashboard resource.
NativeDashboardWithChartsAndQueries
NativeDashboardWithChartsAndQueries for exporting a dashboard.
OutcomeFilter
Outcome filter for the findings refinement. This is used to filter the findings refinement based on the outcome variable values.
PlotMode
Plot mode for the map.
PointSizeType
Point size type for the map.
ProvisionBigQueryExportRequest
The request message to provision BigQuery Export configuration.
QueryRuntimeError
Runtime error for a dashboard query.
ReferenceList
A reference list. Reference lists are user-defined lists of values which users can use in multiple Rules.
ReferenceListEntry
An entry in a reference list.
ReferenceListError
The error generated when verifying the reference list.
ReferenceListScope
ReferenceListScope specifies the list of scope names of the reference list.
ReferenceListSyntaxType
The syntax type indicating how list entries should be validated.
ReferenceListView
ReferenceListView is a mechanism for viewing partial responses of the ReferenceList resource.
RemoveChartRequest
Request message to remove chart from a dashboard.
RenderType
Render type of the data in the chart.
Retrohunt
Retrohunt is an execution of a Rule over a time range in the past.
RetrohuntMetadata
Operation Metadata for Retrohunts.
Rule
The Rule resource represents a user-created rule. NEXT TAG: 21
RuleDeployment
The RuleDeployment resource represents the deployment state of a Rule.
RuleExecutionError
The RuleExecutionError resource represents an error generated from running/deploying a rule.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RuleType
RuleType indicates the YARA-L rule type of user-created and Google Cloud Threat Intelligence (GCTI) authored rules.
RuleView
RuleView indicates the scope of fields to populate when returning the Rule resource.
RunFrequency
RunFrequency indicates the run frequency at which a YARA-L 2 rule will run if enabled.
ScopeInfo
ScopeInfo specifies the scope info of the reference list.
SeriesStackStrategy
SeriesType
Severity
Severity represents the severity level of the rule.
TileType
TileType indicates what type of chart tile it is i.e., visualization chart, button or text.
TimeUnit
TimeUnit supported for PAST filter operator.
TimestampMetadata
Metadata of the timestamp column.
ToolTipTrigger
UpdateBigQueryExportRequest
The request message to update BigQuery Export configuration.
UpdateDataAccessLabelRequest
Request message for UpdateDataAccessLabel method.
UpdateDataAccessScopeRequest
Request message for UpdateDataAccessScope method.
UpdateDataTableRequest
A request to update details of data table.
UpdateDataTableRowRequest
Request to update data table row.
UpdateFindingsRefinementDeploymentRequest
Request message for UpdateFindingsRefinementDeployment method.
UpdateFindingsRefinementRequest
Request message for UpdateFindingsRefinement method.
UpdateNativeDashboardRequest
Request message to update a dashboard.
UpdateReferenceListRequest
A request to update a reference list.
UpdateRuleDeploymentRequest
Request message for UpdateRuleDeployment.
UpdateRuleRequest
Request message for UpdateRule method.
UpdateWatchlistRequest
Request message for updating watchlist.
VerifyReferenceListRequest
VerifyReferenceList request message.
VerifyReferenceListResponse
VerifyListResponse response message.
VerifyRuleTextRequest
Request message for VerifyRuleText method.
VerifyRuleTextResponse
Response message for VerifyRuleText method.
VisualMapType
Visual map for various charts. More info:
Watchlist
A watchlist is a list of entities that allows for bulk operations over the included entities.
WatchlistUserPreferences
A collection of user preferences for watchlist UI configuration.