Class protos.google.cloud.chronicle.v1.RuleService (0.5.0)

Represents a RuleService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.chronicle.v1.RuleService

Package

@google-cloud/chronicle

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new RuleService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): RuleService;

Creates new RuleService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
RuleService	RPC service. Useful where requests and/or responses are streamed.

createRetrohunt(request, callback)

public createRetrohunt(request: google.cloud.chronicle.v1.ICreateRetrohuntRequest, callback: google.cloud.chronicle.v1.RuleService.CreateRetrohuntCallback): void;

Calls CreateRetrohunt.

Parameters
Name	Description
request	ICreateRetrohuntRequest CreateRetrohuntRequest message or plain object
callback	CreateRetrohuntCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createRetrohunt(request)

public createRetrohunt(request: google.cloud.chronicle.v1.ICreateRetrohuntRequest): Promise<google.longrunning.Operation>;

Calls CreateRetrohunt.

Parameter
Name	Description
request	ICreateRetrohuntRequest CreateRetrohuntRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createRule(request, callback)

public createRule(request: google.cloud.chronicle.v1.ICreateRuleRequest, callback: google.cloud.chronicle.v1.RuleService.CreateRuleCallback): void;

Calls CreateRule.

Parameters
Name	Description
request	ICreateRuleRequest CreateRuleRequest message or plain object
callback	CreateRuleCallback Node-style callback called with the error, if any, and Rule

Returns
Type	Description
void

createRule(request)

public createRule(request: google.cloud.chronicle.v1.ICreateRuleRequest): Promise<google.cloud.chronicle.v1.Rule>;

Calls CreateRule.

Parameter
Name	Description
request	ICreateRuleRequest CreateRuleRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.Rule>	Promise

deleteRule(request, callback)

public deleteRule(request: google.cloud.chronicle.v1.IDeleteRuleRequest, callback: google.cloud.chronicle.v1.RuleService.DeleteRuleCallback): void;

Calls DeleteRule.

Parameters
Name	Description
request	IDeleteRuleRequest DeleteRuleRequest message or plain object
callback	DeleteRuleCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteRule(request)

public deleteRule(request: google.cloud.chronicle.v1.IDeleteRuleRequest): Promise<google.protobuf.Empty>;

Calls DeleteRule.

Parameter
Name	Description
request	IDeleteRuleRequest DeleteRuleRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

getRetrohunt(request, callback)

public getRetrohunt(request: google.cloud.chronicle.v1.IGetRetrohuntRequest, callback: google.cloud.chronicle.v1.RuleService.GetRetrohuntCallback): void;

Calls GetRetrohunt.

Parameters
Name	Description
request	IGetRetrohuntRequest GetRetrohuntRequest message or plain object
callback	GetRetrohuntCallback Node-style callback called with the error, if any, and Retrohunt

Returns
Type	Description
void

getRetrohunt(request)

public getRetrohunt(request: google.cloud.chronicle.v1.IGetRetrohuntRequest): Promise<google.cloud.chronicle.v1.Retrohunt>;

Calls GetRetrohunt.

Parameter
Name	Description
request	IGetRetrohuntRequest GetRetrohuntRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.Retrohunt>	Promise

getRule(request, callback)

public getRule(request: google.cloud.chronicle.v1.IGetRuleRequest, callback: google.cloud.chronicle.v1.RuleService.GetRuleCallback): void;

Calls GetRule.

Parameters
Name	Description
request	IGetRuleRequest GetRuleRequest message or plain object
callback	GetRuleCallback Node-style callback called with the error, if any, and Rule

Returns
Type	Description
void

getRule(request)

public getRule(request: google.cloud.chronicle.v1.IGetRuleRequest): Promise<google.cloud.chronicle.v1.Rule>;

Calls GetRule.

Parameter
Name	Description
request	IGetRuleRequest GetRuleRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.Rule>	Promise

getRuleDeployment(request, callback)

public getRuleDeployment(request: google.cloud.chronicle.v1.IGetRuleDeploymentRequest, callback: google.cloud.chronicle.v1.RuleService.GetRuleDeploymentCallback): void;

Calls GetRuleDeployment.

Parameters
Name	Description
request	IGetRuleDeploymentRequest GetRuleDeploymentRequest message or plain object
callback	GetRuleDeploymentCallback Node-style callback called with the error, if any, and RuleDeployment

Returns
Type	Description
void

getRuleDeployment(request)

public getRuleDeployment(request: google.cloud.chronicle.v1.IGetRuleDeploymentRequest): Promise<google.cloud.chronicle.v1.RuleDeployment>;

Calls GetRuleDeployment.

Parameter
Name	Description
request	IGetRuleDeploymentRequest GetRuleDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.RuleDeployment>	Promise

listRetrohunts(request, callback)

public listRetrohunts(request: google.cloud.chronicle.v1.IListRetrohuntsRequest, callback: google.cloud.chronicle.v1.RuleService.ListRetrohuntsCallback): void;

Calls ListRetrohunts.

Parameters
Name	Description
request	IListRetrohuntsRequest ListRetrohuntsRequest message or plain object
callback	ListRetrohuntsCallback Node-style callback called with the error, if any, and ListRetrohuntsResponse

Returns
Type	Description
void

listRetrohunts(request)

public listRetrohunts(request: google.cloud.chronicle.v1.IListRetrohuntsRequest): Promise<google.cloud.chronicle.v1.ListRetrohuntsResponse>;

Calls ListRetrohunts.

Parameter
Name	Description
request	IListRetrohuntsRequest ListRetrohuntsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.ListRetrohuntsResponse>	Promise

listRuleDeployments(request, callback)

public listRuleDeployments(request: google.cloud.chronicle.v1.IListRuleDeploymentsRequest, callback: google.cloud.chronicle.v1.RuleService.ListRuleDeploymentsCallback): void;

Calls ListRuleDeployments.

Parameters
Name	Description
request	IListRuleDeploymentsRequest ListRuleDeploymentsRequest message or plain object
callback	ListRuleDeploymentsCallback Node-style callback called with the error, if any, and ListRuleDeploymentsResponse

Returns
Type	Description
void

listRuleDeployments(request)

public listRuleDeployments(request: google.cloud.chronicle.v1.IListRuleDeploymentsRequest): Promise<google.cloud.chronicle.v1.ListRuleDeploymentsResponse>;

Calls ListRuleDeployments.

Parameter
Name	Description
request	IListRuleDeploymentsRequest ListRuleDeploymentsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.ListRuleDeploymentsResponse>	Promise

listRuleRevisions(request, callback)

public listRuleRevisions(request: google.cloud.chronicle.v1.IListRuleRevisionsRequest, callback: google.cloud.chronicle.v1.RuleService.ListRuleRevisionsCallback): void;

Calls ListRuleRevisions.

Parameters
Name	Description
request	IListRuleRevisionsRequest ListRuleRevisionsRequest message or plain object
callback	ListRuleRevisionsCallback Node-style callback called with the error, if any, and ListRuleRevisionsResponse

Returns
Type	Description
void

listRuleRevisions(request)

public listRuleRevisions(request: google.cloud.chronicle.v1.IListRuleRevisionsRequest): Promise<google.cloud.chronicle.v1.ListRuleRevisionsResponse>;

Calls ListRuleRevisions.

Parameter
Name	Description
request	IListRuleRevisionsRequest ListRuleRevisionsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.ListRuleRevisionsResponse>	Promise

listRules(request, callback)

public listRules(request: google.cloud.chronicle.v1.IListRulesRequest, callback: google.cloud.chronicle.v1.RuleService.ListRulesCallback): void;

Calls ListRules.

Parameters
Name	Description
request	IListRulesRequest ListRulesRequest message or plain object
callback	ListRulesCallback Node-style callback called with the error, if any, and ListRulesResponse

Returns
Type	Description
void

listRules(request)

public listRules(request: google.cloud.chronicle.v1.IListRulesRequest): Promise<google.cloud.chronicle.v1.ListRulesResponse>;

Calls ListRules.

Parameter
Name	Description
request	IListRulesRequest ListRulesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.ListRulesResponse>	Promise

updateRule(request, callback)

public updateRule(request: google.cloud.chronicle.v1.IUpdateRuleRequest, callback: google.cloud.chronicle.v1.RuleService.UpdateRuleCallback): void;

Calls UpdateRule.

Parameters
Name	Description
request	IUpdateRuleRequest UpdateRuleRequest message or plain object
callback	UpdateRuleCallback Node-style callback called with the error, if any, and Rule

Returns
Type	Description
void

updateRule(request)

public updateRule(request: google.cloud.chronicle.v1.IUpdateRuleRequest): Promise<google.cloud.chronicle.v1.Rule>;

Calls UpdateRule.

Parameter
Name	Description
request	IUpdateRuleRequest UpdateRuleRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.Rule>	Promise

updateRuleDeployment(request, callback)

public updateRuleDeployment(request: google.cloud.chronicle.v1.IUpdateRuleDeploymentRequest, callback: google.cloud.chronicle.v1.RuleService.UpdateRuleDeploymentCallback): void;

Calls UpdateRuleDeployment.

Parameters
Name	Description
request	IUpdateRuleDeploymentRequest UpdateRuleDeploymentRequest message or plain object
callback	UpdateRuleDeploymentCallback Node-style callback called with the error, if any, and RuleDeployment

Returns
Type	Description
void

updateRuleDeployment(request)

public updateRuleDeployment(request: google.cloud.chronicle.v1.IUpdateRuleDeploymentRequest): Promise<google.cloud.chronicle.v1.RuleDeployment>;

Calls UpdateRuleDeployment.

Parameter
Name	Description
request	IUpdateRuleDeploymentRequest UpdateRuleDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.RuleDeployment>	Promise

verifyRuleText(request, callback)

public verifyRuleText(request: google.cloud.chronicle.v1.IVerifyRuleTextRequest, callback: google.cloud.chronicle.v1.RuleService.VerifyRuleTextCallback): void;

Calls VerifyRuleText.

Parameters
Name	Description
request	IVerifyRuleTextRequest VerifyRuleTextRequest message or plain object
callback	VerifyRuleTextCallback Node-style callback called with the error, if any, and VerifyRuleTextResponse

Returns
Type	Description
void

verifyRuleText(request)

public verifyRuleText(request: google.cloud.chronicle.v1.IVerifyRuleTextRequest): Promise<google.cloud.chronicle.v1.VerifyRuleTextResponse>;

Calls VerifyRuleText.

Parameter
Name	Description
request	IVerifyRuleTextRequest VerifyRuleTextRequest message or plain object

Returns
Type	Description
Promise<google.cloud.chronicle.v1.VerifyRuleTextResponse>	Promise