pub struct RuleService { /* private fields */ }Expand description
Implements a client for the Chronicle API.
§Example
let client = RuleService::builder().build().await?;
// use `client` to make requests to the Chronicle API.§Service Description
RuleService provides interface for user-created rules.
§Configuration
To configure RuleService use the with_* methods in the type returned
by builder(). The default configuration should
work for most applications. Common configuration changes include
- with_endpoint(): by default this client uses the global default endpoint
(
https://chronicle.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default. - with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.
§Pooling and Cloning
RuleService holds a connection pool internally, it is advised to
create one and the reuse it. You do not need to wrap RuleService in
an Rc or Arc to reuse it, because it
already uses an Arc internally.
Implementations§
Source§impl RuleService
impl RuleService
Sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Returns a builder for RuleService.
let client = RuleService::builder().build().await?;Sourcepub fn from_stub<T>(stub: T) -> Selfwhere
T: RuleService + 'static,
pub fn from_stub<T>(stub: T) -> Selfwhere
T: RuleService + 'static,
Creates a new client from the provided stub.
The most common case for calling this function is in tests mocking the client’s behavior.
Sourcepub fn create_rule(&self) -> CreateRule
pub fn create_rule(&self) -> CreateRule
Creates a new Rule.
Sourcepub fn list_rules(&self) -> ListRules
pub fn list_rules(&self) -> ListRules
Lists Rules.
Sourcepub fn update_rule(&self) -> UpdateRule
pub fn update_rule(&self) -> UpdateRule
Updates a Rule.
Sourcepub fn delete_rule(&self) -> DeleteRule
pub fn delete_rule(&self) -> DeleteRule
Deletes a Rule.
Sourcepub fn list_rule_revisions(&self) -> ListRuleRevisions
pub fn list_rule_revisions(&self) -> ListRuleRevisions
Lists all revisions of the rule.
Sourcepub fn create_retrohunt(&self) -> CreateRetrohunt
pub fn create_retrohunt(&self) -> CreateRetrohunt
Create a Retrohunt.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn get_retrohunt(&self) -> GetRetrohunt
pub fn get_retrohunt(&self) -> GetRetrohunt
Get a Retrohunt.
Sourcepub fn list_retrohunts(&self) -> ListRetrohunts
pub fn list_retrohunts(&self) -> ListRetrohunts
List Retrohunts.
Sourcepub fn get_rule_deployment(&self) -> GetRuleDeployment
pub fn get_rule_deployment(&self) -> GetRuleDeployment
Gets a RuleDeployment.
Sourcepub fn list_rule_deployments(&self) -> ListRuleDeployments
pub fn list_rule_deployments(&self) -> ListRuleDeployments
Lists RuleDeployments across all Rules.
Sourcepub fn update_rule_deployment(&self) -> UpdateRuleDeployment
pub fn update_rule_deployment(&self) -> UpdateRuleDeployment
Updates a RuleDeployment. Failures are not necessarily atomic. If there is a request to update multiple fields, and any update to a single field fails, an error will be returned, but other fields may remain successfully updated.
Sourcepub fn list_operations(&self) -> ListOperations
pub fn list_operations(&self) -> ListOperations
Provides the Operations service functionality in this service.
Sourcepub fn get_operation(&self) -> GetOperation
pub fn get_operation(&self) -> GetOperation
Provides the Operations service functionality in this service.
Sourcepub fn delete_operation(&self) -> DeleteOperation
pub fn delete_operation(&self) -> DeleteOperation
Provides the Operations service functionality in this service.
Sourcepub fn cancel_operation(&self) -> CancelOperation
pub fn cancel_operation(&self) -> CancelOperation
Provides the Operations service functionality in this service.
Trait Implementations§
Source§impl Clone for RuleService
impl Clone for RuleService
Source§fn clone(&self) -> RuleService
fn clone(&self) -> RuleService
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more