public abstract class RegionNotificationEndpointsClient
Reference documentation and code samples for the Compute Engine v1 API class RegionNotificationEndpointsClient.
RegionNotificationEndpoints client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
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 |
IReadOnlyListstring |
The default RegionNotificationEndpoints scopes are:
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 |
RegionNotificationEndpointsRegionNotificationEndpointsClient |
InsertOperationsClient
public virtual OperationsClient InsertOperationsClient { get; }
The long-running operations client for Insert
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
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)
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 |
TaskRegionNotificationEndpointsClient |
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 |
OperationOperationOperation |
The RPC response. |
// 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 |
OperationOperationOperation |
The RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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. |
// 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. |
// 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 |
TaskNotificationEndpoint |
A Task containing the RPC response. |
// 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 |
TaskNotificationEndpoint |
A Task containing the RPC response. |
// 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 |
TaskNotificationEndpoint |
A Task containing the RPC response. |
// 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 |
TaskNotificationEndpoint |
A Task containing the RPC response. |
// 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 |
OperationOperationOperation |
The RPC response. |
// 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 |
OperationOperationOperation |
The RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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 |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// 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 |
PagedEnumerableNotificationEndpointListNotificationEndpoint |
A pageable sequence of NotificationEndpoint resources. |
// 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, int?, CallSettings)
public virtual PagedEnumerable<NotificationEndpointList, NotificationEndpoint> List(string project, string region, string pageToken = null, int? pageSize = null, 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 |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableNotificationEndpointListNotificationEndpoint |
A pageable sequence of NotificationEndpoint resources. |
// 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 |
PagedAsyncEnumerableNotificationEndpointListNotificationEndpoint |
A pageable asynchronous sequence of NotificationEndpoint resources. |
// 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, int?, CallSettings)
public virtual PagedAsyncEnumerable<NotificationEndpointList, NotificationEndpoint> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, 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 |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableNotificationEndpointListNotificationEndpoint |
A pageable asynchronous sequence of NotificationEndpoint resources. |
// 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 |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation |
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 |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation |
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 |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation |
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 |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation |
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. |
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.