Package Classes (0.3.0)

Summary of entries of Classes for google-cloud-chronicle.

Classes

DataAccessControlServiceAsyncClient

DataAccessControlService exposes resources and endpointsrelated to data access control.

DataAccessControlServiceClient

DataAccessControlService exposes resources and endpointsrelated to data access control.

ListDataAccessLabelsAsyncPager

A pager for iterating throughlist_data_access_labels requests.

This class thinly wraps an initialListDataAccessLabelsResponse object, andprovides an__aiter__ method to iterate through itsdata_access_labels field.

If there are more pages, the__aiter__ method will make additionalListDataAccessLabels requests and continue to iteratethrough thedata_access_labels field on thecorresponding responses.

All the usualListDataAccessLabelsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListDataAccessLabelsPager

A pager for iterating throughlist_data_access_labels requests.

This class thinly wraps an initialListDataAccessLabelsResponse object, andprovides an__iter__ method to iterate through itsdata_access_labels field.

If there are more pages, the__iter__ method will make additionalListDataAccessLabels requests and continue to iteratethrough thedata_access_labels field on thecorresponding responses.

All the usualListDataAccessLabelsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListDataAccessScopesAsyncPager

A pager for iterating throughlist_data_access_scopes requests.

This class thinly wraps an initialListDataAccessScopesResponse object, andprovides an__aiter__ method to iterate through itsdata_access_scopes field.

If there are more pages, the__aiter__ method will make additionalListDataAccessScopes requests and continue to iteratethrough thedata_access_scopes field on thecorresponding responses.

All the usualListDataAccessScopesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListDataAccessScopesPager

A pager for iterating throughlist_data_access_scopes requests.

This class thinly wraps an initialListDataAccessScopesResponse object, andprovides an__iter__ method to iterate through itsdata_access_scopes field.

If there are more pages, the__iter__ method will make additionalListDataAccessScopes requests and continue to iteratethrough thedata_access_scopes field on thecorresponding responses.

All the usualListDataAccessScopesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

EntityServiceAsyncClient

EntityService contains apis for finding entities.

EntityServiceClient

EntityService contains apis for finding entities.

ListWatchlistsAsyncPager

A pager for iterating throughlist_watchlists requests.

This class thinly wraps an initialListWatchlistsResponse object, andprovides an__aiter__ method to iterate through itswatchlists field.

If there are more pages, the__aiter__ method will make additionalListWatchlists requests and continue to iteratethrough thewatchlists field on thecorresponding responses.

All the usualListWatchlistsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListWatchlistsPager

A pager for iterating throughlist_watchlists requests.

This class thinly wraps an initialListWatchlistsResponse object, andprovides an__iter__ method to iterate through itswatchlists field.

If there are more pages, the__iter__ method will make additionalListWatchlists requests and continue to iteratethrough thewatchlists field on thecorresponding responses.

All the usualListWatchlistsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

InstanceServiceAsyncClient

InstanceService provides the entry interface for theChronicle API.

InstanceServiceClient

InstanceService provides the entry interface for theChronicle API.

ReferenceListServiceAsyncClient

ReferenceListService provides an interface for managingreference lists.

ReferenceListServiceClient

ReferenceListService provides an interface for managingreference lists.

ListReferenceListsAsyncPager

A pager for iterating throughlist_reference_lists requests.

This class thinly wraps an initialListReferenceListsResponse object, andprovides an__aiter__ method to iterate through itsreference_lists field.

If there are more pages, the__aiter__ method will make additionalListReferenceLists requests and continue to iteratethrough thereference_lists field on thecorresponding responses.

All the usualListReferenceListsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListReferenceListsPager

A pager for iterating throughlist_reference_lists requests.

This class thinly wraps an initialListReferenceListsResponse object, andprovides an__iter__ method to iterate through itsreference_lists field.

If there are more pages, the__iter__ method will make additionalListReferenceLists requests and continue to iteratethrough thereference_lists field on thecorresponding responses.

All the usualListReferenceListsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

RuleServiceAsyncClient

RuleService provides interface for user-created rules.

RuleServiceClient

RuleService provides interface for user-created rules.

ListRetrohuntsAsyncPager

A pager for iterating throughlist_retrohunts requests.

This class thinly wraps an initialListRetrohuntsResponse object, andprovides an__aiter__ method to iterate through itsretrohunts field.

If there are more pages, the__aiter__ method will make additionalListRetrohunts requests and continue to iteratethrough theretrohunts field on thecorresponding responses.

All the usualListRetrohuntsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListRetrohuntsPager

A pager for iterating throughlist_retrohunts requests.

This class thinly wraps an initialListRetrohuntsResponse object, andprovides an__iter__ method to iterate through itsretrohunts field.

If there are more pages, the__iter__ method will make additionalListRetrohunts requests and continue to iteratethrough theretrohunts field on thecorresponding responses.

All the usualListRetrohuntsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListRuleDeploymentsAsyncPager

A pager for iterating throughlist_rule_deployments requests.

This class thinly wraps an initialListRuleDeploymentsResponse object, andprovides an__aiter__ method to iterate through itsrule_deployments field.

If there are more pages, the__aiter__ method will make additionalListRuleDeployments requests and continue to iteratethrough therule_deployments field on thecorresponding responses.

All the usualListRuleDeploymentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListRuleDeploymentsPager

A pager for iterating throughlist_rule_deployments requests.

This class thinly wraps an initialListRuleDeploymentsResponse object, andprovides an__iter__ method to iterate through itsrule_deployments field.

If there are more pages, the__iter__ method will make additionalListRuleDeployments requests and continue to iteratethrough therule_deployments field on thecorresponding responses.

All the usualListRuleDeploymentsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListRuleRevisionsAsyncPager

A pager for iterating throughlist_rule_revisions requests.

This class thinly wraps an initialListRuleRevisionsResponse object, andprovides an__aiter__ method to iterate through itsrules field.

If there are more pages, the__aiter__ method will make additionalListRuleRevisions requests and continue to iteratethrough therules field on thecorresponding responses.

All the usualListRuleRevisionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListRuleRevisionsPager

A pager for iterating throughlist_rule_revisions requests.

This class thinly wraps an initialListRuleRevisionsResponse object, andprovides an__iter__ method to iterate through itsrules field.

If there are more pages, the__iter__ method will make additionalListRuleRevisions requests and continue to iteratethrough therules field on thecorresponding responses.

All the usualListRuleRevisionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListRulesAsyncPager

A pager for iterating throughlist_rules requests.

This class thinly wraps an initialListRulesResponse object, andprovides an__aiter__ method to iterate through itsrules field.

If there are more pages, the__aiter__ method will make additionalListRules requests and continue to iteratethrough therules field on thecorresponding responses.

All the usualListRulesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListRulesPager

A pager for iterating throughlist_rules requests.

This class thinly wraps an initialListRulesResponse object, andprovides an__iter__ method to iterate through itsrules field.

If there are more pages, the__iter__ method will make additionalListRules requests and continue to iteratethrough therules field on thecorresponding responses.

All the usualListRulesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

CompilationDiagnostic

CompilationDiagnostic represents a compilation diagnosticgenerated during a rule's compilation, such as a compilationerror or a compilation warning.

Severity

The severity level of the compilation diagnostic.

CompilationPosition

CompilationPosition represents the location of a compilationdiagnostic 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 accessto 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 hasoneof_ 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 othermembers.

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

DataAccessScope

A DataAccessScope is a boolean expression of data accesslabels 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 sourcesof events (if any) were used in the rule.NEXT TAG: 4

Instance

A Instance represents an instantiation of the Instanceproduct.

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 canuse in multiple Rules.

ReferenceListEntry

An entry in a reference list.

ReferenceListScope

ReferenceListScope specifies the list of scope names of thereference list.

ReferenceListSyntaxType

The syntax type indicating how list entries should bevalidated.

ReferenceListView

ReferenceListView is a mechanism for viewing partialresponses of the ReferenceList resource.

Retrohunt

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

State

The possible states a retrohunt can be in.

RetrohuntMetadata

Operation Metadata for Retrohunts.

Rule

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

CompilationState

The current compilation state of the rule.

MetadataEntry

The abstract base class for a message.

RuleDeployment

The RuleDeployment resource represents the deployment stateof a Rule.

ExecutionState

The possible execution states the rule deployment can be in.

RuleType

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

RuleView

RuleView indicates the scope of fields to populate whenreturning the Rule resource.

RunFrequency

RunFrequency indicates the run frequency at which a YARA-L 2rule 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 bulkoperations over the included entities.

EntityCount

Count of different types of entities in the watchlist.

EntityPopulationMechanism

Mechanism to populate entities in the watchlist.

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

Manual

Entities are added manually.

WatchlistUserPreferences

A collection of user preferences for watchlist UIconfiguration.

Modules

pagers

API documentation forchronicle_v1.services.data_access_control_service.pagers module.

pagers

API documentation forchronicle_v1.services.entity_service.pagers module.

pagers

API documentation forchronicle_v1.services.reference_list_service.pagers module.

pagers

API documentation forchronicle_v1.services.rule_service.pagers module.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-10 UTC.