Compute Engine v1 API - Class TargetTcpProxies.TargetTcpProxiesClient (2.17.0)

public class TargetTcpProxies.TargetTcpProxiesClient : ClientBase<TargetTcpProxies.TargetTcpProxiesClient>

Reference documentation and code samples for the Compute Engine v1 API class TargetTcpProxies.TargetTcpProxiesClient.

Client for TargetTcpProxies

Inheritance

object > ClientBase > ClientBaseTargetTcpProxiesTargetTcpProxiesClient > TargetTcpProxies.TargetTcpProxiesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

TargetTcpProxiesClient()

protected TargetTcpProxiesClient()

Protected parameterless constructor to allow creation of test doubles.

TargetTcpProxiesClient(CallInvoker)

public TargetTcpProxiesClient(CallInvoker callInvoker)

Creates a new client for TargetTcpProxies that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

TargetTcpProxiesClient(ChannelBase)

public TargetTcpProxiesClient(ChannelBase channel)

Creates a new client for TargetTcpProxies

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

TargetTcpProxiesClient(ClientBaseConfiguration)

protected TargetTcpProxiesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListTargetTcpProxiesRequest, CallOptions)

public virtual TargetTcpProxyAggregatedList AggregatedList(AggregatedListTargetTcpProxiesRequest request, CallOptions options)

Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListTargetTcpProxiesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
TargetTcpProxyAggregatedList

The response received from the server.

AggregatedList(AggregatedListTargetTcpProxiesRequest, Metadata, DateTime?, CancellationToken)

public virtual TargetTcpProxyAggregatedList AggregatedList(AggregatedListTargetTcpProxiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListTargetTcpProxiesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
TargetTcpProxyAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListTargetTcpProxiesRequest, CallOptions)

public virtual AsyncUnaryCall<TargetTcpProxyAggregatedList> AggregatedListAsync(AggregatedListTargetTcpProxiesRequest request, CallOptions options)

Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListTargetTcpProxiesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallTargetTcpProxyAggregatedList

The call object.

AggregatedListAsync(AggregatedListTargetTcpProxiesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TargetTcpProxyAggregatedList> AggregatedListAsync(AggregatedListTargetTcpProxiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListTargetTcpProxiesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallTargetTcpProxyAggregatedList

The call object.

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

Delete(DeleteTargetTcpProxyRequest, CallOptions)

public virtual Operation Delete(DeleteTargetTcpProxyRequest request, CallOptions options)

Deletes the specified TargetTcpProxy resource.

Parameters
Name Description
request DeleteTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Delete(DeleteTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified TargetTcpProxy resource.

Parameters
Name Description
request DeleteTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteAsync(DeleteTargetTcpProxyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteTargetTcpProxyRequest request, CallOptions options)

Deletes the specified TargetTcpProxy resource.

Parameters
Name Description
request DeleteTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified TargetTcpProxy resource.

Parameters
Name Description
request DeleteTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

Get(GetTargetTcpProxyRequest, CallOptions)

public virtual TargetTcpProxy Get(GetTargetTcpProxyRequest request, CallOptions options)

Returns the specified TargetTcpProxy resource.

Parameters
Name Description
request GetTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
TargetTcpProxy

The response received from the server.

Get(GetTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual TargetTcpProxy Get(GetTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified TargetTcpProxy resource.

Parameters
Name Description
request GetTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
TargetTcpProxy

The response received from the server.

GetAsync(GetTargetTcpProxyRequest, CallOptions)

public virtual AsyncUnaryCall<TargetTcpProxy> GetAsync(GetTargetTcpProxyRequest request, CallOptions options)

Returns the specified TargetTcpProxy resource.

Parameters
Name Description
request GetTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallTargetTcpProxy

The call object.

GetAsync(GetTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TargetTcpProxy> GetAsync(GetTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified TargetTcpProxy resource.

Parameters
Name Description
request GetTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallTargetTcpProxy

The call object.

Insert(InsertTargetTcpProxyRequest, CallOptions)

public virtual Operation Insert(InsertTargetTcpProxyRequest request, CallOptions options)

Creates a TargetTcpProxy resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Insert(InsertTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a TargetTcpProxy resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

InsertAsync(InsertTargetTcpProxyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertTargetTcpProxyRequest request, CallOptions options)

Creates a TargetTcpProxy resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a TargetTcpProxy resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

List(ListTargetTcpProxiesRequest, CallOptions)

public virtual TargetTcpProxyList List(ListTargetTcpProxiesRequest request, CallOptions options)

Retrieves the list of TargetTcpProxy resources available to the specified project.

Parameters
Name Description
request ListTargetTcpProxiesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
TargetTcpProxyList

The response received from the server.

List(ListTargetTcpProxiesRequest, Metadata, DateTime?, CancellationToken)

public virtual TargetTcpProxyList List(ListTargetTcpProxiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of TargetTcpProxy resources available to the specified project.

Parameters
Name Description
request ListTargetTcpProxiesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
TargetTcpProxyList

The response received from the server.

ListAsync(ListTargetTcpProxiesRequest, CallOptions)

public virtual AsyncUnaryCall<TargetTcpProxyList> ListAsync(ListTargetTcpProxiesRequest request, CallOptions options)

Retrieves the list of TargetTcpProxy resources available to the specified project.

Parameters
Name Description
request ListTargetTcpProxiesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallTargetTcpProxyList

The call object.

ListAsync(ListTargetTcpProxiesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TargetTcpProxyList> ListAsync(ListTargetTcpProxiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of TargetTcpProxy resources available to the specified project.

Parameters
Name Description
request ListTargetTcpProxiesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallTargetTcpProxyList

The call object.

NewInstance(ClientBaseConfiguration)

protected override TargetTcpProxies.TargetTcpProxiesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
TargetTcpProxiesTargetTcpProxiesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.TargetTcpProxies.TargetTcpProxiesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetBackendService(SetBackendServiceTargetTcpProxyRequest, CallOptions)

public virtual Operation SetBackendService(SetBackendServiceTargetTcpProxyRequest request, CallOptions options)

Changes the BackendService for TargetTcpProxy.

Parameters
Name Description
request SetBackendServiceTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetBackendService(SetBackendServiceTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetBackendService(SetBackendServiceTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Changes the BackendService for TargetTcpProxy.

Parameters
Name Description
request SetBackendServiceTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

SetBackendServiceAsync(SetBackendServiceTargetTcpProxyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetBackendServiceAsync(SetBackendServiceTargetTcpProxyRequest request, CallOptions options)

Changes the BackendService for TargetTcpProxy.

Parameters
Name Description
request SetBackendServiceTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetBackendServiceAsync(SetBackendServiceTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetBackendServiceAsync(SetBackendServiceTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Changes the BackendService for TargetTcpProxy.

Parameters
Name Description
request SetBackendServiceTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetProxyHeader(SetProxyHeaderTargetTcpProxyRequest, CallOptions)

public virtual Operation SetProxyHeader(SetProxyHeaderTargetTcpProxyRequest request, CallOptions options)

Changes the ProxyHeaderType for TargetTcpProxy.

Parameters
Name Description
request SetProxyHeaderTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetProxyHeader(SetProxyHeaderTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetProxyHeader(SetProxyHeaderTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Changes the ProxyHeaderType for TargetTcpProxy.

Parameters
Name Description
request SetProxyHeaderTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

SetProxyHeaderAsync(SetProxyHeaderTargetTcpProxyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetProxyHeaderAsync(SetProxyHeaderTargetTcpProxyRequest request, CallOptions options)

Changes the ProxyHeaderType for TargetTcpProxy.

Parameters
Name Description
request SetProxyHeaderTargetTcpProxyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetProxyHeaderAsync(SetProxyHeaderTargetTcpProxyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetProxyHeaderAsync(SetProxyHeaderTargetTcpProxyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Changes the ProxyHeaderType for TargetTcpProxy.

Parameters
Name Description
request SetProxyHeaderTargetTcpProxyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.