Compute Engine v1 API - Class TargetInstances.TargetInstancesClient (3.19.0)

Version latest

• 3.19.0 (latest)
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class TargetInstances.TargetInstancesClient : ClientBase<TargetInstances.TargetInstancesClient>

Reference documentation and code samples for the Compute Engine v1 API class TargetInstances.TargetInstancesClient.

Client for TargetInstances

Inheritance

object > ClientBase > ClientBaseTargetInstancesTargetInstancesClient > TargetInstances.TargetInstancesClient

Inherited Members

ClientBase<TargetInstances.TargetInstancesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

TargetInstancesClient()

protected TargetInstancesClient()

Protected parameterless constructor to allow creation of test doubles.

TargetInstancesClient(CallInvoker)

public TargetInstancesClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

TargetInstancesClient(ChannelBase)

public TargetInstancesClient(ChannelBase channel)

Creates a new client for TargetInstances

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

TargetInstancesClient(ClientBaseConfiguration)

protected TargetInstancesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListTargetInstancesRequest, CallOptions)

public virtual TargetInstanceAggregatedList AggregatedList(AggregatedListTargetInstancesRequest request, CallOptions options)

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListTargetInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TargetInstanceAggregatedList	The response received from the server.

AggregatedList(AggregatedListTargetInstancesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListTargetInstancesRequest 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
TargetInstanceAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListTargetInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<TargetInstanceAggregatedList> AggregatedListAsync(AggregatedListTargetInstancesRequest request, CallOptions options)

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListTargetInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTargetInstanceAggregatedList	The call object.

AggregatedListAsync(AggregatedListTargetInstancesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListTargetInstancesRequest 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
AsyncUnaryCallTargetInstanceAggregatedList	The call object.

CreateOperationsClientForZoneOperations()

public virtual Operations.OperationsClient CreateOperationsClientForZoneOperations()

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

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteTargetInstanceRequest, CallOptions)

public virtual Operation Delete(DeleteTargetInstanceRequest request, CallOptions options)

Deletes the specified TargetInstance resource.

Parameters
Name	Description
request	DeleteTargetInstanceRequest 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(DeleteTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified TargetInstance resource.

Parameters
Name	Description
request	DeleteTargetInstanceRequest 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(DeleteTargetInstanceRequest, CallOptions)

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

Deletes the specified TargetInstance resource.

Parameters
Name	Description
request	DeleteTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified TargetInstance resource.

Parameters
Name	Description
request	DeleteTargetInstanceRequest 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(GetTargetInstanceRequest, CallOptions)

public virtual TargetInstance Get(GetTargetInstanceRequest request, CallOptions options)

Returns the specified TargetInstance resource.

Parameters
Name	Description
request	GetTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TargetInstance	The response received from the server.

Get(GetTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified TargetInstance resource.

Parameters
Name	Description
request	GetTargetInstanceRequest 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
TargetInstance	The response received from the server.

GetAsync(GetTargetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<TargetInstance> GetAsync(GetTargetInstanceRequest request, CallOptions options)

Returns the specified TargetInstance resource.

Parameters
Name	Description
request	GetTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTargetInstance	The call object.

GetAsync(GetTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified TargetInstance resource.

Parameters
Name	Description
request	GetTargetInstanceRequest 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
AsyncUnaryCallTargetInstance	The call object.

Insert(InsertTargetInstanceRequest, CallOptions)

public virtual Operation Insert(InsertTargetInstanceRequest request, CallOptions options)

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Parameters
Name	Description
request	InsertTargetInstanceRequest 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(InsertTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Parameters
Name	Description
request	InsertTargetInstanceRequest 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(InsertTargetInstanceRequest, CallOptions)

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

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Parameters
Name	Description
request	InsertTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Parameters
Name	Description
request	InsertTargetInstanceRequest 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(ListTargetInstancesRequest, CallOptions)

public virtual TargetInstanceList List(ListTargetInstancesRequest request, CallOptions options)

Retrieves a list of TargetInstance resources available to the specified project and zone.

Parameters
Name	Description
request	ListTargetInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TargetInstanceList	The response received from the server.

List(ListTargetInstancesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of TargetInstance resources available to the specified project and zone.

Parameters
Name	Description
request	ListTargetInstancesRequest 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
TargetInstanceList	The response received from the server.

ListAsync(ListTargetInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<TargetInstanceList> ListAsync(ListTargetInstancesRequest request, CallOptions options)

Retrieves a list of TargetInstance resources available to the specified project and zone.

Parameters
Name	Description
request	ListTargetInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTargetInstanceList	The call object.

ListAsync(ListTargetInstancesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of TargetInstance resources available to the specified project and zone.

Parameters
Name	Description
request	ListTargetInstancesRequest 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
AsyncUnaryCallTargetInstanceList	The call object.

NewInstance(ClientBaseConfiguration)

protected override TargetInstances.TargetInstancesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
TargetInstancesTargetInstancesClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.TargetInstances.TargetInstancesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetSecurityPolicy(SetSecurityPolicyTargetInstanceRequest, CallOptions)

public virtual Operation SetSecurityPolicy(SetSecurityPolicyTargetInstanceRequest request, CallOptions options)

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

Parameters
Name	Description
request	SetSecurityPolicyTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

SetSecurityPolicy(SetSecurityPolicyTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

Parameters
Name	Description
request	SetSecurityPolicyTargetInstanceRequest 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.

SetSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest request, CallOptions options)

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

Parameters
Name	Description
request	SetSecurityPolicyTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

Parameters
Name	Description
request	SetSecurityPolicyTargetInstanceRequest 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.

TestIamPermissions(TestIamPermissionsTargetInstanceRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsTargetInstanceRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsTargetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsTargetInstanceRequest 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
TestPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsTargetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsTargetInstanceRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsTargetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsTargetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsTargetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsTargetInstanceRequest 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
AsyncUnaryCallTestPermissionsResponse	The call object.