public abstract class GlobalOperationsClient
Reference documentation and code samples for the Compute Engine v1 API class GlobalOperationsClient.
GlobalOperations client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The GlobalOperations API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the GlobalOperations 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 GlobalOperations scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default GlobalOperations scopes are:
GrpcClient
public virtual GlobalOperations.GlobalOperationsClient GrpcClient { get; }
The underlying gRPC GlobalOperations client
Property Value | |
---|---|
Type | Description |
GlobalOperationsGlobalOperationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
AggregatedList(AggregatedListGlobalOperationsRequest, CallSettings)
public virtual PagedEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> AggregatedList(AggregatedListGlobalOperationsRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListGlobalOperationsRequest 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 |
PagedEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList |
A pageable sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
AggregatedListGlobalOperationsRequest request = new AggregatedListGlobalOperationsRequest
{
OrderBy = "",
Project = "",
ServiceProjectNumber = 0L,
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> response = globalOperationsClient.AggregatedList(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, OperationsScopedList> 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 (OperationAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, OperationsScopedList> 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<KeyValuePair<string, OperationsScopedList>> 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 (KeyValuePair<string, OperationsScopedList> 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;
AggregatedList(string, string, int?, CallSettings)
public virtual PagedEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for 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 |
PagedEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList |
A pageable sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> response = globalOperationsClient.AggregatedList(project);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, OperationsScopedList> 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 (OperationAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, OperationsScopedList> 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<KeyValuePair<string, OperationsScopedList>> 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 (KeyValuePair<string, OperationsScopedList> 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;
AggregatedListAsync(AggregatedListGlobalOperationsRequest, CallSettings)
public virtual PagedAsyncEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> AggregatedListAsync(AggregatedListGlobalOperationsRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListGlobalOperationsRequest 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 |
PagedAsyncEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList |
A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
AggregatedListGlobalOperationsRequest request = new AggregatedListGlobalOperationsRequest
{
OrderBy = "",
Project = "",
ServiceProjectNumber = 0L,
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> response = globalOperationsClient.AggregatedListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, OperationsScopedList> 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((OperationAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, OperationsScopedList> 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<KeyValuePair<string, OperationsScopedList>> 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 (KeyValuePair<string, OperationsScopedList> 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;
AggregatedListAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for 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 |
PagedAsyncEnumerableOperationAggregatedListKeyValuePairstringOperationsScopedList |
A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<OperationAggregatedList, KeyValuePair<string, OperationsScopedList>> response = globalOperationsClient.AggregatedListAsync(project);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, OperationsScopedList> 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((OperationAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, OperationsScopedList> 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<KeyValuePair<string, OperationsScopedList>> 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 (KeyValuePair<string, OperationsScopedList> 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;
Create()
public static GlobalOperationsClient Create()
Synchronously creates a GlobalOperationsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GlobalOperationsClientBuilder.
Returns | |
---|---|
Type | Description |
GlobalOperationsClient |
The created GlobalOperationsClient. |
CreateAsync(CancellationToken)
public static Task<GlobalOperationsClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a GlobalOperationsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GlobalOperationsClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken |
CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskGlobalOperationsClient |
The task representing the created GlobalOperationsClient. |
Delete(DeleteGlobalOperationRequest, CallSettings)
public virtual DeleteGlobalOperationResponse Delete(DeleteGlobalOperationRequest request, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request |
DeleteGlobalOperationRequest 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 |
DeleteGlobalOperationResponse |
The RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
DeleteGlobalOperationRequest request = new DeleteGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
DeleteGlobalOperationResponse response = globalOperationsClient.Delete(request);
Delete(string, string, CallSettings)
public virtual DeleteGlobalOperationResponse Delete(string project, string operation, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to delete, or its unique numeric identifier. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeleteGlobalOperationResponse |
The RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
DeleteGlobalOperationResponse response = globalOperationsClient.Delete(project, operation);
DeleteAsync(DeleteGlobalOperationRequest, CallSettings)
public virtual Task<DeleteGlobalOperationResponse> DeleteAsync(DeleteGlobalOperationRequest request, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request |
DeleteGlobalOperationRequest 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 |
TaskDeleteGlobalOperationResponse |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
DeleteGlobalOperationRequest request = new DeleteGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
DeleteGlobalOperationResponse response = await globalOperationsClient.DeleteAsync(request);
DeleteAsync(DeleteGlobalOperationRequest, CancellationToken)
public virtual Task<DeleteGlobalOperationResponse> DeleteAsync(DeleteGlobalOperationRequest request, CancellationToken cancellationToken)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request |
DeleteGlobalOperationRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeleteGlobalOperationResponse |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
DeleteGlobalOperationRequest request = new DeleteGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
DeleteGlobalOperationResponse response = await globalOperationsClient.DeleteAsync(request);
DeleteAsync(string, string, CallSettings)
public virtual Task<DeleteGlobalOperationResponse> DeleteAsync(string project, string operation, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to delete, or its unique numeric identifier. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDeleteGlobalOperationResponse |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
DeleteGlobalOperationResponse response = await globalOperationsClient.DeleteAsync(project, operation);
DeleteAsync(string, string, CancellationToken)
public virtual Task<DeleteGlobalOperationResponse> DeleteAsync(string project, string operation, CancellationToken cancellationToken)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to delete, or its unique numeric identifier. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskDeleteGlobalOperationResponse |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
DeleteGlobalOperationResponse response = await globalOperationsClient.DeleteAsync(project, operation);
Get(GetGlobalOperationRequest, CallSettings)
public virtual Operation Get(GetGlobalOperationRequest request, CallSettings callSettings = null)
Retrieves the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request |
GetGlobalOperationRequest 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 |
The RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
GetGlobalOperationRequest request = new GetGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
Operation response = globalOperationsClient.Get(request);
Get(string, string, CallSettings)
public virtual Operation Get(string project, string operation, CallSettings callSettings = null)
Retrieves the specified Operations resource.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to return, or its unique numeric identifier. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation |
The RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
Operation response = globalOperationsClient.Get(project, operation);
GetAsync(GetGlobalOperationRequest, CallSettings)
public virtual Task<Operation> GetAsync(GetGlobalOperationRequest request, CallSettings callSettings = null)
Retrieves the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request |
GetGlobalOperationRequest 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 |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
GetGlobalOperationRequest request = new GetGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
Operation response = await globalOperationsClient.GetAsync(request);
GetAsync(GetGlobalOperationRequest, CancellationToken)
public virtual Task<Operation> GetAsync(GetGlobalOperationRequest request, CancellationToken cancellationToken)
Retrieves the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request |
GetGlobalOperationRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
GetGlobalOperationRequest request = new GetGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
Operation response = await globalOperationsClient.GetAsync(request);
GetAsync(string, string, CallSettings)
public virtual Task<Operation> GetAsync(string project, string operation, CallSettings callSettings = null)
Retrieves the specified Operations resource.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to return, or its unique numeric identifier. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
Operation response = await globalOperationsClient.GetAsync(project, operation);
GetAsync(string, string, CancellationToken)
public virtual Task<Operation> GetAsync(string project, string operation, CancellationToken cancellationToken)
Retrieves the specified Operations resource.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to return, or its unique numeric identifier. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
Operation response = await globalOperationsClient.GetAsync(project, operation);
List(ListGlobalOperationsRequest, CallSettings)
public virtual PagedEnumerable<OperationList, Operation> List(ListGlobalOperationsRequest request, CallSettings callSettings = null)
Retrieves a list of Operation resources contained within the specified project.
Parameters | |
---|---|
Name | Description |
request |
ListGlobalOperationsRequest 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 |
PagedEnumerableOperationListOperation |
A pageable sequence of Operation resources. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
ListGlobalOperationsRequest request = new ListGlobalOperationsRequest
{
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<OperationList, Operation> response = globalOperationsClient.List(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Operation 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 (OperationList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Operation 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<Operation> 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 (Operation 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<OperationList, Operation> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of Operation resources contained within 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 |
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 |
PagedEnumerableOperationListOperation |
A pageable sequence of Operation resources. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<OperationList, Operation> response = globalOperationsClient.List(project);
// Iterate over all response items, lazily performing RPCs as required
foreach (Operation 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 (OperationList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Operation 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<Operation> 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 (Operation 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(ListGlobalOperationsRequest, CallSettings)
public virtual PagedAsyncEnumerable<OperationList, Operation> ListAsync(ListGlobalOperationsRequest request, CallSettings callSettings = null)
Retrieves a list of Operation resources contained within the specified project.
Parameters | |
---|---|
Name | Description |
request |
ListGlobalOperationsRequest 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 |
PagedAsyncEnumerableOperationListOperation |
A pageable asynchronous sequence of Operation resources. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
ListGlobalOperationsRequest request = new ListGlobalOperationsRequest
{
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<OperationList, Operation> response = globalOperationsClient.ListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation 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((OperationList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Operation 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<Operation> 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 (Operation 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<OperationList, Operation> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of Operation resources contained within 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 |
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 |
PagedAsyncEnumerableOperationListOperation |
A pageable asynchronous sequence of Operation resources. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<OperationList, Operation> response = globalOperationsClient.ListAsync(project);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation 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((OperationList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Operation 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<Operation> 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 (Operation 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. |
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.
Wait(WaitGlobalOperationRequest, CallSettings)
public virtual Operation Wait(WaitGlobalOperationRequest request, CallSettings callSettings = null)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
Parameters | |
---|---|
Name | Description |
request |
WaitGlobalOperationRequest 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 |
The RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
WaitGlobalOperationRequest request = new WaitGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
Operation response = globalOperationsClient.Wait(request);
Wait(string, string, CallSettings)
public virtual Operation Wait(string project, string operation, CallSettings callSettings = null)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to return, or its unique numeric identifier. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation |
The RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = GlobalOperationsClient.Create();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
Operation response = globalOperationsClient.Wait(project, operation);
WaitAsync(WaitGlobalOperationRequest, CallSettings)
public virtual Task<Operation> WaitAsync(WaitGlobalOperationRequest request, CallSettings callSettings = null)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
Parameters | |
---|---|
Name | Description |
request |
WaitGlobalOperationRequest 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 |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
WaitGlobalOperationRequest request = new WaitGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
Operation response = await globalOperationsClient.WaitAsync(request);
WaitAsync(WaitGlobalOperationRequest, CancellationToken)
public virtual Task<Operation> WaitAsync(WaitGlobalOperationRequest request, CancellationToken cancellationToken)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
Parameters | |
---|---|
Name | Description |
request |
WaitGlobalOperationRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
WaitGlobalOperationRequest request = new WaitGlobalOperationRequest
{
Operation = "",
Project = "",
};
// Make the request
Operation response = await globalOperationsClient.WaitAsync(request);
WaitAsync(string, string, CallSettings)
public virtual Task<Operation> WaitAsync(string project, string operation, CallSettings callSettings = null)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to return, or its unique numeric identifier. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
Operation response = await globalOperationsClient.WaitAsync(project, operation);
WaitAsync(string, string, CancellationToken)
public virtual Task<Operation> WaitAsync(string project, string operation, CancellationToken cancellationToken)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
operation |
string Name of the Operations resource to return, or its unique numeric identifier. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperation |
A Task containing the RPC response. |
// Create client
GlobalOperationsClient globalOperationsClient = await GlobalOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string operation = "";
// Make the request
Operation response = await globalOperationsClient.WaitAsync(project, operation);