Compute Engine v1 API - Class WireGroups.WireGroupsClient (3.22.0)

public class WireGroups.WireGroupsClient : ClientBase<WireGroups.WireGroupsClient>

Reference documentation and code samples for the Compute Engine v1 API class WireGroups.WireGroupsClient.

Client for WireGroups

Inheritance

object > ClientBase > ClientBaseWireGroupsWireGroupsClient > WireGroups.WireGroupsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

WireGroupsClient()

protected WireGroupsClient()

Protected parameterless constructor to allow creation of test doubles.

WireGroupsClient(CallInvoker)

public WireGroupsClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

WireGroupsClient(ChannelBase)

public WireGroupsClient(ChannelBase channel)

Creates a new client for WireGroups

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

WireGroupsClient(ClientBaseConfiguration)

protected WireGroupsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

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(DeleteWireGroupRequest, CallOptions)

public virtual Operation Delete(DeleteWireGroupRequest request, CallOptions options)

Deletes the specified wire group in the given scope.

Parameters
Name Description
request DeleteWireGroupRequest

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(DeleteWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified wire group in the given scope.

Parameters
Name Description
request DeleteWireGroupRequest

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(DeleteWireGroupRequest, CallOptions)

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

Deletes the specified wire group in the given scope.

Parameters
Name Description
request DeleteWireGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified wire group in the given scope.

Parameters
Name Description
request DeleteWireGroupRequest

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(GetWireGroupRequest, CallOptions)

public virtual WireGroup Get(GetWireGroupRequest request, CallOptions options)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
request GetWireGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
WireGroup

The response received from the server.

Get(GetWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Gets the specified wire group resource in the given scope.

Parameters
Name Description
request GetWireGroupRequest

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
WireGroup

The response received from the server.

GetAsync(GetWireGroupRequest, CallOptions)

public virtual AsyncUnaryCall<WireGroup> GetAsync(GetWireGroupRequest request, CallOptions options)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
request GetWireGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallWireGroup

The call object.

GetAsync(GetWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Gets the specified wire group resource in the given scope.

Parameters
Name Description
request GetWireGroupRequest

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
AsyncUnaryCallWireGroup

The call object.

Insert(InsertWireGroupRequest, CallOptions)

public virtual Operation Insert(InsertWireGroupRequest request, CallOptions options)

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertWireGroupRequest

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(InsertWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertWireGroupRequest

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(InsertWireGroupRequest, CallOptions)

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

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertWireGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertWireGroupRequest

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(ListWireGroupsRequest, CallOptions)

public virtual WireGroupList List(ListWireGroupsRequest request, CallOptions options)

Lists the wire groups for a project in the given scope.

Parameters
Name Description
request ListWireGroupsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
WireGroupList

The response received from the server.

List(ListWireGroupsRequest, Metadata, DateTime?, CancellationToken)

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

Lists the wire groups for a project in the given scope.

Parameters
Name Description
request ListWireGroupsRequest

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
WireGroupList

The response received from the server.

ListAsync(ListWireGroupsRequest, CallOptions)

public virtual AsyncUnaryCall<WireGroupList> ListAsync(ListWireGroupsRequest request, CallOptions options)

Lists the wire groups for a project in the given scope.

Parameters
Name Description
request ListWireGroupsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallWireGroupList

The call object.

ListAsync(ListWireGroupsRequest, Metadata, DateTime?, CancellationToken)

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

Lists the wire groups for a project in the given scope.

Parameters
Name Description
request ListWireGroupsRequest

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
AsyncUnaryCallWireGroupList

The call object.

NewInstance(ClientBaseConfiguration)

protected override WireGroups.WireGroupsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
WireGroupsWireGroupsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.WireGroups.WireGroupsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchWireGroupRequest, CallOptions)

public virtual Operation Patch(PatchWireGroupRequest request, CallOptions options)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
request PatchWireGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Patch(PatchWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
request PatchWireGroupRequest

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.

PatchAsync(PatchWireGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchWireGroupRequest request, CallOptions options)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
request PatchWireGroupRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchWireGroupRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
request PatchWireGroupRequest

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.