Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Compute Engine v1 API - Class ManagedRulesetsClient (4.0.0)

public abstract class ManagedRulesetsClient

Reference documentation and code samples for the Compute Engine v1 API class ManagedRulesetsClient.

ManagedRulesets client wrapper, for convenient use. This client implements API version 2026-09-01.

Inheritance

object > ManagedRulesetsClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ManagedRulesetsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ManagedRulesets API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ManagedRulesets scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default ManagedRulesets scopes are:

GrpcClient

public virtual ManagedRulesets.ManagedRulesetsClient GrpcClient { get; }

The underlying gRPC ManagedRulesets client

Property Value
Type	Description
`ManagedRulesetsManagedRulesetsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static ManagedRulesetsClient Create()

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

Returns
Type	Description
`ManagedRulesetsClient`	The created ManagedRulesetsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskManagedRulesetsClient`	The task representing the created ManagedRulesetsClient.

Get(GetManagedRulesetRequest, CallSettings)

public virtual ManagedRuleset Get(GetManagedRulesetRequest request, CallSettings callSettings = null)

Gets the details for the specified managed ruleset name.

Parameters
Name	Description
`request`	`GetManagedRulesetRequest` 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
`ManagedRuleset`	The RPC response.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.Create();
// Initialize request argument(s)
GetManagedRulesetRequest request = new GetManagedRulesetRequest
{
    Project = "",
    ManagedRuleset = "",
};
// Make the request
ManagedRuleset response = managedRulesetsClient.Get(request);

Get(string, string, CallSettings)

public virtual ManagedRuleset Get(string project, string managedRuleset, CallSettings callSettings = null)

Gets the details for the specified managed ruleset name.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`managedRuleset`	`string` Name of the managed ruleset to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ManagedRuleset`	The RPC response.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.Create();
// Initialize request argument(s)
string project = "";
string managedRuleset = "";
// Make the request
ManagedRuleset response = managedRulesetsClient.Get(project, managedRuleset);

GetAsync(GetManagedRulesetRequest, CallSettings)

public virtual Task<ManagedRuleset> GetAsync(GetManagedRulesetRequest request, CallSettings callSettings = null)

Gets the details for the specified managed ruleset name.

Parameters
Name	Description
`request`	`GetManagedRulesetRequest` 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
`TaskManagedRuleset`	A Task containing the RPC response.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = await ManagedRulesetsClient.CreateAsync();
// Initialize request argument(s)
GetManagedRulesetRequest request = new GetManagedRulesetRequest
{
    Project = "",
    ManagedRuleset = "",
};
// Make the request
ManagedRuleset response = await managedRulesetsClient.GetAsync(request);

GetAsync(GetManagedRulesetRequest, CancellationToken)

public virtual Task<ManagedRuleset> GetAsync(GetManagedRulesetRequest request, CancellationToken cancellationToken)

Gets the details for the specified managed ruleset name.

Parameters
Name	Description
`request`	`GetManagedRulesetRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskManagedRuleset`	A Task containing the RPC response.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = await ManagedRulesetsClient.CreateAsync();
// Initialize request argument(s)
GetManagedRulesetRequest request = new GetManagedRulesetRequest
{
    Project = "",
    ManagedRuleset = "",
};
// Make the request
ManagedRuleset response = await managedRulesetsClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<ManagedRuleset> GetAsync(string project, string managedRuleset, CallSettings callSettings = null)

Gets the details for the specified managed ruleset name.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`managedRuleset`	`string` Name of the managed ruleset to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskManagedRuleset`	A Task containing the RPC response.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = await ManagedRulesetsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string managedRuleset = "";
// Make the request
ManagedRuleset response = await managedRulesetsClient.GetAsync(project, managedRuleset);

GetAsync(string, string, CancellationToken)

public virtual Task<ManagedRuleset> GetAsync(string project, string managedRuleset, CancellationToken cancellationToken)

Gets the details for the specified managed ruleset name.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`managedRuleset`	`string` Name of the managed ruleset to return.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskManagedRuleset`	A Task containing the RPC response.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = await ManagedRulesetsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string managedRuleset = "";
// Make the request
ManagedRuleset response = await managedRulesetsClient.GetAsync(project, managedRuleset);

List(ListManagedRulesetsRequest, CallSettings)

public virtual PagedEnumerable<ManagedRulesetList, ManagedRuleset> List(ListManagedRulesetsRequest request, CallSettings callSettings = null)

Retrieves the list of all the managed rulesets available.

Parameters
Name	Description
`request`	`ListManagedRulesetsRequest` 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
`PagedEnumerableManagedRulesetListManagedRuleset`	A pageable sequence of ManagedRuleset resources.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.Create();
// Initialize request argument(s)
ListManagedRulesetsRequest request = new ListManagedRulesetsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
};
// Make the request
PagedEnumerable<ManagedRulesetList, ManagedRuleset> response = managedRulesetsClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ManagedRuleset 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 (ManagedRulesetList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ManagedRuleset 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<ManagedRuleset> 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 (ManagedRuleset 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;

List(string, string, int?, CallSettings)

public virtual PagedEnumerable<ManagedRulesetList, ManagedRuleset> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of all the managed rulesets available.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`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
`PagedEnumerableManagedRulesetListManagedRuleset`	A pageable sequence of ManagedRuleset resources.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<ManagedRulesetList, ManagedRuleset> response = managedRulesetsClient.List(project);

// Iterate over all response items, lazily performing RPCs as required
foreach (ManagedRuleset 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 (ManagedRulesetList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ManagedRuleset 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<ManagedRuleset> 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 (ManagedRuleset 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;

ListAsync(ListManagedRulesetsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ManagedRulesetList, ManagedRuleset> ListAsync(ListManagedRulesetsRequest request, CallSettings callSettings = null)

Retrieves the list of all the managed rulesets available.

Parameters
Name	Description
`request`	`ListManagedRulesetsRequest` 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
`PagedAsyncEnumerableManagedRulesetListManagedRuleset`	A pageable asynchronous sequence of ManagedRuleset resources.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = await ManagedRulesetsClient.CreateAsync();
// Initialize request argument(s)
ListManagedRulesetsRequest request = new ListManagedRulesetsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ManagedRulesetList, ManagedRuleset> response = managedRulesetsClient.ListAsync(request);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ManagedRulesetList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ManagedRuleset 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<ManagedRuleset> 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 (ManagedRuleset 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;

ListAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ManagedRulesetList, ManagedRuleset> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of all the managed rulesets available.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`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
`PagedAsyncEnumerableManagedRulesetListManagedRuleset`	A pageable asynchronous sequence of ManagedRuleset resources.

Example

// Create client
ManagedRulesetsClient managedRulesetsClient = await ManagedRulesetsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<ManagedRulesetList, ManagedRuleset> response = managedRulesetsClient.ListAsync(project);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ManagedRulesetList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ManagedRuleset 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<ManagedRuleset> 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 (ManagedRuleset 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;

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.