Chronicle v1 API - Class RuleService.RuleServiceBase (1.0.0-beta01)

[BindServiceMethod(typeof(RuleService), "BindService")]
public abstract class RuleService.RuleServiceBase

Reference documentation and code samples for the Chronicle v1 API class RuleService.RuleServiceBase.

Base class for server-side implementations of RuleService

Inheritance

object > RuleService.RuleServiceBase

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Methods

CreateRetrohunt(CreateRetrohuntRequest, ServerCallContext)

public virtual Task<Operation> CreateRetrohunt(CreateRetrohuntRequest request, ServerCallContext context)

Create a Retrohunt.

Parameters
Name Description
request CreateRetrohuntRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateRule(CreateRuleRequest, ServerCallContext)

public virtual Task<Rule> CreateRule(CreateRuleRequest request, ServerCallContext context)

Creates a new Rule.

Parameters
Name Description
request CreateRuleRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRule

The response to send back to the client (wrapped by a task).

DeleteRule(DeleteRuleRequest, ServerCallContext)

public virtual Task<Empty> DeleteRule(DeleteRuleRequest request, ServerCallContext context)

Deletes a Rule.

Parameters
Name Description
request DeleteRuleRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

GetRetrohunt(GetRetrohuntRequest, ServerCallContext)

public virtual Task<Retrohunt> GetRetrohunt(GetRetrohuntRequest request, ServerCallContext context)

Get a Retrohunt.

Parameters
Name Description
request GetRetrohuntRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRetrohunt

The response to send back to the client (wrapped by a task).

GetRule(GetRuleRequest, ServerCallContext)

public virtual Task<Rule> GetRule(GetRuleRequest request, ServerCallContext context)

Gets a Rule.

Parameters
Name Description
request GetRuleRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRule

The response to send back to the client (wrapped by a task).

GetRuleDeployment(GetRuleDeploymentRequest, ServerCallContext)

public virtual Task<RuleDeployment> GetRuleDeployment(GetRuleDeploymentRequest request, ServerCallContext context)

Gets a RuleDeployment.

Parameters
Name Description
request GetRuleDeploymentRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRuleDeployment

The response to send back to the client (wrapped by a task).

ListRetrohunts(ListRetrohuntsRequest, ServerCallContext)

public virtual Task<ListRetrohuntsResponse> ListRetrohunts(ListRetrohuntsRequest request, ServerCallContext context)

List Retrohunts.

Parameters
Name Description
request ListRetrohuntsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListRetrohuntsResponse

The response to send back to the client (wrapped by a task).

ListRuleDeployments(ListRuleDeploymentsRequest, ServerCallContext)

public virtual Task<ListRuleDeploymentsResponse> ListRuleDeployments(ListRuleDeploymentsRequest request, ServerCallContext context)

Lists RuleDeployments across all Rules.

Parameters
Name Description
request ListRuleDeploymentsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListRuleDeploymentsResponse

The response to send back to the client (wrapped by a task).

ListRuleRevisions(ListRuleRevisionsRequest, ServerCallContext)

public virtual Task<ListRuleRevisionsResponse> ListRuleRevisions(ListRuleRevisionsRequest request, ServerCallContext context)

Lists all revisions of the rule.

Parameters
Name Description
request ListRuleRevisionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListRuleRevisionsResponse

The response to send back to the client (wrapped by a task).

ListRules(ListRulesRequest, ServerCallContext)

public virtual Task<ListRulesResponse> ListRules(ListRulesRequest request, ServerCallContext context)

Lists Rules.

Parameters
Name Description
request ListRulesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListRulesResponse

The response to send back to the client (wrapped by a task).

UpdateRule(UpdateRuleRequest, ServerCallContext)

public virtual Task<Rule> UpdateRule(UpdateRuleRequest request, ServerCallContext context)

Updates a Rule.

Parameters
Name Description
request UpdateRuleRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRule

The response to send back to the client (wrapped by a task).

UpdateRuleDeployment(UpdateRuleDeploymentRequest, ServerCallContext)

public virtual Task<RuleDeployment> UpdateRuleDeployment(UpdateRuleDeploymentRequest request, ServerCallContext context)

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.

Parameters
Name Description
request UpdateRuleDeploymentRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRuleDeployment

The response to send back to the client (wrapped by a task).