public abstract class GlobalOrganizationOperationsClient
GlobalOrganizationOperations client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The GlobalOrganizationOperations API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the GlobalOrganizationOperations 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 GlobalOrganizationOperations scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default GlobalOrganizationOperations scopes are:
GrpcClient
public virtual GlobalOrganizationOperations.GlobalOrganizationOperationsClient GrpcClient { get; }
The underlying gRPC GlobalOrganizationOperations client
Property Value | |
---|---|
Type | Description |
GlobalOrganizationOperations.GlobalOrganizationOperationsClient |
Methods
Create()
public static GlobalOrganizationOperationsClient Create()
Synchronously creates a GlobalOrganizationOperationsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GlobalOrganizationOperationsClientBuilder.
Returns | |
---|---|
Type | Description |
GlobalOrganizationOperationsClient | The created GlobalOrganizationOperationsClient. |
CreateAsync(CancellationToken)
public static Task<GlobalOrganizationOperationsClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a GlobalOrganizationOperationsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GlobalOrganizationOperationsClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<GlobalOrganizationOperationsClient> | The task representing the created GlobalOrganizationOperationsClient. |
Delete(DeleteGlobalOrganizationOperationRequest, CallSettings)
public virtual DeleteGlobalOrganizationOperationResponse Delete(DeleteGlobalOrganizationOperationRequest request, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request | DeleteGlobalOrganizationOperationRequest 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 |
DeleteGlobalOrganizationOperationResponse | The RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = GlobalOrganizationOperationsClient.Create();
// Initialize request argument(s)
DeleteGlobalOrganizationOperationRequest request = new DeleteGlobalOrganizationOperationRequest
{
Operation = "",
ParentId = "",
};
// Make the request
DeleteGlobalOrganizationOperationResponse response = globalOrganizationOperationsClient.Delete(request);
Delete(String, CallSettings)
public virtual DeleteGlobalOrganizationOperationResponse Delete(string operation, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
operation | String Name of the Operations resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeleteGlobalOrganizationOperationResponse | The RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = GlobalOrganizationOperationsClient.Create();
// Initialize request argument(s)
string operation = "";
// Make the request
DeleteGlobalOrganizationOperationResponse response = globalOrganizationOperationsClient.Delete(operation);
DeleteAsync(DeleteGlobalOrganizationOperationRequest, CallSettings)
public virtual Task<DeleteGlobalOrganizationOperationResponse> DeleteAsync(DeleteGlobalOrganizationOperationRequest request, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request | DeleteGlobalOrganizationOperationRequest 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<DeleteGlobalOrganizationOperationResponse> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
DeleteGlobalOrganizationOperationRequest request = new DeleteGlobalOrganizationOperationRequest
{
Operation = "",
ParentId = "",
};
// Make the request
DeleteGlobalOrganizationOperationResponse response = await globalOrganizationOperationsClient.DeleteAsync(request);
DeleteAsync(DeleteGlobalOrganizationOperationRequest, CancellationToken)
public virtual Task<DeleteGlobalOrganizationOperationResponse> DeleteAsync(DeleteGlobalOrganizationOperationRequest request, CancellationToken cancellationToken)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
request | DeleteGlobalOrganizationOperationRequest 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<DeleteGlobalOrganizationOperationResponse> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
DeleteGlobalOrganizationOperationRequest request = new DeleteGlobalOrganizationOperationRequest
{
Operation = "",
ParentId = "",
};
// Make the request
DeleteGlobalOrganizationOperationResponse response = await globalOrganizationOperationsClient.DeleteAsync(request);
DeleteAsync(String, CallSettings)
public virtual Task<DeleteGlobalOrganizationOperationResponse> DeleteAsync(string operation, CallSettings callSettings = null)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
operation | String Name of the Operations resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<DeleteGlobalOrganizationOperationResponse> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
string operation = "";
// Make the request
DeleteGlobalOrganizationOperationResponse response = await globalOrganizationOperationsClient.DeleteAsync(operation);
DeleteAsync(String, CancellationToken)
public virtual Task<DeleteGlobalOrganizationOperationResponse> DeleteAsync(string operation, CancellationToken cancellationToken)
Deletes the specified Operations resource.
Parameters | |
---|---|
Name | Description |
operation | String Name of the Operations resource to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<DeleteGlobalOrganizationOperationResponse> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
string operation = "";
// Make the request
DeleteGlobalOrganizationOperationResponse response = await globalOrganizationOperationsClient.DeleteAsync(operation);
Get(GetGlobalOrganizationOperationRequest, CallSettings)
public virtual Operation Get(GetGlobalOrganizationOperationRequest request, CallSettings callSettings = null)
Retrieves the specified Operations resource. Gets a list of operations by making a list()
request.
Parameters | |
---|---|
Name | Description |
request | GetGlobalOrganizationOperationRequest 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
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = GlobalOrganizationOperationsClient.Create();
// Initialize request argument(s)
GetGlobalOrganizationOperationRequest request = new GetGlobalOrganizationOperationRequest
{
Operation = "",
ParentId = "",
};
// Make the request
Operation response = globalOrganizationOperationsClient.Get(request);
Get(String, CallSettings)
public virtual Operation Get(string operation, CallSettings callSettings = null)
Retrieves the specified Operations resource. Gets a list of operations by making a list()
request.
Parameters | |
---|---|
Name | Description |
operation | String Name of the Operations resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation | The RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = GlobalOrganizationOperationsClient.Create();
// Initialize request argument(s)
string operation = "";
// Make the request
Operation response = globalOrganizationOperationsClient.Get(operation);
GetAsync(GetGlobalOrganizationOperationRequest, CallSettings)
public virtual Task<Operation> GetAsync(GetGlobalOrganizationOperationRequest request, CallSettings callSettings = null)
Retrieves the specified Operations resource. Gets a list of operations by making a list()
request.
Parameters | |
---|---|
Name | Description |
request | GetGlobalOrganizationOperationRequest 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> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
GetGlobalOrganizationOperationRequest request = new GetGlobalOrganizationOperationRequest
{
Operation = "",
ParentId = "",
};
// Make the request
Operation response = await globalOrganizationOperationsClient.GetAsync(request);
GetAsync(GetGlobalOrganizationOperationRequest, CancellationToken)
public virtual Task<Operation> GetAsync(GetGlobalOrganizationOperationRequest request, CancellationToken cancellationToken)
Retrieves the specified Operations resource. Gets a list of operations by making a list()
request.
Parameters | |
---|---|
Name | Description |
request | GetGlobalOrganizationOperationRequest 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> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
GetGlobalOrganizationOperationRequest request = new GetGlobalOrganizationOperationRequest
{
Operation = "",
ParentId = "",
};
// Make the request
Operation response = await globalOrganizationOperationsClient.GetAsync(request);
GetAsync(String, CallSettings)
public virtual Task<Operation> GetAsync(string operation, CallSettings callSettings = null)
Retrieves the specified Operations resource. Gets a list of operations by making a list()
request.
Parameters | |
---|---|
Name | Description |
operation | String Name of the Operations resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
string operation = "";
// Make the request
Operation response = await globalOrganizationOperationsClient.GetAsync(operation);
GetAsync(String, CancellationToken)
public virtual Task<Operation> GetAsync(string operation, CancellationToken cancellationToken)
Retrieves the specified Operations resource. Gets a list of operations by making a list()
request.
Parameters | |
---|---|
Name | Description |
operation | String Name of the Operations resource to return. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation> | A Task containing the RPC response. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
string operation = "";
// Make the request
Operation response = await globalOrganizationOperationsClient.GetAsync(operation);
List(ListGlobalOrganizationOperationsRequest, CallSettings)
public virtual PagedEnumerable<OperationList, Operation> List(ListGlobalOrganizationOperationsRequest request, CallSettings callSettings = null)
Retrieves a list of Operation resources contained within the specified organization.
Parameters | |
---|---|
Name | Description |
request | ListGlobalOrganizationOperationsRequest 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<OperationList, Operation> | A pageable sequence of Operation resources. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = GlobalOrganizationOperationsClient.Create();
// Initialize request argument(s)
ListGlobalOrganizationOperationsRequest request = new ListGlobalOrganizationOperationsRequest
{
OrderBy = "",
Filter = "",
ParentId = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<OperationList, Operation> response = globalOrganizationOperationsClient.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, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<OperationList, Operation> List(string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves a list of Operation resources contained within the specified organization.
Parameters | |
---|---|
Name | Description |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedEnumerable<OperationList, Operation> | A pageable sequence of Operation resources. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = GlobalOrganizationOperationsClient.Create();
// Make the request
PagedEnumerable<OperationList, Operation> response = globalOrganizationOperationsClient.List();
// 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(ListGlobalOrganizationOperationsRequest, CallSettings)
public virtual PagedAsyncEnumerable<OperationList, Operation> ListAsync(ListGlobalOrganizationOperationsRequest request, CallSettings callSettings = null)
Retrieves a list of Operation resources contained within the specified organization.
Parameters | |
---|---|
Name | Description |
request | ListGlobalOrganizationOperationsRequest 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<OperationList, Operation> | A pageable asynchronous sequence of Operation resources. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Initialize request argument(s)
ListGlobalOrganizationOperationsRequest request = new ListGlobalOrganizationOperationsRequest
{
OrderBy = "",
Filter = "",
ParentId = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<OperationList, Operation> response = globalOrganizationOperationsClient.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, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<OperationList, Operation> ListAsync(string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves a list of Operation resources contained within the specified organization.
Parameters | |
---|---|
Name | Description |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> 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 |
PagedAsyncEnumerable<OperationList, Operation> | A pageable asynchronous sequence of Operation resources. |
// Create client
GlobalOrganizationOperationsClient globalOrganizationOperationsClient = await GlobalOrganizationOperationsClient.CreateAsync();
// Make the request
PagedAsyncEnumerable<OperationList, Operation> response = globalOrganizationOperationsClient.ListAsync();
// 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.