Package Classes (0.1.0)

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

Classes

DataAccessControlServiceAsyncClient

DataAccessControlService exposes resources and endpoints related to data access control.

DataAccessControlServiceClient

DataAccessControlService exposes resources and endpoints related to data access control.

ListDataAccessLabelsAsyncPager

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.

ListDataAccessLabelsPager

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.

ListDataAccessScopesAsyncPager

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.

ListDataAccessScopesPager

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.

EntityServiceAsyncClient

EntityService contains apis for finding entities.

EntityServiceClient

EntityService contains apis for finding entities.

ListWatchlistsAsyncPager

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.

ListWatchlistsPager

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.

InstanceServiceAsyncClient

InstanceService provides the entry interface for the Chronicle API.

InstanceServiceClient

InstanceService provides the entry interface for the Chronicle API.

ReferenceListServiceAsyncClient

ReferenceListService provides an interface for managing reference lists.

ReferenceListServiceClient

ReferenceListService provides an interface for managing reference lists.

ListReferenceListsAsyncPager

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.

ListReferenceListsPager

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.

RuleServiceAsyncClient

RuleService provides interface for user-created rules.

RuleServiceClient

RuleService provides interface for user-created rules.

ListRetrohuntsAsyncPager

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.

ListRetrohuntsPager

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.

ListRuleDeploymentsAsyncPager

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.

ListRuleDeploymentsPager

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.

ListRuleRevisionsAsyncPager

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.

ListRuleRevisionsPager

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.

ListRulesAsyncPager

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.

ListRulesPager

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.

CompilationDiagnostic

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

Severity

The severity level of the compilation diagnostic.

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.

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 state of a Rule.

ExecutionState

The possible execution states the rule deployment can be in.

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.

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 UI configuration.

Modules

pagers

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

pagers

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

pagers

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

pagers

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