Compute Engine v1 API - Class ReliabilityRisksClient (3.30.0)

public abstract class ReliabilityRisksClient

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

ReliabilityRisks client wrapper, for convenient use.

Inheritance

object > ReliabilityRisksClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ReliabilityRisks API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ReliabilityRisks 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 ReliabilityRisks scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

GrpcClient

public virtual ReliabilityRisks.ReliabilityRisksClient GrpcClient { get; }

The underlying gRPC ReliabilityRisks client

Property Value
Type Description
ReliabilityRisksReliabilityRisksClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static ReliabilityRisksClient Create()

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

Returns
Type Description
ReliabilityRisksClient

The created ReliabilityRisksClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskReliabilityRisksClient

The task representing the created ReliabilityRisksClient.

Get(GetReliabilityRiskRequest, CallSettings)

public virtual ReliabilityRisk Get(GetReliabilityRiskRequest request, CallSettings callSettings = null)

Returns the specified ReliabilityRisk resource.

Parameters
Name Description
request GetReliabilityRiskRequest

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
ReliabilityRisk

The RPC response.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = ReliabilityRisksClient.Create();
// Initialize request argument(s)
GetReliabilityRiskRequest request = new GetReliabilityRiskRequest
{
    Project = "",
    ReliabilityRisk = "",
};
// Make the request
ReliabilityRisk response = reliabilityRisksClient.Get(request);

Get(string, string, CallSettings)

public virtual ReliabilityRisk Get(string project, string reliabilityRisk, CallSettings callSettings = null)

Returns the specified ReliabilityRisk resource.

Parameters
Name Description
project string

Project ID for this request.

reliabilityRisk string

Name of the ReliabilityRisk resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ReliabilityRisk

The RPC response.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = ReliabilityRisksClient.Create();
// Initialize request argument(s)
string project = "";
string reliabilityRisk = "";
// Make the request
ReliabilityRisk response = reliabilityRisksClient.Get(project, reliabilityRisk);

GetAsync(GetReliabilityRiskRequest, CallSettings)

public virtual Task<ReliabilityRisk> GetAsync(GetReliabilityRiskRequest request, CallSettings callSettings = null)

Returns the specified ReliabilityRisk resource.

Parameters
Name Description
request GetReliabilityRiskRequest

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
TaskReliabilityRisk

A Task containing the RPC response.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = await ReliabilityRisksClient.CreateAsync();
// Initialize request argument(s)
GetReliabilityRiskRequest request = new GetReliabilityRiskRequest
{
    Project = "",
    ReliabilityRisk = "",
};
// Make the request
ReliabilityRisk response = await reliabilityRisksClient.GetAsync(request);

GetAsync(GetReliabilityRiskRequest, CancellationToken)

public virtual Task<ReliabilityRisk> GetAsync(GetReliabilityRiskRequest request, CancellationToken cancellationToken)

Returns the specified ReliabilityRisk resource.

Parameters
Name Description
request GetReliabilityRiskRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskReliabilityRisk

A Task containing the RPC response.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = await ReliabilityRisksClient.CreateAsync();
// Initialize request argument(s)
GetReliabilityRiskRequest request = new GetReliabilityRiskRequest
{
    Project = "",
    ReliabilityRisk = "",
};
// Make the request
ReliabilityRisk response = await reliabilityRisksClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<ReliabilityRisk> GetAsync(string project, string reliabilityRisk, CallSettings callSettings = null)

Returns the specified ReliabilityRisk resource.

Parameters
Name Description
project string

Project ID for this request.

reliabilityRisk string

Name of the ReliabilityRisk resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskReliabilityRisk

A Task containing the RPC response.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = await ReliabilityRisksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string reliabilityRisk = "";
// Make the request
ReliabilityRisk response = await reliabilityRisksClient.GetAsync(project, reliabilityRisk);

GetAsync(string, string, CancellationToken)

public virtual Task<ReliabilityRisk> GetAsync(string project, string reliabilityRisk, CancellationToken cancellationToken)

Returns the specified ReliabilityRisk resource.

Parameters
Name Description
project string

Project ID for this request.

reliabilityRisk string

Name of the ReliabilityRisk resource to return.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskReliabilityRisk

A Task containing the RPC response.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = await ReliabilityRisksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string reliabilityRisk = "";
// Make the request
ReliabilityRisk response = await reliabilityRisksClient.GetAsync(project, reliabilityRisk);

List(ListReliabilityRisksRequest, CallSettings)

public virtual PagedEnumerable<ReliabilityRisksListResponse, ReliabilityRisk> List(ListReliabilityRisksRequest request, CallSettings callSettings = null)

Retrieves the list of reliabilityRisks available in the specified project.

Parameters
Name Description
request ListReliabilityRisksRequest

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
PagedEnumerableReliabilityRisksListResponseReliabilityRisk

A pageable sequence of ReliabilityRisk resources.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = ReliabilityRisksClient.Create();
// Initialize request argument(s)
ListReliabilityRisksRequest request = new ListReliabilityRisksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ReliabilityRisksListResponse, ReliabilityRisk> response = reliabilityRisksClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ReliabilityRisk 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 (ReliabilityRisksListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReliabilityRisk 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<ReliabilityRisk> 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 (ReliabilityRisk 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<ReliabilityRisksListResponse, ReliabilityRisk> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of reliabilityRisks available in the specified project.

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
PagedEnumerableReliabilityRisksListResponseReliabilityRisk

A pageable sequence of ReliabilityRisk resources.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = ReliabilityRisksClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<ReliabilityRisksListResponse, ReliabilityRisk> response = reliabilityRisksClient.List(project);

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

public virtual PagedAsyncEnumerable<ReliabilityRisksListResponse, ReliabilityRisk> ListAsync(ListReliabilityRisksRequest request, CallSettings callSettings = null)

Retrieves the list of reliabilityRisks available in the specified project.

Parameters
Name Description
request ListReliabilityRisksRequest

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
PagedAsyncEnumerableReliabilityRisksListResponseReliabilityRisk

A pageable asynchronous sequence of ReliabilityRisk resources.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = await ReliabilityRisksClient.CreateAsync();
// Initialize request argument(s)
ListReliabilityRisksRequest request = new ListReliabilityRisksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ReliabilityRisksListResponse, ReliabilityRisk> response = reliabilityRisksClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (ReliabilityRisk 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 (ReliabilityRisksListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReliabilityRisk 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<ReliabilityRisk> 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 (ReliabilityRisk 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<ReliabilityRisksListResponse, ReliabilityRisk> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of reliabilityRisks available in the specified project.

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
PagedAsyncEnumerableReliabilityRisksListResponseReliabilityRisk

A pageable asynchronous sequence of ReliabilityRisk resources.

Example
// Create client
ReliabilityRisksClient reliabilityRisksClient = await ReliabilityRisksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<ReliabilityRisksListResponse, ReliabilityRisk> response = reliabilityRisksClient.ListAsync(project);

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