Chronicle v1 API - Class RuleServiceClient (1.0.0-beta02)

public abstract class RuleServiceClient

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

RuleService client wrapper, for convenient use.

Inheritance

object > RuleServiceClient

Derived Types

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Remarks

RuleService provides interface for user-created rules.

Properties

CreateRetrohuntOperationsClient

public virtual OperationsClient CreateRetrohuntOperationsClient { get; }

The long-running operations client for CreateRetrohunt.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the RuleService service, which is a host of "chronicle.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default RuleService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default RuleService scopes are:

GrpcClient

public virtual RuleService.RuleServiceClient GrpcClient { get; }

The underlying gRPC RuleService client

Property Value
Type Description
RuleServiceRuleServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static RuleServiceClient Create()

Synchronously creates a RuleServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use RuleServiceClientBuilder.

Returns
Type Description
RuleServiceClient

The created RuleServiceClient.

CreateAsync(CancellationToken)

public static Task<RuleServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a RuleServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use RuleServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskRuleServiceClient

The task representing the created RuleServiceClient.

CreateRetrohunt(CreateRetrohuntRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
CreateRetrohuntRequest request = new CreateRetrohuntRequest
{
    ParentAsRuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Retrohunt = new Retrohunt(),
};
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = ruleServiceClient.CreateRetrohunt(request);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = ruleServiceClient.PollOnceCreateRetrohunt(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohunt(RuleName, Retrohunt, CallSettings)

public virtual Operation<Retrohunt, RetrohuntMetadata> CreateRetrohunt(RuleName parent, Retrohunt retrohunt, CallSettings callSettings = null)

Create a Retrohunt.

Parameters
Name Description
parent RuleName

Required. The parent of retrohunt, which is a rule. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

retrohunt Retrohunt

Required. The retrohunt to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRetrohuntRetrohuntMetadata

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleName parent = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
Retrohunt retrohunt = new Retrohunt();
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = ruleServiceClient.CreateRetrohunt(parent, retrohunt);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = ruleServiceClient.PollOnceCreateRetrohunt(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohunt(string, Retrohunt, CallSettings)

public virtual Operation<Retrohunt, RetrohuntMetadata> CreateRetrohunt(string parent, Retrohunt retrohunt, CallSettings callSettings = null)

Create a Retrohunt.

Parameters
Name Description
parent string

Required. The parent of retrohunt, which is a rule. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

retrohunt Retrohunt

Required. The retrohunt to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRetrohuntRetrohuntMetadata

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
Retrohunt retrohunt = new Retrohunt();
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = ruleServiceClient.CreateRetrohunt(parent, retrohunt);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = ruleServiceClient.PollOnceCreateRetrohunt(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohuntAsync(CreateRetrohuntRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
CreateRetrohuntRequest request = new CreateRetrohuntRequest
{
    ParentAsRuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Retrohunt = new Retrohunt(),
};
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = await ruleServiceClient.CreateRetrohuntAsync(request);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = await ruleServiceClient.PollOnceCreateRetrohuntAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohuntAsync(CreateRetrohuntRequest, CancellationToken)

public virtual Task<Operation<Retrohunt, RetrohuntMetadata>> CreateRetrohuntAsync(CreateRetrohuntRequest request, CancellationToken cancellationToken)

Create a Retrohunt.

Parameters
Name Description
request CreateRetrohuntRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRetrohuntRetrohuntMetadata

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
CreateRetrohuntRequest request = new CreateRetrohuntRequest
{
    ParentAsRuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Retrohunt = new Retrohunt(),
};
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = await ruleServiceClient.CreateRetrohuntAsync(request);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = await ruleServiceClient.PollOnceCreateRetrohuntAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohuntAsync(RuleName, Retrohunt, CallSettings)

public virtual Task<Operation<Retrohunt, RetrohuntMetadata>> CreateRetrohuntAsync(RuleName parent, Retrohunt retrohunt, CallSettings callSettings = null)

Create a Retrohunt.

Parameters
Name Description
parent RuleName

Required. The parent of retrohunt, which is a rule. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

retrohunt Retrohunt

Required. The retrohunt to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRetrohuntRetrohuntMetadata

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName parent = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
Retrohunt retrohunt = new Retrohunt();
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = await ruleServiceClient.CreateRetrohuntAsync(parent, retrohunt);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = await ruleServiceClient.PollOnceCreateRetrohuntAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohuntAsync(RuleName, Retrohunt, CancellationToken)

public virtual Task<Operation<Retrohunt, RetrohuntMetadata>> CreateRetrohuntAsync(RuleName parent, Retrohunt retrohunt, CancellationToken cancellationToken)

Create a Retrohunt.

Parameters
Name Description
parent RuleName

Required. The parent of retrohunt, which is a rule. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

retrohunt Retrohunt

Required. The retrohunt to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRetrohuntRetrohuntMetadata

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName parent = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
Retrohunt retrohunt = new Retrohunt();
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = await ruleServiceClient.CreateRetrohuntAsync(parent, retrohunt);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = await ruleServiceClient.PollOnceCreateRetrohuntAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohuntAsync(string, Retrohunt, CallSettings)

public virtual Task<Operation<Retrohunt, RetrohuntMetadata>> CreateRetrohuntAsync(string parent, Retrohunt retrohunt, CallSettings callSettings = null)

Create a Retrohunt.

Parameters
Name Description
parent string

Required. The parent of retrohunt, which is a rule. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

retrohunt Retrohunt

Required. The retrohunt to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRetrohuntRetrohuntMetadata

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
Retrohunt retrohunt = new Retrohunt();
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = await ruleServiceClient.CreateRetrohuntAsync(parent, retrohunt);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = await ruleServiceClient.PollOnceCreateRetrohuntAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRetrohuntAsync(string, Retrohunt, CancellationToken)

public virtual Task<Operation<Retrohunt, RetrohuntMetadata>> CreateRetrohuntAsync(string parent, Retrohunt retrohunt, CancellationToken cancellationToken)

Create a Retrohunt.

Parameters
Name Description
parent string

Required. The parent of retrohunt, which is a rule. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

retrohunt Retrohunt

Required. The retrohunt to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRetrohuntRetrohuntMetadata

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
Retrohunt retrohunt = new Retrohunt();
// Make the request
Operation<Retrohunt, RetrohuntMetadata> response = await ruleServiceClient.CreateRetrohuntAsync(parent, retrohunt);

// Poll until the returned long-running operation is complete
Operation<Retrohunt, RetrohuntMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Retrohunt result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Retrohunt, RetrohuntMetadata> retrievedResponse = await ruleServiceClient.PollOnceCreateRetrohuntAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Retrohunt retrievedResult = retrievedResponse.Result;
}

CreateRule(CreateRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
CreateRuleRequest request = new CreateRuleRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Rule = new Rule(),
};
// Make the request
Rule response = ruleServiceClient.CreateRule(request);

CreateRule(InstanceName, Rule, CallSettings)

public virtual Rule CreateRule(InstanceName parent, Rule rule, CallSettings callSettings = null)

Creates a new Rule.

Parameters
Name Description
parent InstanceName

Required. The parent resource where this rule will be created. Format: projects/{project}/locations/{location}/instances/{instance}

rule Rule

Required. The rule to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Rule

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Rule rule = new Rule();
// Make the request
Rule response = ruleServiceClient.CreateRule(parent, rule);

CreateRule(string, Rule, CallSettings)

public virtual Rule CreateRule(string parent, Rule rule, CallSettings callSettings = null)

Creates a new Rule.

Parameters
Name Description
parent string

Required. The parent resource where this rule will be created. Format: projects/{project}/locations/{location}/instances/{instance}

rule Rule

Required. The rule to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Rule

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
Rule rule = new Rule();
// Make the request
Rule response = ruleServiceClient.CreateRule(parent, rule);

CreateRuleAsync(CreateRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
CreateRuleRequest request = new CreateRuleRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Rule = new Rule(),
};
// Make the request
Rule response = await ruleServiceClient.CreateRuleAsync(request);

CreateRuleAsync(CreateRuleRequest, CancellationToken)

public virtual Task<Rule> CreateRuleAsync(CreateRuleRequest request, CancellationToken cancellationToken)

Creates a new Rule.

Parameters
Name Description
request CreateRuleRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
CreateRuleRequest request = new CreateRuleRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Rule = new Rule(),
};
// Make the request
Rule response = await ruleServiceClient.CreateRuleAsync(request);

CreateRuleAsync(InstanceName, Rule, CallSettings)

public virtual Task<Rule> CreateRuleAsync(InstanceName parent, Rule rule, CallSettings callSettings = null)

Creates a new Rule.

Parameters
Name Description
parent InstanceName

Required. The parent resource where this rule will be created. Format: projects/{project}/locations/{location}/instances/{instance}

rule Rule

Required. The rule to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Rule rule = new Rule();
// Make the request
Rule response = await ruleServiceClient.CreateRuleAsync(parent, rule);

CreateRuleAsync(InstanceName, Rule, CancellationToken)

public virtual Task<Rule> CreateRuleAsync(InstanceName parent, Rule rule, CancellationToken cancellationToken)

Creates a new Rule.

Parameters
Name Description
parent InstanceName

Required. The parent resource where this rule will be created. Format: projects/{project}/locations/{location}/instances/{instance}

rule Rule

Required. The rule to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Rule rule = new Rule();
// Make the request
Rule response = await ruleServiceClient.CreateRuleAsync(parent, rule);

CreateRuleAsync(string, Rule, CallSettings)

public virtual Task<Rule> CreateRuleAsync(string parent, Rule rule, CallSettings callSettings = null)

Creates a new Rule.

Parameters
Name Description
parent string

Required. The parent resource where this rule will be created. Format: projects/{project}/locations/{location}/instances/{instance}

rule Rule

Required. The rule to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
Rule rule = new Rule();
// Make the request
Rule response = await ruleServiceClient.CreateRuleAsync(parent, rule);

CreateRuleAsync(string, Rule, CancellationToken)

public virtual Task<Rule> CreateRuleAsync(string parent, Rule rule, CancellationToken cancellationToken)

Creates a new Rule.

Parameters
Name Description
parent string

Required. The parent resource where this rule will be created. Format: projects/{project}/locations/{location}/instances/{instance}

rule Rule

Required. The rule to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
Rule rule = new Rule();
// Make the request
Rule response = await ruleServiceClient.CreateRuleAsync(parent, rule);

DeleteRule(DeleteRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
DeleteRuleRequest request = new DeleteRuleRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Force = false,
};
// Make the request
ruleServiceClient.DeleteRule(request);

DeleteRule(RuleName, CallSettings)

public virtual void DeleteRule(RuleName name, CallSettings callSettings = null)

Deletes a Rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
ruleServiceClient.DeleteRule(name);

DeleteRule(string, CallSettings)

public virtual void DeleteRule(string name, CallSettings callSettings = null)

Deletes a Rule.

Parameters
Name Description
name string

Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
ruleServiceClient.DeleteRule(name);

DeleteRuleAsync(DeleteRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteRuleRequest request = new DeleteRuleRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Force = false,
};
// Make the request
await ruleServiceClient.DeleteRuleAsync(request);

DeleteRuleAsync(DeleteRuleRequest, CancellationToken)

public virtual Task DeleteRuleAsync(DeleteRuleRequest request, CancellationToken cancellationToken)

Deletes a Rule.

Parameters
Name Description
request DeleteRuleRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteRuleRequest request = new DeleteRuleRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Force = false,
};
// Make the request
await ruleServiceClient.DeleteRuleAsync(request);

DeleteRuleAsync(RuleName, CallSettings)

public virtual Task DeleteRuleAsync(RuleName name, CallSettings callSettings = null)

Deletes a Rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
await ruleServiceClient.DeleteRuleAsync(name);

DeleteRuleAsync(RuleName, CancellationToken)

public virtual Task DeleteRuleAsync(RuleName name, CancellationToken cancellationToken)

Deletes a Rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
await ruleServiceClient.DeleteRuleAsync(name);

DeleteRuleAsync(string, CallSettings)

public virtual Task DeleteRuleAsync(string name, CallSettings callSettings = null)

Deletes a Rule.

Parameters
Name Description
name string

Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
await ruleServiceClient.DeleteRuleAsync(name);

DeleteRuleAsync(string, CancellationToken)

public virtual Task DeleteRuleAsync(string name, CancellationToken cancellationToken)

Deletes a Rule.

Parameters
Name Description
name string

Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
await ruleServiceClient.DeleteRuleAsync(name);

GetRetrohunt(GetRetrohuntRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
GetRetrohuntRequest request = new GetRetrohuntRequest
{
    RetrohuntName = RetrohuntName.FromProjectLocationInstanceRuleRetrohunt("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]", "[RETROHUNT]"),
};
// Make the request
Retrohunt response = ruleServiceClient.GetRetrohunt(request);

GetRetrohunt(RetrohuntName, CallSettings)

public virtual Retrohunt GetRetrohunt(RetrohuntName name, CallSettings callSettings = null)

Get a Retrohunt.

Parameters
Name Description
name RetrohuntName

Required. The name of the retrohunt to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Retrohunt

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RetrohuntName name = RetrohuntName.FromProjectLocationInstanceRuleRetrohunt("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]", "[RETROHUNT]");
// Make the request
Retrohunt response = ruleServiceClient.GetRetrohunt(name);

GetRetrohunt(string, CallSettings)

public virtual Retrohunt GetRetrohunt(string name, CallSettings callSettings = null)

Get a Retrohunt.

Parameters
Name Description
name string

Required. The name of the retrohunt to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Retrohunt

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]/retrohunts/[RETROHUNT]";
// Make the request
Retrohunt response = ruleServiceClient.GetRetrohunt(name);

GetRetrohuntAsync(GetRetrohuntRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRetrohuntRequest request = new GetRetrohuntRequest
{
    RetrohuntName = RetrohuntName.FromProjectLocationInstanceRuleRetrohunt("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]", "[RETROHUNT]"),
};
// Make the request
Retrohunt response = await ruleServiceClient.GetRetrohuntAsync(request);

GetRetrohuntAsync(GetRetrohuntRequest, CancellationToken)

public virtual Task<Retrohunt> GetRetrohuntAsync(GetRetrohuntRequest request, CancellationToken cancellationToken)

Get a Retrohunt.

Parameters
Name Description
request GetRetrohuntRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrohunt

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRetrohuntRequest request = new GetRetrohuntRequest
{
    RetrohuntName = RetrohuntName.FromProjectLocationInstanceRuleRetrohunt("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]", "[RETROHUNT]"),
};
// Make the request
Retrohunt response = await ruleServiceClient.GetRetrohuntAsync(request);

GetRetrohuntAsync(RetrohuntName, CallSettings)

public virtual Task<Retrohunt> GetRetrohuntAsync(RetrohuntName name, CallSettings callSettings = null)

Get a Retrohunt.

Parameters
Name Description
name RetrohuntName

Required. The name of the retrohunt to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrohunt

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RetrohuntName name = RetrohuntName.FromProjectLocationInstanceRuleRetrohunt("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]", "[RETROHUNT]");
// Make the request
Retrohunt response = await ruleServiceClient.GetRetrohuntAsync(name);

GetRetrohuntAsync(RetrohuntName, CancellationToken)

public virtual Task<Retrohunt> GetRetrohuntAsync(RetrohuntName name, CancellationToken cancellationToken)

Get a Retrohunt.

Parameters
Name Description
name RetrohuntName

Required. The name of the retrohunt to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrohunt

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RetrohuntName name = RetrohuntName.FromProjectLocationInstanceRuleRetrohunt("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]", "[RETROHUNT]");
// Make the request
Retrohunt response = await ruleServiceClient.GetRetrohuntAsync(name);

GetRetrohuntAsync(string, CallSettings)

public virtual Task<Retrohunt> GetRetrohuntAsync(string name, CallSettings callSettings = null)

Get a Retrohunt.

Parameters
Name Description
name string

Required. The name of the retrohunt to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrohunt

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]/retrohunts/[RETROHUNT]";
// Make the request
Retrohunt response = await ruleServiceClient.GetRetrohuntAsync(name);

GetRetrohuntAsync(string, CancellationToken)

public virtual Task<Retrohunt> GetRetrohuntAsync(string name, CancellationToken cancellationToken)

Get a Retrohunt.

Parameters
Name Description
name string

Required. The name of the retrohunt to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrohunt

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]/retrohunts/[RETROHUNT]";
// Make the request
Retrohunt response = await ruleServiceClient.GetRetrohuntAsync(name);

GetRule(GetRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
GetRuleRequest request = new GetRuleRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    View = RuleView.Unspecified,
};
// Make the request
Rule response = ruleServiceClient.GetRule(request);

GetRule(RuleName, CallSettings)

public virtual Rule GetRule(RuleName name, CallSettings callSettings = null)

Gets a Rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Rule

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
Rule response = ruleServiceClient.GetRule(name);

GetRule(string, CallSettings)

public virtual Rule GetRule(string name, CallSettings callSettings = null)

Gets a Rule.

Parameters
Name Description
name string

Required. The name of the rule to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Rule

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
Rule response = ruleServiceClient.GetRule(name);

GetRuleAsync(GetRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRuleRequest request = new GetRuleRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    View = RuleView.Unspecified,
};
// Make the request
Rule response = await ruleServiceClient.GetRuleAsync(request);

GetRuleAsync(GetRuleRequest, CancellationToken)

public virtual Task<Rule> GetRuleAsync(GetRuleRequest request, CancellationToken cancellationToken)

Gets a Rule.

Parameters
Name Description
request GetRuleRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRuleRequest request = new GetRuleRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    View = RuleView.Unspecified,
};
// Make the request
Rule response = await ruleServiceClient.GetRuleAsync(request);

GetRuleAsync(RuleName, CallSettings)

public virtual Task<Rule> GetRuleAsync(RuleName name, CallSettings callSettings = null)

Gets a Rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
Rule response = await ruleServiceClient.GetRuleAsync(name);

GetRuleAsync(RuleName, CancellationToken)

public virtual Task<Rule> GetRuleAsync(RuleName name, CancellationToken cancellationToken)

Gets a Rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
Rule response = await ruleServiceClient.GetRuleAsync(name);

GetRuleAsync(string, CallSettings)

public virtual Task<Rule> GetRuleAsync(string name, CallSettings callSettings = null)

Gets a Rule.

Parameters
Name Description
name string

Required. The name of the rule to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
Rule response = await ruleServiceClient.GetRuleAsync(name);

GetRuleAsync(string, CancellationToken)

public virtual Task<Rule> GetRuleAsync(string name, CancellationToken cancellationToken)

Gets a Rule.

Parameters
Name Description
name string

Required. The name of the rule to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
Rule response = await ruleServiceClient.GetRuleAsync(name);

GetRuleDeployment(GetRuleDeploymentRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
GetRuleDeploymentRequest request = new GetRuleDeploymentRequest
{
    RuleDeploymentName = RuleDeploymentName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
};
// Make the request
RuleDeployment response = ruleServiceClient.GetRuleDeployment(request);

GetRuleDeployment(RuleDeploymentName, CallSettings)

public virtual RuleDeployment GetRuleDeployment(RuleDeploymentName name, CallSettings callSettings = null)

Gets a RuleDeployment.

Parameters
Name Description
name RuleDeploymentName

Required. The name of the rule deployment to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RuleDeployment

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleDeploymentName name = RuleDeploymentName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
RuleDeployment response = ruleServiceClient.GetRuleDeployment(name);

GetRuleDeployment(string, CallSettings)

public virtual RuleDeployment GetRuleDeployment(string name, CallSettings callSettings = null)

Gets a RuleDeployment.

Parameters
Name Description
name string

Required. The name of the rule deployment to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RuleDeployment

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]/deployment";
// Make the request
RuleDeployment response = ruleServiceClient.GetRuleDeployment(name);

GetRuleDeploymentAsync(GetRuleDeploymentRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRuleDeploymentRequest request = new GetRuleDeploymentRequest
{
    RuleDeploymentName = RuleDeploymentName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
};
// Make the request
RuleDeployment response = await ruleServiceClient.GetRuleDeploymentAsync(request);

GetRuleDeploymentAsync(GetRuleDeploymentRequest, CancellationToken)

public virtual Task<RuleDeployment> GetRuleDeploymentAsync(GetRuleDeploymentRequest request, CancellationToken cancellationToken)

Gets a RuleDeployment.

Parameters
Name Description
request GetRuleDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRuleDeploymentRequest request = new GetRuleDeploymentRequest
{
    RuleDeploymentName = RuleDeploymentName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
};
// Make the request
RuleDeployment response = await ruleServiceClient.GetRuleDeploymentAsync(request);

GetRuleDeploymentAsync(RuleDeploymentName, CallSettings)

public virtual Task<RuleDeployment> GetRuleDeploymentAsync(RuleDeploymentName name, CallSettings callSettings = null)

Gets a RuleDeployment.

Parameters
Name Description
name RuleDeploymentName

Required. The name of the rule deployment to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleDeploymentName name = RuleDeploymentName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
RuleDeployment response = await ruleServiceClient.GetRuleDeploymentAsync(name);

GetRuleDeploymentAsync(RuleDeploymentName, CancellationToken)

public virtual Task<RuleDeployment> GetRuleDeploymentAsync(RuleDeploymentName name, CancellationToken cancellationToken)

Gets a RuleDeployment.

Parameters
Name Description
name RuleDeploymentName

Required. The name of the rule deployment to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleDeploymentName name = RuleDeploymentName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
RuleDeployment response = await ruleServiceClient.GetRuleDeploymentAsync(name);

GetRuleDeploymentAsync(string, CallSettings)

public virtual Task<RuleDeployment> GetRuleDeploymentAsync(string name, CallSettings callSettings = null)

Gets a RuleDeployment.

Parameters
Name Description
name string

Required. The name of the rule deployment to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]/deployment";
// Make the request
RuleDeployment response = await ruleServiceClient.GetRuleDeploymentAsync(name);

GetRuleDeploymentAsync(string, CancellationToken)

public virtual Task<RuleDeployment> GetRuleDeploymentAsync(string name, CancellationToken cancellationToken)

Gets a RuleDeployment.

Parameters
Name Description
name string

Required. The name of the rule deployment to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]/deployment";
// Make the request
RuleDeployment response = await ruleServiceClient.GetRuleDeploymentAsync(name);

ListRetrohunts(ListRetrohuntsRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
ListRetrohuntsRequest request = new ListRetrohuntsRequest
{
    ParentAsRuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListRetrohuntsResponse, Retrohunt> response = ruleServiceClient.ListRetrohunts(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Retrohunt item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRetrohuntsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Retrohunt item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Retrohunt> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Retrohunt item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRetrohunts(RuleName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRetrohuntsResponse, Retrohunt> ListRetrohunts(RuleName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Retrohunts.

Parameters
Name Description
parent RuleName

Required. The rule that the retrohunts belong to. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRetrohuntsResponseRetrohunt

A pageable sequence of Retrohunt resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleName parent = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
PagedEnumerable<ListRetrohuntsResponse, Retrohunt> response = ruleServiceClient.ListRetrohunts(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Retrohunt item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRetrohuntsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Retrohunt item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Retrohunt> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Retrohunt item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRetrohunts(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRetrohuntsResponse, Retrohunt> ListRetrohunts(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Retrohunts.

Parameters
Name Description
parent string

Required. The rule that the retrohunts belong to. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRetrohuntsResponseRetrohunt

A pageable sequence of Retrohunt resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
PagedEnumerable<ListRetrohuntsResponse, Retrohunt> response = ruleServiceClient.ListRetrohunts(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Retrohunt item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRetrohuntsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Retrohunt item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Retrohunt> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Retrohunt item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRetrohuntsAsync(ListRetrohuntsRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
ListRetrohuntsRequest request = new ListRetrohuntsRequest
{
    ParentAsRuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListRetrohuntsResponse, Retrohunt> response = ruleServiceClient.ListRetrohuntsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Retrohunt item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRetrohuntsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Retrohunt item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Retrohunt> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Retrohunt item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRetrohuntsAsync(RuleName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRetrohuntsResponse, Retrohunt> ListRetrohuntsAsync(RuleName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Retrohunts.

Parameters
Name Description
parent RuleName

Required. The rule that the retrohunts belong to. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRetrohuntsResponseRetrohunt

A pageable asynchronous sequence of Retrohunt resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName parent = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
PagedAsyncEnumerable<ListRetrohuntsResponse, Retrohunt> response = ruleServiceClient.ListRetrohuntsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Retrohunt item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRetrohuntsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Retrohunt item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Retrohunt> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Retrohunt item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRetrohuntsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRetrohuntsResponse, Retrohunt> ListRetrohuntsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Retrohunts.

Parameters
Name Description
parent string

Required. The rule that the retrohunts belong to. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRetrohuntsResponseRetrohunt

A pageable asynchronous sequence of Retrohunt resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
PagedAsyncEnumerable<ListRetrohuntsResponse, Retrohunt> response = ruleServiceClient.ListRetrohuntsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Retrohunt item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRetrohuntsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Retrohunt item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Retrohunt> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Retrohunt item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleDeployments(ListRuleDeploymentsRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
ListRuleDeploymentsRequest request = new ListRuleDeploymentsRequest
{
    ParentAsRuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListRuleDeploymentsResponse, RuleDeployment> response = ruleServiceClient.ListRuleDeployments(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (RuleDeployment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRuleDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RuleDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<RuleDeployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (RuleDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleDeployments(RuleName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRuleDeploymentsResponse, RuleDeployment> ListRuleDeployments(RuleName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RuleDeployments across all Rules.

Parameters
Name Description
parent RuleName

Required. The collection of all parents which own all rule deployments. The "-" wildcard token must be used as the rule identifier in the resource path. Format: projects/{project}/locations/{location}/instances/{instance}/rules/-

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRuleDeploymentsResponseRuleDeployment

A pageable sequence of RuleDeployment resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleName parent = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
PagedEnumerable<ListRuleDeploymentsResponse, RuleDeployment> response = ruleServiceClient.ListRuleDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (RuleDeployment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRuleDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RuleDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<RuleDeployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (RuleDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleDeployments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRuleDeploymentsResponse, RuleDeployment> ListRuleDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RuleDeployments across all Rules.

Parameters
Name Description
parent string

Required. The collection of all parents which own all rule deployments. The "-" wildcard token must be used as the rule identifier in the resource path. Format: projects/{project}/locations/{location}/instances/{instance}/rules/-

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRuleDeploymentsResponseRuleDeployment

A pageable sequence of RuleDeployment resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
PagedEnumerable<ListRuleDeploymentsResponse, RuleDeployment> response = ruleServiceClient.ListRuleDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (RuleDeployment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRuleDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RuleDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<RuleDeployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (RuleDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleDeploymentsAsync(ListRuleDeploymentsRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
ListRuleDeploymentsRequest request = new ListRuleDeploymentsRequest
{
    ParentAsRuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListRuleDeploymentsResponse, RuleDeployment> response = ruleServiceClient.ListRuleDeploymentsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((RuleDeployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRuleDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RuleDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<RuleDeployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (RuleDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleDeploymentsAsync(RuleName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRuleDeploymentsResponse, RuleDeployment> ListRuleDeploymentsAsync(RuleName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RuleDeployments across all Rules.

Parameters
Name Description
parent RuleName

Required. The collection of all parents which own all rule deployments. The "-" wildcard token must be used as the rule identifier in the resource path. Format: projects/{project}/locations/{location}/instances/{instance}/rules/-

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRuleDeploymentsResponseRuleDeployment

A pageable asynchronous sequence of RuleDeployment resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName parent = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
PagedAsyncEnumerable<ListRuleDeploymentsResponse, RuleDeployment> response = ruleServiceClient.ListRuleDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((RuleDeployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRuleDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RuleDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<RuleDeployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (RuleDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleDeploymentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRuleDeploymentsResponse, RuleDeployment> ListRuleDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RuleDeployments across all Rules.

Parameters
Name Description
parent string

Required. The collection of all parents which own all rule deployments. The "-" wildcard token must be used as the rule identifier in the resource path. Format: projects/{project}/locations/{location}/instances/{instance}/rules/-

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRuleDeploymentsResponseRuleDeployment

A pageable asynchronous sequence of RuleDeployment resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
PagedAsyncEnumerable<ListRuleDeploymentsResponse, RuleDeployment> response = ruleServiceClient.ListRuleDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((RuleDeployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRuleDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RuleDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<RuleDeployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (RuleDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleRevisions(ListRuleRevisionsRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
ListRuleRevisionsRequest request = new ListRuleRevisionsRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    View = RuleView.Unspecified,
};
// Make the request
PagedEnumerable<ListRuleRevisionsResponse, Rule> response = ruleServiceClient.ListRuleRevisions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Rule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRuleRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleRevisions(RuleName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRuleRevisionsResponse, Rule> ListRuleRevisions(RuleName name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all revisions of the rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to list revisions for. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRuleRevisionsResponseRule

A pageable sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
PagedEnumerable<ListRuleRevisionsResponse, Rule> response = ruleServiceClient.ListRuleRevisions(name);

// Iterate over all response items, lazily performing RPCs as required
foreach (Rule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRuleRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleRevisions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRuleRevisionsResponse, Rule> ListRuleRevisions(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all revisions of the rule.

Parameters
Name Description
name string

Required. The name of the rule to list revisions for. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRuleRevisionsResponseRule

A pageable sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
PagedEnumerable<ListRuleRevisionsResponse, Rule> response = ruleServiceClient.ListRuleRevisions(name);

// Iterate over all response items, lazily performing RPCs as required
foreach (Rule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRuleRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleRevisionsAsync(ListRuleRevisionsRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
ListRuleRevisionsRequest request = new ListRuleRevisionsRequest
{
    RuleName = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]"),
    View = RuleView.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListRuleRevisionsResponse, Rule> response = ruleServiceClient.ListRuleRevisionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Rule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRuleRevisionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleRevisionsAsync(RuleName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRuleRevisionsResponse, Rule> ListRuleRevisionsAsync(RuleName name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all revisions of the rule.

Parameters
Name Description
name RuleName

Required. The name of the rule to list revisions for. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRuleRevisionsResponseRule

A pageable asynchronous sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleName name = RuleName.FromProjectLocationInstanceRule("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[RULE]");
// Make the request
PagedAsyncEnumerable<ListRuleRevisionsResponse, Rule> response = ruleServiceClient.ListRuleRevisionsAsync(name);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Rule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRuleRevisionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRuleRevisionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRuleRevisionsResponse, Rule> ListRuleRevisionsAsync(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all revisions of the rule.

Parameters
Name Description
name string

Required. The name of the rule to list revisions for. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRuleRevisionsResponseRule

A pageable asynchronous sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/rules/[RULE]";
// Make the request
PagedAsyncEnumerable<ListRuleRevisionsResponse, Rule> response = ruleServiceClient.ListRuleRevisionsAsync(name);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Rule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRuleRevisionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRules(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRulesResponse, Rule> ListRules(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Rules.

Parameters
Name Description
parent InstanceName

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRulesResponseRule

A pageable sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListRulesResponse, Rule> response = ruleServiceClient.ListRules(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Rule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRules(ListRulesRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
ListRulesRequest request = new ListRulesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    View = RuleView.Unspecified,
    Filter = "",
};
// Make the request
PagedEnumerable<ListRulesResponse, Rule> response = ruleServiceClient.ListRules(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Rule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRules(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRulesResponse, Rule> ListRules(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Rules.

Parameters
Name Description
parent string

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRulesResponseRule

A pageable sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedEnumerable<ListRulesResponse, Rule> response = ruleServiceClient.ListRules(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Rule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRulesAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRulesResponse, Rule> ListRulesAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Rules.

Parameters
Name Description
parent InstanceName

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRulesResponseRule

A pageable asynchronous sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListRulesResponse, Rule> response = ruleServiceClient.ListRulesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Rule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRulesAsync(ListRulesRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
ListRulesRequest request = new ListRulesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    View = RuleView.Unspecified,
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListRulesResponse, Rule> response = ruleServiceClient.ListRulesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Rule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRulesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRulesResponse, Rule> ListRulesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Rules.

Parameters
Name Description
parent string

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRulesResponseRule

A pageable asynchronous sequence of Rule resources.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListRulesResponse, Rule> response = ruleServiceClient.ListRulesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Rule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Rule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Rule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Rule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateRetrohunt(string, CallSettings)

public virtual Operation<Retrohunt, RetrohuntMetadata> PollOnceCreateRetrohunt(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateRetrohunt.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRetrohuntRetrohuntMetadata

The result of polling the operation.

PollOnceCreateRetrohuntAsync(string, CallSettings)

public virtual Task<Operation<Retrohunt, RetrohuntMetadata>> PollOnceCreateRetrohuntAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateRetrohunt.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRetrohuntRetrohuntMetadata

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateRule(Rule, FieldMask, CallSettings)

public virtual Rule UpdateRule(Rule rule, FieldMask updateMask, CallSettings callSettings = null)

Updates a Rule.

Parameters
Name Description
rule Rule

Required. The rule to update.

The rule's name field is used to identify the rule to update. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Rule

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
Rule rule = new Rule();
FieldMask updateMask = new FieldMask();
// Make the request
Rule response = ruleServiceClient.UpdateRule(rule, updateMask);

UpdateRule(UpdateRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
UpdateRuleRequest request = new UpdateRuleRequest
{
    Rule = new Rule(),
    UpdateMask = new FieldMask(),
};
// Make the request
Rule response = ruleServiceClient.UpdateRule(request);

UpdateRuleAsync(Rule, FieldMask, CallSettings)

public virtual Task<Rule> UpdateRuleAsync(Rule rule, FieldMask updateMask, CallSettings callSettings = null)

Updates a Rule.

Parameters
Name Description
rule Rule

Required. The rule to update.

The rule's name field is used to identify the rule to update. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
Rule rule = new Rule();
FieldMask updateMask = new FieldMask();
// Make the request
Rule response = await ruleServiceClient.UpdateRuleAsync(rule, updateMask);

UpdateRuleAsync(Rule, FieldMask, CancellationToken)

public virtual Task<Rule> UpdateRuleAsync(Rule rule, FieldMask updateMask, CancellationToken cancellationToken)

Updates a Rule.

Parameters
Name Description
rule Rule

Required. The rule to update.

The rule's name field is used to identify the rule to update. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
Rule rule = new Rule();
FieldMask updateMask = new FieldMask();
// Make the request
Rule response = await ruleServiceClient.UpdateRuleAsync(rule, updateMask);

UpdateRuleAsync(UpdateRuleRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateRuleRequest request = new UpdateRuleRequest
{
    Rule = new Rule(),
    UpdateMask = new FieldMask(),
};
// Make the request
Rule response = await ruleServiceClient.UpdateRuleAsync(request);

UpdateRuleAsync(UpdateRuleRequest, CancellationToken)

public virtual Task<Rule> UpdateRuleAsync(UpdateRuleRequest request, CancellationToken cancellationToken)

Updates a Rule.

Parameters
Name Description
request UpdateRuleRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRule

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateRuleRequest request = new UpdateRuleRequest
{
    Rule = new Rule(),
    UpdateMask = new FieldMask(),
};
// Make the request
Rule response = await ruleServiceClient.UpdateRuleAsync(request);

UpdateRuleDeployment(RuleDeployment, FieldMask, CallSettings)

public virtual RuleDeployment UpdateRuleDeployment(RuleDeployment ruleDeployment, FieldMask updateMask, 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
ruleDeployment RuleDeployment

Required. The rule deployment to update.

The rule deployment's name field is used to identify the rule deployment to update. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

updateMask FieldMask

Required. The list of fields to update.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RuleDeployment

The RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
RuleDeployment ruleDeployment = new RuleDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
RuleDeployment response = ruleServiceClient.UpdateRuleDeployment(ruleDeployment, updateMask);

UpdateRuleDeployment(UpdateRuleDeploymentRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = RuleServiceClient.Create();
// Initialize request argument(s)
UpdateRuleDeploymentRequest request = new UpdateRuleDeploymentRequest
{
    RuleDeployment = new RuleDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
RuleDeployment response = ruleServiceClient.UpdateRuleDeployment(request);

UpdateRuleDeploymentAsync(RuleDeployment, FieldMask, CallSettings)

public virtual Task<RuleDeployment> UpdateRuleDeploymentAsync(RuleDeployment ruleDeployment, FieldMask updateMask, 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
ruleDeployment RuleDeployment

Required. The rule deployment to update.

The rule deployment's name field is used to identify the rule deployment to update. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

updateMask FieldMask

Required. The list of fields to update.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleDeployment ruleDeployment = new RuleDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
RuleDeployment response = await ruleServiceClient.UpdateRuleDeploymentAsync(ruleDeployment, updateMask);

UpdateRuleDeploymentAsync(RuleDeployment, FieldMask, CancellationToken)

public virtual Task<RuleDeployment> UpdateRuleDeploymentAsync(RuleDeployment ruleDeployment, FieldMask updateMask, CancellationToken cancellationToken)

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
ruleDeployment RuleDeployment

Required. The rule deployment to update.

The rule deployment's name field is used to identify the rule deployment to update. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

updateMask FieldMask

Required. The list of fields to update.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
RuleDeployment ruleDeployment = new RuleDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
RuleDeployment response = await ruleServiceClient.UpdateRuleDeploymentAsync(ruleDeployment, updateMask);

UpdateRuleDeploymentAsync(UpdateRuleDeploymentRequest, CallSettings)

public virtual 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.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateRuleDeploymentRequest request = new UpdateRuleDeploymentRequest
{
    RuleDeployment = new RuleDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
RuleDeployment response = await ruleServiceClient.UpdateRuleDeploymentAsync(request);

UpdateRuleDeploymentAsync(UpdateRuleDeploymentRequest, CancellationToken)

public virtual Task<RuleDeployment> UpdateRuleDeploymentAsync(UpdateRuleDeploymentRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRuleDeployment

A Task containing the RPC response.

Example
// Create client
RuleServiceClient ruleServiceClient = await RuleServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateRuleDeploymentRequest request = new UpdateRuleDeploymentRequest
{
    RuleDeployment = new RuleDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
RuleDeployment response = await ruleServiceClient.UpdateRuleDeploymentAsync(request);