public abstract class RegionTargetTcpProxiesClient
Reference documentation and code samples for the Compute Engine v1 API class RegionTargetTcpProxiesClient.
RegionTargetTcpProxies client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The RegionTargetTcpProxies API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the RegionTargetTcpProxies 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 RegionTargetTcpProxies scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default RegionTargetTcpProxies scopes are:
DeleteOperationsClient
public virtual OperationsClient DeleteOperationsClient { get; }
The long-running operations client for Delete
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public virtual RegionTargetTcpProxies.RegionTargetTcpProxiesClient GrpcClient { get; }
The underlying gRPC RegionTargetTcpProxies client
Property Value | |
---|---|
Type | Description |
RegionTargetTcpProxiesRegionTargetTcpProxiesClient |
InsertOperationsClient
public virtual OperationsClient InsertOperationsClient { get; }
The long-running operations client for Insert
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
Create()
public static RegionTargetTcpProxiesClient Create()
Synchronously creates a RegionTargetTcpProxiesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use RegionTargetTcpProxiesClientBuilder.
Returns | |
---|---|
Type | Description |
RegionTargetTcpProxiesClient | The created RegionTargetTcpProxiesClient. |
CreateAsync(CancellationToken)
public static Task<RegionTargetTcpProxiesClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a RegionTargetTcpProxiesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use RegionTargetTcpProxiesClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskRegionTargetTcpProxiesClient | The task representing the created RegionTargetTcpProxiesClient. |
Delete(DeleteRegionTargetTcpProxyRequest, CallSettings)
public virtual Operation<Operation, Operation> Delete(DeleteRegionTargetTcpProxyRequest request, CallSettings callSettings = null)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request | DeleteRegionTargetTcpProxyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation | The RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
DeleteRegionTargetTcpProxyRequest request = new DeleteRegionTargetTcpProxyRequest
{
RequestId = "",
Region = "",
Project = "",
TargetTcpProxy = "",
};
// Make the request
lro::Operation<Operation, Operation> response = regionTargetTcpProxiesClient.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 = regionTargetTcpProxiesClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Delete(string, string, string, CallSettings)
public virtual Operation<Operation, Operation> Delete(string project, string region, string targetTcpProxy, CallSettings callSettings = null)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxy | string Name of the TargetTcpProxy resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation | The RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetTcpProxy = "";
// Make the request
lro::Operation<Operation, Operation> response = regionTargetTcpProxiesClient.Delete(project, region, targetTcpProxy);
// 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 = regionTargetTcpProxiesClient.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(DeleteRegionTargetTcpProxyRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteRegionTargetTcpProxyRequest request, CallSettings callSettings = null)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request | DeleteRegionTargetTcpProxyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionTargetTcpProxyRequest request = new DeleteRegionTargetTcpProxyRequest
{
RequestId = "",
Region = "",
Project = "",
TargetTcpProxy = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.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 regionTargetTcpProxiesClient.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(DeleteRegionTargetTcpProxyRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteRegionTargetTcpProxyRequest request, CancellationToken cancellationToken)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request | DeleteRegionTargetTcpProxyRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionTargetTcpProxyRequest request = new DeleteRegionTargetTcpProxyRequest
{
RequestId = "",
Region = "",
Project = "",
TargetTcpProxy = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.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 regionTargetTcpProxiesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(string, string, string, CallSettings)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string targetTcpProxy, CallSettings callSettings = null)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxy | string Name of the TargetTcpProxy resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetTcpProxy = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.DeleteAsync(project, region, targetTcpProxy);
// 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 regionTargetTcpProxiesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(string, string, string, CancellationToken)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string targetTcpProxy, CancellationToken cancellationToken)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxy | string Name of the TargetTcpProxy resource to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetTcpProxy = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.DeleteAsync(project, region, targetTcpProxy);
// 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 regionTargetTcpProxiesClient.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(GetRegionTargetTcpProxyRequest, CallSettings)
public virtual TargetTcpProxy Get(GetRegionTargetTcpProxyRequest request, CallSettings callSettings = null)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request | GetRegionTargetTcpProxyRequest 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 |
TargetTcpProxy | The RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
GetRegionTargetTcpProxyRequest request = new GetRegionTargetTcpProxyRequest
{
Region = "",
Project = "",
TargetTcpProxy = "",
};
// Make the request
TargetTcpProxy response = regionTargetTcpProxiesClient.Get(request);
Get(string, string, string, CallSettings)
public virtual TargetTcpProxy Get(string project, string region, string targetTcpProxy, CallSettings callSettings = null)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxy | string Name of the TargetTcpProxy resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TargetTcpProxy | The RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetTcpProxy = "";
// Make the request
TargetTcpProxy response = regionTargetTcpProxiesClient.Get(project, region, targetTcpProxy);
GetAsync(GetRegionTargetTcpProxyRequest, CallSettings)
public virtual Task<TargetTcpProxy> GetAsync(GetRegionTargetTcpProxyRequest request, CallSettings callSettings = null)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request | GetRegionTargetTcpProxyRequest 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 |
TaskTargetTcpProxy | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
GetRegionTargetTcpProxyRequest request = new GetRegionTargetTcpProxyRequest
{
Region = "",
Project = "",
TargetTcpProxy = "",
};
// Make the request
TargetTcpProxy response = await regionTargetTcpProxiesClient.GetAsync(request);
GetAsync(GetRegionTargetTcpProxyRequest, CancellationToken)
public virtual Task<TargetTcpProxy> GetAsync(GetRegionTargetTcpProxyRequest request, CancellationToken cancellationToken)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request | GetRegionTargetTcpProxyRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTargetTcpProxy | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
GetRegionTargetTcpProxyRequest request = new GetRegionTargetTcpProxyRequest
{
Region = "",
Project = "",
TargetTcpProxy = "",
};
// Make the request
TargetTcpProxy response = await regionTargetTcpProxiesClient.GetAsync(request);
GetAsync(string, string, string, CallSettings)
public virtual Task<TargetTcpProxy> GetAsync(string project, string region, string targetTcpProxy, CallSettings callSettings = null)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxy | string Name of the TargetTcpProxy resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTargetTcpProxy | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetTcpProxy = "";
// Make the request
TargetTcpProxy response = await regionTargetTcpProxiesClient.GetAsync(project, region, targetTcpProxy);
GetAsync(string, string, string, CancellationToken)
public virtual Task<TargetTcpProxy> GetAsync(string project, string region, string targetTcpProxy, CancellationToken cancellationToken)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxy | string Name of the TargetTcpProxy resource to return. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTargetTcpProxy | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetTcpProxy = "";
// Make the request
TargetTcpProxy response = await regionTargetTcpProxiesClient.GetAsync(project, region, targetTcpProxy);
Insert(InsertRegionTargetTcpProxyRequest, CallSettings)
public virtual Operation<Operation, Operation> Insert(InsertRegionTargetTcpProxyRequest request, CallSettings callSettings = null)
Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertRegionTargetTcpProxyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation | The RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
InsertRegionTargetTcpProxyRequest request = new InsertRegionTargetTcpProxyRequest
{
RequestId = "",
Region = "",
TargetTcpProxyResource = new TargetTcpProxy(),
Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = regionTargetTcpProxiesClient.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 = regionTargetTcpProxiesClient.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, TargetTcpProxy, CallSettings)
public virtual Operation<Operation, Operation> Insert(string project, string region, TargetTcpProxy targetTcpProxyResource, CallSettings callSettings = null)
Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxyResource | TargetTcpProxy The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation | The RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
TargetTcpProxy targetTcpProxyResource = new TargetTcpProxy();
// Make the request
lro::Operation<Operation, Operation> response = regionTargetTcpProxiesClient.Insert(project, region, targetTcpProxyResource);
// 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 = regionTargetTcpProxiesClient.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(InsertRegionTargetTcpProxyRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertRegionTargetTcpProxyRequest request, CallSettings callSettings = null)
Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertRegionTargetTcpProxyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
InsertRegionTargetTcpProxyRequest request = new InsertRegionTargetTcpProxyRequest
{
RequestId = "",
Region = "",
TargetTcpProxyResource = new TargetTcpProxy(),
Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.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 regionTargetTcpProxiesClient.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(InsertRegionTargetTcpProxyRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertRegionTargetTcpProxyRequest request, CancellationToken cancellationToken)
Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertRegionTargetTcpProxyRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
InsertRegionTargetTcpProxyRequest request = new InsertRegionTargetTcpProxyRequest
{
RequestId = "",
Region = "",
TargetTcpProxyResource = new TargetTcpProxy(),
Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.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 regionTargetTcpProxiesClient.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, TargetTcpProxy, CallSettings)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, TargetTcpProxy targetTcpProxyResource, CallSettings callSettings = null)
Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxyResource | TargetTcpProxy The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
TargetTcpProxy targetTcpProxyResource = new TargetTcpProxy();
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.InsertAsync(project, region, targetTcpProxyResource);
// 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 regionTargetTcpProxiesClient.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, TargetTcpProxy, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, TargetTcpProxy targetTcpProxyResource, CancellationToken cancellationToken)
Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
targetTcpProxyResource | TargetTcpProxy The body resource for this request |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
TargetTcpProxy targetTcpProxyResource = new TargetTcpProxy();
// Make the request
lro::Operation<Operation, Operation> response = await regionTargetTcpProxiesClient.InsertAsync(project, region, targetTcpProxyResource);
// 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 regionTargetTcpProxiesClient.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(ListRegionTargetTcpProxiesRequest, CallSettings)
public virtual PagedEnumerable<TargetTcpProxyList, TargetTcpProxy> List(ListRegionTargetTcpProxiesRequest request, CallSettings callSettings = null)
Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
Parameters | |
---|---|
Name | Description |
request | ListRegionTargetTcpProxiesRequest 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 |
PagedEnumerableTargetTcpProxyListTargetTcpProxy | A pageable sequence of TargetTcpProxy resources. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
ListRegionTargetTcpProxiesRequest request = new ListRegionTargetTcpProxiesRequest
{
Region = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<TargetTcpProxyList, TargetTcpProxy> response = regionTargetTcpProxiesClient.List(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (TargetTcpProxy 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 (TargetTcpProxyList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetTcpProxy 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<TargetTcpProxy> 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 (TargetTcpProxy item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
List(string, string, string, int?, CallSettings)
public virtual PagedEnumerable<TargetTcpProxyList, TargetTcpProxy> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableTargetTcpProxyListTargetTcpProxy | A pageable sequence of TargetTcpProxy resources. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = RegionTargetTcpProxiesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<TargetTcpProxyList, TargetTcpProxy> response = regionTargetTcpProxiesClient.List(project, region);
// Iterate over all response items, lazily performing RPCs as required
foreach (TargetTcpProxy 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 (TargetTcpProxyList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetTcpProxy 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<TargetTcpProxy> 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 (TargetTcpProxy 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(ListRegionTargetTcpProxiesRequest, CallSettings)
public virtual PagedAsyncEnumerable<TargetTcpProxyList, TargetTcpProxy> ListAsync(ListRegionTargetTcpProxiesRequest request, CallSettings callSettings = null)
Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
Parameters | |
---|---|
Name | Description |
request | ListRegionTargetTcpProxiesRequest 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 |
PagedAsyncEnumerableTargetTcpProxyListTargetTcpProxy | A pageable asynchronous sequence of TargetTcpProxy resources. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
ListRegionTargetTcpProxiesRequest request = new ListRegionTargetTcpProxiesRequest
{
Region = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<TargetTcpProxyList, TargetTcpProxy> response = regionTargetTcpProxiesClient.ListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TargetTcpProxy 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((TargetTcpProxyList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetTcpProxy 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<TargetTcpProxy> 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 (TargetTcpProxy item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAsync(string, string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<TargetTcpProxyList, TargetTcpProxy> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
Parameters | |
---|---|
Name | Description |
project | string Project ID for this request. |
region | string Name of the region scoping this request. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableTargetTcpProxyListTargetTcpProxy | A pageable asynchronous sequence of TargetTcpProxy resources. |
// Create client
RegionTargetTcpProxiesClient regionTargetTcpProxiesClient = await RegionTargetTcpProxiesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<TargetTcpProxyList, TargetTcpProxy> response = regionTargetTcpProxiesClient.ListAsync(project, region);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TargetTcpProxy 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((TargetTcpProxyList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (TargetTcpProxy 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<TargetTcpProxy> 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 (TargetTcpProxy item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
PollOnceDelete(string, CallSettings)
public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of Delete
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation | The result of polling the operation. |
PollOnceDeleteAsync(string, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of Delete
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A task representing the result of polling the operation. |
PollOnceInsert(string, CallSettings)
public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of Insert
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationOperationOperation | The result of polling the operation. |
PollOnceInsertAsync(string, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of Insert
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationOperationOperation | A task representing the result of polling the operation. |
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.