public abstract class TargetInstancesClient
TargetInstances client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The TargetInstances API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the TargetInstances 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 TargetInstances scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default TargetInstances scopes are:
DeleteOperationsClient
public virtual OperationsClient DeleteOperationsClient { get; }
The long-running operations client for Delete
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public virtual TargetInstances.TargetInstancesClient GrpcClient { get; }
The underlying gRPC TargetInstances client
Property Value | |
---|---|
Type | Description |
TargetInstances.TargetInstancesClient |
InsertOperationsClient
public virtual OperationsClient InsertOperationsClient { get; }
The long-running operations client for Insert
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
AggregatedList(AggregatedListTargetInstancesRequest, CallSettings)
public virtual PagedEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> AggregatedList(AggregatedListTargetInstancesRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of target instances.
Parameters | |
---|---|
Name | Description |
request | AggregatedListTargetInstancesRequest 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<TargetInstanceAggregatedList, KeyValuePair<String, TargetInstancesScopedList>> | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
AggregatedListTargetInstancesRequest request = new AggregatedListTargetInstancesRequest
{
OrderBy = "",
Project = "",
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> response = targetInstancesClient.AggregatedList(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, TargetInstancesScopedList> 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 (TargetInstanceAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, TargetInstancesScopedList> 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, TargetInstancesScopedList>> 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, TargetInstancesScopedList> 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, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves an aggregated list of target instances.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
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<TargetInstanceAggregatedList, KeyValuePair<String, TargetInstancesScopedList>> | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> response = targetInstancesClient.AggregatedList(project);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, TargetInstancesScopedList> 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 (TargetInstanceAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, TargetInstancesScopedList> 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, TargetInstancesScopedList>> 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, TargetInstancesScopedList> 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(AggregatedListTargetInstancesRequest, CallSettings)
public virtual PagedAsyncEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> AggregatedListAsync(AggregatedListTargetInstancesRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of target instances.
Parameters | |
---|---|
Name | Description |
request | AggregatedListTargetInstancesRequest 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<TargetInstanceAggregatedList, KeyValuePair<String, TargetInstancesScopedList>> | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
AggregatedListTargetInstancesRequest request = new AggregatedListTargetInstancesRequest
{
OrderBy = "",
Project = "",
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> response = targetInstancesClient.AggregatedListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, TargetInstancesScopedList> 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((TargetInstanceAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, TargetInstancesScopedList> 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, TargetInstancesScopedList>> 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, TargetInstancesScopedList> 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, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves an aggregated list of target instances.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
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<TargetInstanceAggregatedList, KeyValuePair<String, TargetInstancesScopedList>> | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<TargetInstanceAggregatedList, KeyValuePair<string, TargetInstancesScopedList>> response = targetInstancesClient.AggregatedListAsync(project);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, TargetInstancesScopedList> 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((TargetInstanceAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, TargetInstancesScopedList> 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, TargetInstancesScopedList>> 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, TargetInstancesScopedList> 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 TargetInstancesClient Create()
Synchronously creates a TargetInstancesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TargetInstancesClientBuilder.
Returns | |
---|---|
Type | Description |
TargetInstancesClient | The created TargetInstancesClient. |
CreateAsync(CancellationToken)
public static Task<TargetInstancesClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a TargetInstancesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TargetInstancesClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<TargetInstancesClient> | The task representing the created TargetInstancesClient. |
Delete(DeleteTargetInstanceRequest, CallSettings)
public virtual Operation<Operation, Operation> Delete(DeleteTargetInstanceRequest request, CallSettings callSettings = null)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
request | DeleteTargetInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
DeleteTargetInstanceRequest request = new DeleteTargetInstanceRequest
{
Zone = "",
RequestId = "",
Project = "",
TargetInstance = "",
};
// Make the request
lro::Operation<Operation, Operation> response = targetInstancesClient.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 = targetInstancesClient.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 zone, string targetInstance, CallSettings callSettings = null)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstance | String Name of the TargetInstance resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string targetInstance = "";
// Make the request
lro::Operation<Operation, Operation> response = targetInstancesClient.Delete(project, zone, targetInstance);
// 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 = targetInstancesClient.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(DeleteTargetInstanceRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteTargetInstanceRequest request, CallSettings callSettings = null)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
request | DeleteTargetInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
DeleteTargetInstanceRequest request = new DeleteTargetInstanceRequest
{
Zone = "",
RequestId = "",
Project = "",
TargetInstance = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.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 targetInstancesClient.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(DeleteTargetInstanceRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteTargetInstanceRequest request, CancellationToken cancellationToken)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
request | DeleteTargetInstanceRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
DeleteTargetInstanceRequest request = new DeleteTargetInstanceRequest
{
Zone = "",
RequestId = "",
Project = "",
TargetInstance = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.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 targetInstancesClient.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 zone, string targetInstance, CallSettings callSettings = null)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstance | String Name of the TargetInstance resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string targetInstance = "";
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.DeleteAsync(project, zone, targetInstance);
// 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 targetInstancesClient.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 zone, string targetInstance, CancellationToken cancellationToken)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstance | String Name of the TargetInstance resource to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string targetInstance = "";
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.DeleteAsync(project, zone, targetInstance);
// 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 targetInstancesClient.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(GetTargetInstanceRequest, CallSettings)
public virtual TargetInstance Get(GetTargetInstanceRequest request, CallSettings callSettings = null)
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetTargetInstanceRequest 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 |
TargetInstance | The RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
GetTargetInstanceRequest request = new GetTargetInstanceRequest
{
Zone = "",
Project = "",
TargetInstance = "",
};
// Make the request
TargetInstance response = targetInstancesClient.Get(request);
Get(String, String, String, CallSettings)
public virtual TargetInstance Get(string project, string zone, string targetInstance, CallSettings callSettings = null)
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstance | String Name of the TargetInstance resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TargetInstance | The RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string targetInstance = "";
// Make the request
TargetInstance response = targetInstancesClient.Get(project, zone, targetInstance);
GetAsync(GetTargetInstanceRequest, CallSettings)
public virtual Task<TargetInstance> GetAsync(GetTargetInstanceRequest request, CallSettings callSettings = null)
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetTargetInstanceRequest 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<TargetInstance> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
GetTargetInstanceRequest request = new GetTargetInstanceRequest
{
Zone = "",
Project = "",
TargetInstance = "",
};
// Make the request
TargetInstance response = await targetInstancesClient.GetAsync(request);
GetAsync(GetTargetInstanceRequest, CancellationToken)
public virtual Task<TargetInstance> GetAsync(GetTargetInstanceRequest request, CancellationToken cancellationToken)
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetTargetInstanceRequest 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<TargetInstance> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
GetTargetInstanceRequest request = new GetTargetInstanceRequest
{
Zone = "",
Project = "",
TargetInstance = "",
};
// Make the request
TargetInstance response = await targetInstancesClient.GetAsync(request);
GetAsync(String, String, String, CallSettings)
public virtual Task<TargetInstance> GetAsync(string project, string zone, string targetInstance, CallSettings callSettings = null)
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstance | String Name of the TargetInstance resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<TargetInstance> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string targetInstance = "";
// Make the request
TargetInstance response = await targetInstancesClient.GetAsync(project, zone, targetInstance);
GetAsync(String, String, String, CancellationToken)
public virtual Task<TargetInstance> GetAsync(string project, string zone, string targetInstance, CancellationToken cancellationToken)
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstance | String Name of the TargetInstance resource to return. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<TargetInstance> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string targetInstance = "";
// Make the request
TargetInstance response = await targetInstancesClient.GetAsync(project, zone, targetInstance);
Insert(InsertTargetInstanceRequest, CallSettings)
public virtual Operation<Operation, Operation> Insert(InsertTargetInstanceRequest request, CallSettings callSettings = null)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertTargetInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
InsertTargetInstanceRequest request = new InsertTargetInstanceRequest
{
Zone = "",
RequestId = "",
Project = "",
TargetInstanceResource = new TargetInstance(),
};
// Make the request
lro::Operation<Operation, Operation> response = targetInstancesClient.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 = targetInstancesClient.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, TargetInstance, CallSettings)
public virtual Operation<Operation, Operation> Insert(string project, string zone, TargetInstance targetInstanceResource, CallSettings callSettings = null)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstanceResource | TargetInstance The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
TargetInstance targetInstanceResource = new TargetInstance();
// Make the request
lro::Operation<Operation, Operation> response = targetInstancesClient.Insert(project, zone, targetInstanceResource);
// 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 = targetInstancesClient.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(InsertTargetInstanceRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertTargetInstanceRequest request, CallSettings callSettings = null)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertTargetInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
InsertTargetInstanceRequest request = new InsertTargetInstanceRequest
{
Zone = "",
RequestId = "",
Project = "",
TargetInstanceResource = new TargetInstance(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.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 targetInstancesClient.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(InsertTargetInstanceRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertTargetInstanceRequest request, CancellationToken cancellationToken)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertTargetInstanceRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
InsertTargetInstanceRequest request = new InsertTargetInstanceRequest
{
Zone = "",
RequestId = "",
Project = "",
TargetInstanceResource = new TargetInstance(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.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 targetInstancesClient.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, TargetInstance, CallSettings)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string zone, TargetInstance targetInstanceResource, CallSettings callSettings = null)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstanceResource | TargetInstance The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
TargetInstance targetInstanceResource = new TargetInstance();
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.InsertAsync(project, zone, targetInstanceResource);
// 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 targetInstancesClient.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, TargetInstance, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string zone, TargetInstance targetInstanceResource, CancellationToken cancellationToken)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
targetInstanceResource | TargetInstance The body resource for this request |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
TargetInstance targetInstanceResource = new TargetInstance();
// Make the request
lro::Operation<Operation, Operation> response = await targetInstancesClient.InsertAsync(project, zone, targetInstanceResource);
// 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 targetInstancesClient.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(ListTargetInstancesRequest, CallSettings)
public virtual PagedEnumerable<TargetInstanceList, TargetInstance> List(ListTargetInstancesRequest request, CallSettings callSettings = null)
Retrieves a list of TargetInstance resources available to the specified project and zone.
Parameters | |
---|---|
Name | Description |
request | ListTargetInstancesRequest 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<TargetInstanceList, TargetInstance> | A pageable sequence of TargetInstance resources. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
ListTargetInstancesRequest request = new ListTargetInstancesRequest
{
Zone = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<TargetInstanceList, TargetInstance> response = targetInstancesClient.List(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (TargetInstance 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 (TargetInstanceList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetInstance 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<TargetInstance> 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 (TargetInstance item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
List(String, String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<TargetInstanceList, TargetInstance> List(string project, string zone, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves a list of TargetInstance resources available to the specified project and zone.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
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<TargetInstanceList, TargetInstance> | A pageable sequence of TargetInstance resources. |
// Create client
TargetInstancesClient targetInstancesClient = TargetInstancesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedEnumerable<TargetInstanceList, TargetInstance> response = targetInstancesClient.List(project, zone);
// Iterate over all response items, lazily performing RPCs as required
foreach (TargetInstance 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 (TargetInstanceList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetInstance 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<TargetInstance> 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 (TargetInstance 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(ListTargetInstancesRequest, CallSettings)
public virtual PagedAsyncEnumerable<TargetInstanceList, TargetInstance> ListAsync(ListTargetInstancesRequest request, CallSettings callSettings = null)
Retrieves a list of TargetInstance resources available to the specified project and zone.
Parameters | |
---|---|
Name | Description |
request | ListTargetInstancesRequest 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<TargetInstanceList, TargetInstance> | A pageable asynchronous sequence of TargetInstance resources. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
ListTargetInstancesRequest request = new ListTargetInstancesRequest
{
Zone = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<TargetInstanceList, TargetInstance> response = targetInstancesClient.ListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TargetInstance 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((TargetInstanceList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetInstance 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<TargetInstance> 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 (TargetInstance item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAsync(String, String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<TargetInstanceList, TargetInstance> ListAsync(string project, string zone, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves a list of TargetInstance resources available to the specified project and zone.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
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<TargetInstanceList, TargetInstance> | A pageable asynchronous sequence of TargetInstance resources. |
// Create client
TargetInstancesClient targetInstancesClient = await TargetInstancesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedAsyncEnumerable<TargetInstanceList, TargetInstance> response = targetInstancesClient.ListAsync(project, zone);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TargetInstance 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((TargetInstanceList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetInstance 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<TargetInstance> 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 (TargetInstance 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 |
Operation<Operation, Operation> | The result of polling the operation. |
PollOnceDeleteAsync(String, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of Delete
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A task representing the result of polling the operation. |
PollOnceInsert(String, CallSettings)
public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of Insert
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The result of polling the operation. |
PollOnceInsertAsync(String, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of Insert
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A task representing the result of polling the operation. |
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task | A task representing the asynchronous shutdown operation. |
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.