Class RegionNotificationEndpointsClient (1.4.0)

Version 1.4.0

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class RegionNotificationEndpointsClient

RegionNotificationEndpoints client wrapper, for convenient use.

Inheritance

Object > RegionNotificationEndpointsClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

RegionNotificationEndpointsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionNotificationEndpoints API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
IReadOnlyList<String>

Remarks

The default RegionNotificationEndpoints scopes are:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual RegionNotificationEndpoints.RegionNotificationEndpointsClient GrpcClient { get; }

The underlying gRPC RegionNotificationEndpoints client

Property Value
Type	Description
RegionNotificationEndpoints.RegionNotificationEndpointsClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Methods

Create()

public static RegionNotificationEndpointsClient Create()

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

Returns
Type	Description
RegionNotificationEndpointsClient	The created RegionNotificationEndpointsClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
Task<RegionNotificationEndpointsClient>	The task representing the created RegionNotificationEndpointsClient.

Delete(DeleteRegionNotificationEndpointRequest, CallSettings)

public virtual Operation<Operation, Operation> Delete(DeleteRegionNotificationEndpointRequest request, CallSettings callSettings = null)

Deletes the specified NotificationEndpoint in the given region

Parameters
Name	Description
request	DeleteRegionNotificationEndpointRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
DeleteRegionNotificationEndpointRequest request = new DeleteRegionNotificationEndpointRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NotificationEndpoint = "",
};
// Make the request
lro::Operation<Operation, Operation> response = regionNotificationEndpointsClient.Delete(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = regionNotificationEndpointsClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Delete(String, String, String, CallSettings)

public virtual Operation<Operation, Operation> Delete(string project, string region, string notificationEndpoint, CallSettings callSettings = null)

Deletes the specified NotificationEndpoint in the given region

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpoint	String Name of the NotificationEndpoint resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string notificationEndpoint = "";
// Make the request
lro::Operation<Operation, Operation> response = regionNotificationEndpointsClient.Delete(project, region, notificationEndpoint);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = regionNotificationEndpointsClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteRegionNotificationEndpointRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteRegionNotificationEndpointRequest request, CallSettings callSettings = null)

Deletes the specified NotificationEndpoint in the given region

Parameters
Name	Description
request	DeleteRegionNotificationEndpointRequest 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<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionNotificationEndpointRequest request = new DeleteRegionNotificationEndpointRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NotificationEndpoint = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteRegionNotificationEndpointRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteRegionNotificationEndpointRequest request, CancellationToken cancellationToken)

Deletes the specified NotificationEndpoint in the given region

Parameters
Name	Description
request	DeleteRegionNotificationEndpointRequest 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<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionNotificationEndpointRequest request = new DeleteRegionNotificationEndpointRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NotificationEndpoint = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(String, String, String, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string notificationEndpoint, CallSettings callSettings = null)

Deletes the specified NotificationEndpoint in the given region

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpoint	String Name of the NotificationEndpoint resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string notificationEndpoint = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.DeleteAsync(project, region, notificationEndpoint);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(String, String, String, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string notificationEndpoint, CancellationToken cancellationToken)

Deletes the specified NotificationEndpoint in the given region

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpoint	String Name of the NotificationEndpoint resource to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string notificationEndpoint = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.DeleteAsync(project, region, notificationEndpoint);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Get(GetRegionNotificationEndpointRequest, CallSettings)

public virtual NotificationEndpoint Get(GetRegionNotificationEndpointRequest request, CallSettings callSettings = null)

Returns the specified NotificationEndpoint resource in the given region.

Parameters
Name	Description
request	GetRegionNotificationEndpointRequest 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
NotificationEndpoint	The RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
GetRegionNotificationEndpointRequest request = new GetRegionNotificationEndpointRequest
{
    Region = "",
    Project = "",
    NotificationEndpoint = "",
};
// Make the request
NotificationEndpoint response = regionNotificationEndpointsClient.Get(request);

Get(String, String, String, CallSettings)

public virtual NotificationEndpoint Get(string project, string region, string notificationEndpoint, CallSettings callSettings = null)

Returns the specified NotificationEndpoint resource in the given region.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpoint	String Name of the NotificationEndpoint resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
NotificationEndpoint	The RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string notificationEndpoint = "";
// Make the request
NotificationEndpoint response = regionNotificationEndpointsClient.Get(project, region, notificationEndpoint);

GetAsync(GetRegionNotificationEndpointRequest, CallSettings)

public virtual Task<NotificationEndpoint> GetAsync(GetRegionNotificationEndpointRequest request, CallSettings callSettings = null)

Returns the specified NotificationEndpoint resource in the given region.

Parameters
Name	Description
request	GetRegionNotificationEndpointRequest 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<NotificationEndpoint>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
GetRegionNotificationEndpointRequest request = new GetRegionNotificationEndpointRequest
{
    Region = "",
    Project = "",
    NotificationEndpoint = "",
};
// Make the request
NotificationEndpoint response = await regionNotificationEndpointsClient.GetAsync(request);

GetAsync(GetRegionNotificationEndpointRequest, CancellationToken)

public virtual Task<NotificationEndpoint> GetAsync(GetRegionNotificationEndpointRequest request, CancellationToken cancellationToken)

Returns the specified NotificationEndpoint resource in the given region.

Parameters
Name	Description
request	GetRegionNotificationEndpointRequest 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<NotificationEndpoint>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
GetRegionNotificationEndpointRequest request = new GetRegionNotificationEndpointRequest
{
    Region = "",
    Project = "",
    NotificationEndpoint = "",
};
// Make the request
NotificationEndpoint response = await regionNotificationEndpointsClient.GetAsync(request);

GetAsync(String, String, String, CallSettings)

public virtual Task<NotificationEndpoint> GetAsync(string project, string region, string notificationEndpoint, CallSettings callSettings = null)

Returns the specified NotificationEndpoint resource in the given region.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpoint	String Name of the NotificationEndpoint resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<NotificationEndpoint>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string notificationEndpoint = "";
// Make the request
NotificationEndpoint response = await regionNotificationEndpointsClient.GetAsync(project, region, notificationEndpoint);

GetAsync(String, String, String, CancellationToken)

public virtual Task<NotificationEndpoint> GetAsync(string project, string region, string notificationEndpoint, CancellationToken cancellationToken)

Returns the specified NotificationEndpoint resource in the given region.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpoint	String Name of the NotificationEndpoint resource to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<NotificationEndpoint>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string notificationEndpoint = "";
// Make the request
NotificationEndpoint response = await regionNotificationEndpointsClient.GetAsync(project, region, notificationEndpoint);

Insert(InsertRegionNotificationEndpointRequest, CallSettings)

public virtual Operation<Operation, Operation> Insert(InsertRegionNotificationEndpointRequest request, CallSettings callSettings = null)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
request	InsertRegionNotificationEndpointRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
InsertRegionNotificationEndpointRequest request = new InsertRegionNotificationEndpointRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NotificationEndpointResource = new NotificationEndpoint(),
};
// Make the request
lro::Operation<Operation, Operation> response = regionNotificationEndpointsClient.Insert(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = regionNotificationEndpointsClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Insert(String, String, NotificationEndpoint, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, string region, NotificationEndpoint notificationEndpointResource, CallSettings callSettings = null)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpointResource	NotificationEndpoint The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
NotificationEndpoint notificationEndpointResource = new NotificationEndpoint();
// Make the request
lro::Operation<Operation, Operation> response = regionNotificationEndpointsClient.Insert(project, region, notificationEndpointResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = regionNotificationEndpointsClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertRegionNotificationEndpointRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertRegionNotificationEndpointRequest request, CallSettings callSettings = null)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
request	InsertRegionNotificationEndpointRequest 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<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
InsertRegionNotificationEndpointRequest request = new InsertRegionNotificationEndpointRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NotificationEndpointResource = new NotificationEndpoint(),
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertRegionNotificationEndpointRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertRegionNotificationEndpointRequest request, CancellationToken cancellationToken)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
request	InsertRegionNotificationEndpointRequest 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<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
InsertRegionNotificationEndpointRequest request = new InsertRegionNotificationEndpointRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NotificationEndpointResource = new NotificationEndpoint(),
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(String, String, NotificationEndpoint, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, NotificationEndpoint notificationEndpointResource, CallSettings callSettings = null)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpointResource	NotificationEndpoint The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
NotificationEndpoint notificationEndpointResource = new NotificationEndpoint();
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.InsertAsync(project, region, notificationEndpointResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(String, String, NotificationEndpoint, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, NotificationEndpoint notificationEndpointResource, CancellationToken cancellationToken)

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
notificationEndpointResource	NotificationEndpoint The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
NotificationEndpoint notificationEndpointResource = new NotificationEndpoint();
// Make the request
lro::Operation<Operation, Operation> response = await regionNotificationEndpointsClient.InsertAsync(project, region, notificationEndpointResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await regionNotificationEndpointsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

List(ListRegionNotificationEndpointsRequest, CallSettings)

public virtual PagedEnumerable<NotificationEndpointList, NotificationEndpoint> List(ListRegionNotificationEndpointsRequest request, CallSettings callSettings = null)

Lists the NotificationEndpoints for a project in the given region.

Parameters
Name	Description
request	ListRegionNotificationEndpointsRequest 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
PagedEnumerable<NotificationEndpointList, NotificationEndpoint>	A pageable sequence of NotificationEndpoint resources.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
ListRegionNotificationEndpointsRequest request = new ListRegionNotificationEndpointsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<NotificationEndpointList, NotificationEndpoint> response = regionNotificationEndpointsClient.List(request);

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

public virtual PagedEnumerable<NotificationEndpointList, NotificationEndpoint> List(string project, string region, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Lists the NotificationEndpoints for a project in the given region.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
pageToken	String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	Nullable<Int32> 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
PagedEnumerable<NotificationEndpointList, NotificationEndpoint>	A pageable sequence of NotificationEndpoint resources.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = RegionNotificationEndpointsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<NotificationEndpointList, NotificationEndpoint> response = regionNotificationEndpointsClient.List(project, region);

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

public virtual PagedAsyncEnumerable<NotificationEndpointList, NotificationEndpoint> ListAsync(ListRegionNotificationEndpointsRequest request, CallSettings callSettings = null)

Lists the NotificationEndpoints for a project in the given region.

Parameters
Name	Description
request	ListRegionNotificationEndpointsRequest 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
PagedAsyncEnumerable<NotificationEndpointList, NotificationEndpoint>	A pageable asynchronous sequence of NotificationEndpoint resources.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
ListRegionNotificationEndpointsRequest request = new ListRegionNotificationEndpointsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<NotificationEndpointList, NotificationEndpoint> response = regionNotificationEndpointsClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((NotificationEndpoint 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((NotificationEndpointList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (NotificationEndpoint 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<NotificationEndpoint> 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 (NotificationEndpoint 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, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<NotificationEndpointList, NotificationEndpoint> ListAsync(string project, string region, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Lists the NotificationEndpoints for a project in the given region.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
pageToken	String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	Nullable<Int32> 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
PagedAsyncEnumerable<NotificationEndpointList, NotificationEndpoint>	A pageable asynchronous sequence of NotificationEndpoint resources.

Example

// Create client
RegionNotificationEndpointsClient regionNotificationEndpointsClient = await RegionNotificationEndpointsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<NotificationEndpointList, NotificationEndpoint> response = regionNotificationEndpointsClient.ListAsync(project, region);

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

PollOnceDelete(String, CallSettings)

public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)

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

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
Operation<Operation, Operation>	The result of polling the operation.

PollOnceDeleteAsync(String, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)

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

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
Task<Operation<Operation, Operation>>	A task representing the result of polling the operation.

PollOnceInsert(String, CallSettings)

public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)

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

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
Operation<Operation, Operation>	The result of polling the operation.

PollOnceInsertAsync(String, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)

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

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
Task<Operation<Operation, Operation>>	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.