public sealed class RuleServiceClientImpl : RuleServiceClient
Reference documentation and code samples for the Chronicle v1 API class RuleServiceClientImpl.
RuleService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Chronicle.V1Assembly
Google.Cloud.Chronicle.V1.dll
Remarks
RuleService provides interface for user-created rules.
Constructors
RuleServiceClientImpl(RuleServiceClient, RuleServiceSettings, ILogger)
public RuleServiceClientImpl(RuleService.RuleServiceClient grpcClient, RuleServiceSettings settings, ILogger logger)
Constructs a client wrapper for the RuleService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient |
RuleServiceRuleServiceClient The underlying gRPC client. |
settings |
RuleServiceSettings The base RuleServiceSettings used within this client. |
logger |
ILogger Optional ILogger to use within this client. |
Properties
CreateRetrohuntOperationsClient
public override OperationsClient CreateRetrohuntOperationsClient { get; }
The long-running operations client for CreateRetrohunt
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override RuleService.RuleServiceClient GrpcClient { get; }
The underlying gRPC RuleService client
Property Value | |
---|---|
Type | Description |
RuleServiceRuleServiceClient |
Methods
CreateRetrohunt(CreateRetrohuntRequest, CallSettings)
public override Operation<Retrohunt, RetrohuntMetadata> CreateRetrohunt(CreateRetrohuntRequest request, CallSettings callSettings = null)
Create a Retrohunt.
Parameters | |
---|---|
Name | Description |
request |
CreateRetrohuntRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationRetrohuntRetrohuntMetadata |
The RPC response. |
CreateRetrohuntAsync(CreateRetrohuntRequest, CallSettings)
public override Task<Operation<Retrohunt, RetrohuntMetadata>> CreateRetrohuntAsync(CreateRetrohuntRequest request, CallSettings callSettings = null)
Create a Retrohunt.
Parameters | |
---|---|
Name | Description |
request |
CreateRetrohuntRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationRetrohuntRetrohuntMetadata |
A Task containing the RPC response. |
CreateRule(CreateRuleRequest, CallSettings)
public override Rule CreateRule(CreateRuleRequest request, CallSettings callSettings = null)
Creates a new Rule.
Parameters | |
---|---|
Name | Description |
request |
CreateRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Rule |
The RPC response. |
CreateRuleAsync(CreateRuleRequest, CallSettings)
public override Task<Rule> CreateRuleAsync(CreateRuleRequest request, CallSettings callSettings = null)
Creates a new Rule.
Parameters | |
---|---|
Name | Description |
request |
CreateRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskRule |
A Task containing the RPC response. |
DeleteRule(DeleteRuleRequest, CallSettings)
public override void DeleteRule(DeleteRuleRequest request, CallSettings callSettings = null)
Deletes a Rule.
Parameters | |
---|---|
Name | Description |
request |
DeleteRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
DeleteRuleAsync(DeleteRuleRequest, CallSettings)
public override Task DeleteRuleAsync(DeleteRuleRequest request, CallSettings callSettings = null)
Deletes a Rule.
Parameters | |
---|---|
Name | Description |
request |
DeleteRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
GetRetrohunt(GetRetrohuntRequest, CallSettings)
public override Retrohunt GetRetrohunt(GetRetrohuntRequest request, CallSettings callSettings = null)
Get a Retrohunt.
Parameters | |
---|---|
Name | Description |
request |
GetRetrohuntRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Retrohunt |
The RPC response. |
GetRetrohuntAsync(GetRetrohuntRequest, CallSettings)
public override Task<Retrohunt> GetRetrohuntAsync(GetRetrohuntRequest request, CallSettings callSettings = null)
Get a Retrohunt.
Parameters | |
---|---|
Name | Description |
request |
GetRetrohuntRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskRetrohunt |
A Task containing the RPC response. |
GetRule(GetRuleRequest, CallSettings)
public override Rule GetRule(GetRuleRequest request, CallSettings callSettings = null)
Gets a Rule.
Parameters | |
---|---|
Name | Description |
request |
GetRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Rule |
The RPC response. |
GetRuleAsync(GetRuleRequest, CallSettings)
public override Task<Rule> GetRuleAsync(GetRuleRequest request, CallSettings callSettings = null)
Gets a Rule.
Parameters | |
---|---|
Name | Description |
request |
GetRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskRule |
A Task containing the RPC response. |
GetRuleDeployment(GetRuleDeploymentRequest, CallSettings)
public override RuleDeployment GetRuleDeployment(GetRuleDeploymentRequest request, CallSettings callSettings = null)
Gets a RuleDeployment.
Parameters | |
---|---|
Name | Description |
request |
GetRuleDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
RuleDeployment |
The RPC response. |
GetRuleDeploymentAsync(GetRuleDeploymentRequest, CallSettings)
public override Task<RuleDeployment> GetRuleDeploymentAsync(GetRuleDeploymentRequest request, CallSettings callSettings = null)
Gets a RuleDeployment.
Parameters | |
---|---|
Name | Description |
request |
GetRuleDeploymentRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskRuleDeployment |
A Task containing the RPC response. |
ListRetrohunts(ListRetrohuntsRequest, CallSettings)
public override PagedEnumerable<ListRetrohuntsResponse, Retrohunt> ListRetrohunts(ListRetrohuntsRequest request, CallSettings callSettings = null)
List Retrohunts.
Parameters | |
---|---|
Name | Description |
request |
ListRetrohuntsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListRetrohuntsResponseRetrohunt |
A pageable sequence of Retrohunt resources. |
ListRetrohuntsAsync(ListRetrohuntsRequest, CallSettings)
public override PagedAsyncEnumerable<ListRetrohuntsResponse, Retrohunt> ListRetrohuntsAsync(ListRetrohuntsRequest request, CallSettings callSettings = null)
List Retrohunts.
Parameters | |
---|---|
Name | Description |
request |
ListRetrohuntsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListRetrohuntsResponseRetrohunt |
A pageable asynchronous sequence of Retrohunt resources. |
ListRuleDeployments(ListRuleDeploymentsRequest, CallSettings)
public override PagedEnumerable<ListRuleDeploymentsResponse, RuleDeployment> ListRuleDeployments(ListRuleDeploymentsRequest request, CallSettings callSettings = null)
Lists RuleDeployments across all Rules.
Parameters | |
---|---|
Name | Description |
request |
ListRuleDeploymentsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListRuleDeploymentsResponseRuleDeployment |
A pageable sequence of RuleDeployment resources. |
ListRuleDeploymentsAsync(ListRuleDeploymentsRequest, CallSettings)
public override PagedAsyncEnumerable<ListRuleDeploymentsResponse, RuleDeployment> ListRuleDeploymentsAsync(ListRuleDeploymentsRequest request, CallSettings callSettings = null)
Lists RuleDeployments across all Rules.
Parameters | |
---|---|
Name | Description |
request |
ListRuleDeploymentsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListRuleDeploymentsResponseRuleDeployment |
A pageable asynchronous sequence of RuleDeployment resources. |
ListRuleRevisions(ListRuleRevisionsRequest, CallSettings)
public override PagedEnumerable<ListRuleRevisionsResponse, Rule> ListRuleRevisions(ListRuleRevisionsRequest request, CallSettings callSettings = null)
Lists all revisions of the rule.
Parameters | |
---|---|
Name | Description |
request |
ListRuleRevisionsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListRuleRevisionsResponseRule |
A pageable sequence of Rule resources. |
ListRuleRevisionsAsync(ListRuleRevisionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListRuleRevisionsResponse, Rule> ListRuleRevisionsAsync(ListRuleRevisionsRequest request, CallSettings callSettings = null)
Lists all revisions of the rule.
Parameters | |
---|---|
Name | Description |
request |
ListRuleRevisionsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListRuleRevisionsResponseRule |
A pageable asynchronous sequence of Rule resources. |
ListRules(ListRulesRequest, CallSettings)
public override PagedEnumerable<ListRulesResponse, Rule> ListRules(ListRulesRequest request, CallSettings callSettings = null)
Lists Rules.
Parameters | |
---|---|
Name | Description |
request |
ListRulesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListRulesResponseRule |
A pageable sequence of Rule resources. |
ListRulesAsync(ListRulesRequest, CallSettings)
public override PagedAsyncEnumerable<ListRulesResponse, Rule> ListRulesAsync(ListRulesRequest request, CallSettings callSettings = null)
Lists Rules.
Parameters | |
---|---|
Name | Description |
request |
ListRulesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListRulesResponseRule |
A pageable asynchronous sequence of Rule resources. |
UpdateRule(UpdateRuleRequest, CallSettings)
public override Rule UpdateRule(UpdateRuleRequest request, CallSettings callSettings = null)
Updates a Rule.
Parameters | |
---|---|
Name | Description |
request |
UpdateRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Rule |
The RPC response. |
UpdateRuleAsync(UpdateRuleRequest, CallSettings)
public override Task<Rule> UpdateRuleAsync(UpdateRuleRequest request, CallSettings callSettings = null)
Updates a Rule.
Parameters | |
---|---|
Name | Description |
request |
UpdateRuleRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskRule |
A Task containing the RPC response. |
UpdateRuleDeployment(UpdateRuleDeploymentRequest, CallSettings)
public override RuleDeployment UpdateRuleDeployment(UpdateRuleDeploymentRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
RuleDeployment |
The RPC response. |
UpdateRuleDeploymentAsync(UpdateRuleDeploymentRequest, CallSettings)
public override Task<RuleDeployment> UpdateRuleDeploymentAsync(UpdateRuleDeploymentRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskRuleDeployment |
A Task containing the RPC response. |