Package Classes (0.6.0)

Service for managing BigQuery export configurations for Chronicle instances.

Service for managing BigQuery export configurations for Chronicle instances.

A service providing functionality for managing dashboards' charts.

A service providing functionality for managing dashboards' charts.

A service providing functionality for managing dashboards' queries.

A service providing functionality for managing dashboards' queries.

DataAccessControlService exposes resources and endpoints related to data access control.

DataAccessControlService exposes resources and endpoints related to data access control.

A pager for iterating through list_data_access_labels requests.

This class thinly wraps an initial ListDataAccessLabelsResponse object, and provides an __aiter__ method to iterate through its data_access_labels field.

If there are more pages, the __aiter__ method will make additional ListDataAccessLabels requests and continue to iterate through the data_access_labels field on the corresponding responses.

All the usual ListDataAccessLabelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_data_access_labels requests.

This class thinly wraps an initial ListDataAccessLabelsResponse object, and provides an __iter__ method to iterate through its data_access_labels field.

If there are more pages, the __iter__ method will make additional ListDataAccessLabels requests and continue to iterate through the data_access_labels field on the corresponding responses.

All the usual ListDataAccessLabelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_data_access_scopes requests.

This class thinly wraps an initial ListDataAccessScopesResponse object, and provides an __aiter__ method to iterate through its data_access_scopes field.

If there are more pages, the __aiter__ method will make additional ListDataAccessScopes requests and continue to iterate through the data_access_scopes field on the corresponding responses.

All the usual ListDataAccessScopesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_data_access_scopes requests.

This class thinly wraps an initial ListDataAccessScopesResponse object, and provides an __iter__ method to iterate through its data_access_scopes field.

If there are more pages, the __iter__ method will make additional ListDataAccessScopes requests and continue to iterate through the data_access_scopes field on the corresponding responses.

All the usual ListDataAccessScopesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DataTableManager provides an interface for managing data tables.

DataTableManager provides an interface for managing data tables.

A pager for iterating through list_data_table_rows requests.

This class thinly wraps an initial ListDataTableRowsResponse object, and provides an __aiter__ method to iterate through its data_table_rows field.

If there are more pages, the __aiter__ method will make additional ListDataTableRows requests and continue to iterate through the data_table_rows field on the corresponding responses.

All the usual ListDataTableRowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_data_table_rows requests.

This class thinly wraps an initial ListDataTableRowsResponse object, and provides an __iter__ method to iterate through its data_table_rows field.

If there are more pages, the __iter__ method will make additional ListDataTableRows requests and continue to iterate through the data_table_rows field on the corresponding responses.

All the usual ListDataTableRowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_data_tables requests.

This class thinly wraps an initial ListDataTablesResponse object, and provides an __aiter__ method to iterate through its data_tables field.

If there are more pages, the __aiter__ method will make additional ListDataTables requests and continue to iterate through the data_tables field on the corresponding responses.

All the usual ListDataTablesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_data_tables requests.

This class thinly wraps an initial ListDataTablesResponse object, and provides an __iter__ method to iterate through its data_tables field.

If there are more pages, the __iter__ method will make additional ListDataTables requests and continue to iterate through the data_tables field on the corresponding responses.

All the usual ListDataTablesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

EntityService contains apis for finding entities.

EntityService contains apis for finding entities.

A pager for iterating through list_watchlists requests.

This class thinly wraps an initial ListWatchlistsResponse object, and provides an __aiter__ method to iterate through its watchlists field.

If there are more pages, the __aiter__ method will make additional ListWatchlists requests and continue to iterate through the watchlists field on the corresponding responses.

All the usual ListWatchlistsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_watchlists requests.

This class thinly wraps an initial ListWatchlistsResponse object, and provides an __iter__ method to iterate through its watchlists field.

If there are more pages, the __iter__ method will make additional ListWatchlists requests and continue to iterate through the watchlists field on the corresponding responses.

All the usual ListWatchlistsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service provides functionality for managing FeaturedContentNativeDashboard.

This service provides functionality for managing FeaturedContentNativeDashboard.

A pager for iterating through list_featured_content_native_dashboards requests.

This class thinly wraps an initial ListFeaturedContentNativeDashboardsResponse object, and provides an __aiter__ method to iterate through its featured_content_native_dashboards field.

If there are more pages, the __aiter__ method will make additional ListFeaturedContentNativeDashboards requests and continue to iterate through the featured_content_native_dashboards field on the corresponding responses.

All the usual ListFeaturedContentNativeDashboardsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_featured_content_native_dashboards requests.

This class thinly wraps an initial ListFeaturedContentNativeDashboardsResponse object, and provides an __iter__ method to iterate through its featured_content_native_dashboards field.

If there are more pages, the __iter__ method will make additional ListFeaturedContentNativeDashboards requests and continue to iterate through the featured_content_native_dashboards field on the corresponding responses.

All the usual ListFeaturedContentNativeDashboardsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

InstanceService provides the entry interface for the Chronicle API.

InstanceService provides the entry interface for the Chronicle API.

A service providing functionality for managing native dashboards.

A service providing functionality for managing native dashboards.

A pager for iterating through list_native_dashboards requests.

This class thinly wraps an initial ListNativeDashboardsResponse object, and provides an __aiter__ method to iterate through its native_dashboards field.

If there are more pages, the __aiter__ method will make additional ListNativeDashboards requests and continue to iterate through the native_dashboards field on the corresponding responses.

All the usual ListNativeDashboardsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_native_dashboards requests.

This class thinly wraps an initial ListNativeDashboardsResponse object, and provides an __iter__ method to iterate through its native_dashboards field.

If there are more pages, the __iter__ method will make additional ListNativeDashboards requests and continue to iterate through the native_dashboards field on the corresponding responses.

All the usual ListNativeDashboardsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ReferenceListService provides an interface for managing reference lists.

ReferenceListService provides an interface for managing reference lists.

A pager for iterating through list_reference_lists requests.

This class thinly wraps an initial ListReferenceListsResponse object, and provides an __aiter__ method to iterate through its reference_lists field.

If there are more pages, the __aiter__ method will make additional ListReferenceLists requests and continue to iterate through the reference_lists field on the corresponding responses.

All the usual ListReferenceListsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_reference_lists requests.

This class thinly wraps an initial ListReferenceListsResponse object, and provides an __iter__ method to iterate through its reference_lists field.

If there are more pages, the __iter__ method will make additional ListReferenceLists requests and continue to iterate through the reference_lists field on the corresponding responses.

All the usual ListReferenceListsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

RuleService provides interface for user-created rules.

RuleService provides interface for user-created rules.

A pager for iterating through list_retrohunts requests.

This class thinly wraps an initial ListRetrohuntsResponse object, and provides an __aiter__ method to iterate through its retrohunts field.

If there are more pages, the __aiter__ method will make additional ListRetrohunts requests and continue to iterate through the retrohunts field on the corresponding responses.

All the usual ListRetrohuntsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_retrohunts requests.

This class thinly wraps an initial ListRetrohuntsResponse object, and provides an __iter__ method to iterate through its retrohunts field.

If there are more pages, the __iter__ method will make additional ListRetrohunts requests and continue to iterate through the retrohunts field on the corresponding responses.

All the usual ListRetrohuntsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rule_deployments requests.

This class thinly wraps an initial ListRuleDeploymentsResponse object, and provides an __aiter__ method to iterate through its rule_deployments field.

If there are more pages, the __aiter__ method will make additional ListRuleDeployments requests and continue to iterate through the rule_deployments field on the corresponding responses.

All the usual ListRuleDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rule_deployments requests.

This class thinly wraps an initial ListRuleDeploymentsResponse object, and provides an __iter__ method to iterate through its rule_deployments field.

If there are more pages, the __iter__ method will make additional ListRuleDeployments requests and continue to iterate through the rule_deployments field on the corresponding responses.

All the usual ListRuleDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rule_revisions requests.

This class thinly wraps an initial ListRuleRevisionsResponse object, and provides an __aiter__ method to iterate through its rules field.

If there are more pages, the __aiter__ method will make additional ListRuleRevisions requests and continue to iterate through the rules field on the corresponding responses.

All the usual ListRuleRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rule_revisions requests.

This class thinly wraps an initial ListRuleRevisionsResponse object, and provides an __iter__ method to iterate through its rules field.

If there are more pages, the __iter__ method will make additional ListRuleRevisions requests and continue to iterate through the rules field on the corresponding responses.

All the usual ListRuleRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rules requests.

This class thinly wraps an initial ListRulesResponse object, and provides an __aiter__ method to iterate through its rules field.

If there are more pages, the __aiter__ method will make additional ListRules requests and continue to iterate through the rules field on the corresponding responses.

All the usual ListRulesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rules requests.

This class thinly wraps an initial ListRulesResponse object, and provides an __iter__ method to iterate through its rules field.

If there are more pages, the __iter__ method will make additional ListRules requests and continue to iterate through the rules field on the corresponding responses.

All the usual ListRulesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Request message to add chart in a dashboard.

Response message for adding chart in a dashboard.

Advanced filter configuration for the filter widget.

Manual options provided by the user.

Query options to fetch the values from the query engine. This is used for the filter's population query.

Source of the values for the filter.

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

Request message to get dashboard charts in batch.

Response message for getting dashboard charts in batch.

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.

The BigQueryExportPackage entitled for the Chronicle instance.

Request to create data table rows in bulk.

Response message with created data table rows.

Request to get data table rows in bulk.

Response message with data table rows.

Request to replace data table rows in bulk.

Response message with data table rows that replaced existing data table rows.

Request to update data table rows in bulk.

Response message with updated data table rows.

Button config for a chart.

Metadata of the column.

CompilationDiagnostic represents a compilation diagnostic generated during a rule's compilation, such as a compilation error or a compilation warning.

The severity level of the compilation diagnostic.

CompilationPosition represents the location of a compilation diagnostic in rule text.

Request message for CreateDataAccessLabel.

Request message for CreateDataAccessScope.

A request to create DataTable.

Request to create data table row.

Request message to create a dashboard.

A request to create a reference list.

Request message for CreateRetrohunt method.

Request message for CreateRule method.

Request message for creating watchlist.

AccessType of the dashboard.

DashboardChart resource.

Datasource of the chart including the query reference and source name.

Drill down configuration.

Drill down config.

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

Custom drill down settings.

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

Drill down external link config.

Drill down filter config.

Drill down dashboard filter config.

Drill down query config.

Default drill down settings.

Visualization config for a chart. https://echarts.apache.org/en/option.html#series

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Column Definition.

Column render type settings. This is used to determine the data render type of the column in the table.

Settings for tooltip for column header and cell.

Google Maps config for a chart if chart type is map.

Data settings for the map.

Map position settings for the map.

Point settings for the map.

Custom styling for area chart

Slice containing the key and value for a slice in the chart

Data label config for a series.

Field to be saved for retrieving value and color for gauge chart

Field to be saved for retrieving value and color for gauge chart

Field to be saved for retrieving slice colors for the chart

Custom styling for chart

Metric trend config for displaying trend value in Metrics chart

User selected color and label for the slice of the chart

Configuration for table appearance.

Conveys what range of values should be rendered in what color. This field is used when threshold_coloring_enabled is true.

An ECharts visual map of type 'piecewise' contain many pieces. Each piece has a min, max, and color with which it's rendered.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Definition of the dashboard including filters, layout, charts' configurations.

Configuration of the chart including chart reference, layout and filters.

Layout of the chart.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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 resource.

Input to the query like time window.

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

time representation for last x units.

Type of the dashboard.

User Data for Native Dashboard

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

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

A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.

LINT.IfChange(data_sources)

The export settings for a data source.

DataTable represents the data table resource.

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

DataTableColumnType denotes the type of the column to be referenced in the rule.

The message containing the errors for a data table operation.

DataTableRow represents a single row in a data table.

DataTableScopeInfo specifies the scope info of the data table.

DataTableUpdateSource denotes the source that updated the data table.

Request message to delete a data access label.

Request message to delete a data access scope.

Request message for deleting data tables.

Request to delete data table row.

Request message to delete a dashboard.

Request message for the DeleteRule method.

Request message for deleting watchlist.

Request message to duplicate chart in a dashboard.

Response message for duplicating chart in a dashboard.

Request message to duplicate a dashboard.

Request message to edit chart in a dashboard.

Response message for editing chart in a dashboard.

Request message to execute a dashboard query.

Response message for executing a dashboard query.

Singular vs list of values in a column.

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

Store list of values in a column.

LINT.IfChange(stats_data) Value of the column based on data type.

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

Request message to export list of dashboard.

Response message for exporting a dashboard.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FeaturedContentMetadata holds metadata about the Featured Content.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ContentSourceType specifying the content source of origin

FeaturedContentNativeDashboard resource.

The request message to fetch BigQuery Export configuration.

Request message to get a dashboard chart.

Request message to get a dashboard query.

Request message to retrieve a data access label.

Request message to retrieve a data access scope.

The request message for GetDataTableOperationErrors.

A request to get details about a data table.

Request to get data table row.

Request message to get a FeaturedContentNativeDashboard.

Request to get a Instance.

Request message to get a dashboard.

A request to get details about a reference list.

Request message for GetRetrohunt method.

Request message for GetRuleDeployment.

Request message for GetRule method.

Request message for getting a watchlist.

ImportExportStatus is a wrapper for dashboard name and status.

Inline source for importing dashboards.

Request message to import dashboards.

Response message for importing dashboards.

In app linking start

Representation of an ingestion label type.

InlineDestination for exporting a dashboard.

InputsUsed is a convenience field that tells us which sources of events (if any) were used in the rule. NEXT TAG: 4

Request message to install a FeaturedContentNativeDashboard.

Response message for installing a FeaturedContentNativeDashboard.

A Instance represents an instantiation of the Instance product.

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.

The state of the latest data source export job.

Request message for ListDataAccessLabels.

Response message for ListDataAccessLabels.

Request message for ListDataAccessScopes.

Response message for ListDataAccessScopes.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request to list data table rows.

Response message for listing data table rows.

A request for a list of data tables.

Response message for listing data tables.

Request message to list FeaturedContentNativeDashboards.

Response message for listing FeaturedContentNativeDashboards.

Request message to list dashboards.

Response message for listing dashboards.

A request for a list of reference lists.

A response to a request for a list of reference lists.

Request message for ListRetrohunts method.

Response message for ListRetrohunts method.

Request message for ListRuleDeployments.

Response message for ListRuleDeployments.

Request message for ListRuleRevisions method.

Response message for ListRuleRevisions method.

Request message for ListRules method.

Response message for ListRules method.

Request message for listing watchlists.

Response message for listing watchlists.

Markdown config for a dashboard tile.

Properties for the markdown.

Trend to be displayed for the metric charts as.

Metric format to be displayed for the metric charts.

Trend to be displayed for the metric charts as.

NativeDashboard resource.

NativeDashboardView indicates the scope of fields to populate when returning the dashboard resource.

NativeDashboardWithChartsAndQueries for exporting a dashboard.

Plot mode for the map.

Point size type for the map.

The request message to provision BigQuery Export configuration.

Runtime error for a dashboard query.

Based on ErrorSeverity, UI will choose to format the error differently.

Metadata enum to identify the metadata key.

Metadata for the error.

Warning reason.

A reference list. Reference lists are user-defined lists of values which users can use in multiple Rules.

An entry in a reference list.

ReferenceListScope specifies the list of scope names of the reference list.

The syntax type indicating how list entries should be validated.

ReferenceListView is a mechanism for viewing partial responses of the ReferenceList resource.

Request message to remove chart from a dashboard.

Render type of the data in the chart.

Retrohunt is an execution of a Rule over a time range in the past.

The possible states a retrohunt can be in.

Operation Metadata for Retrohunts.

The Rule resource represents a user-created rule. NEXT TAG: 21

The current compilation state of the rule.

The abstract base class for a message.

The RuleDeployment resource represents the deployment state of a Rule.

The possible execution states the rule deployment can be in.

RuleType indicates the YARA-L rule type of user-created and Google Cloud Threat Intelligence (GCTI) authored rules.

RuleView indicates the scope of fields to populate when returning the Rule resource.

RunFrequency indicates the run frequency at which a YARA-L 2 rule will run if enabled.

ScopeInfo specifies the scope info of the reference list.

Severity represents the severity level of the rule.

TileType indicates what type of chart tile it is i.e., visualization chart, button or text.

TimeUnit supported for PAST filter operator.

Metadata of the timestamp column.

The request message to update BigQuery Export configuration.

Request message for UpdateDataAccessLabel method.

Request message for UpdateDataAccessScope method.

A request to update details of data table.

Request to update data table row.

Request message to update a dashboard.

A request to update a reference list.

Request message for UpdateRuleDeployment.

Request message for UpdateRule method.

Request message for updating watchlist.

Visual map for various charts. More info:

https://echarts.apache.org/en/option.html#visualMap

A watchlist is a list of entities that allows for bulk operations over the included entities.

Count of different types of entities in the watchlist.

Mechanism to populate entities in the watchlist.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Entities are added manually.

A collection of user preferences for watchlist UI configuration.

API documentation for chronicle_v1.services.data_access_control_service.pagers module.

API documentation for chronicle_v1.services.data_table_service.pagers module.

API documentation for chronicle_v1.services.entity_service.pagers module.

API documentation for chronicle_v1.services.featured_content_native_dashboard_service.pagers module.

API documentation for chronicle_v1.services.native_dashboard_service.pagers module.

API documentation for chronicle_v1.services.reference_list_service.pagers module.

API documentation for chronicle_v1.services.rule_service.pagers module.