Package types (0.1.0)

API documentation for chronicle_v1.types package.

Classes

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.

CreateDataAccessLabelRequest

Request message for CreateDataAccessLabel.

CreateDataAccessScopeRequest

Request message for CreateDataAccessScope.

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.

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.

DeleteDataAccessLabelRequest

Request message to delete a data access label.

DeleteDataAccessScopeRequest

Request message to delete a data access scope.

DeleteRuleRequest

Request message for the DeleteRule method.

DeleteWatchlistRequest

Request message for deleting watchlist.

GetDataAccessLabelRequest

Request message to retrieve a data access label.

GetDataAccessScopeRequest

Request message to retrieve a data access scope.

GetInstanceRequest

Request to get a Instance.

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.

IngestionLabel

Representation of an ingestion label type.

InputsUsed

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

Instance

A Instance represents an instantiation of the Instance product.

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

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.

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.

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.

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.

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.

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.

Severity

Severity represents the severity level of the rule.

UpdateDataAccessLabelRequest

Request message for UpdateDataAccessLabel method.

UpdateDataAccessScopeRequest

Request message for UpdateDataAccessScope method.

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.

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.