Compute Engine v1 API - Class PacketMirrorings.PacketMirroringsClient (2.15.0)

public class PacketMirrorings.PacketMirroringsClient : ClientBase<PacketMirrorings.PacketMirroringsClient>

Reference documentation and code samples for the Compute Engine v1 API class PacketMirrorings.PacketMirroringsClient.

Client for PacketMirrorings

Inheritance

object > ClientBase > ClientBasePacketMirroringsPacketMirroringsClient > PacketMirrorings.PacketMirroringsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

PacketMirroringsClient()

protected PacketMirroringsClient()

Protected parameterless constructor to allow creation of test doubles.

PacketMirroringsClient(CallInvoker)

public PacketMirroringsClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

PacketMirroringsClient(ChannelBase)

public PacketMirroringsClient(ChannelBase channel)

Creates a new client for PacketMirrorings

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

PacketMirroringsClient(ClientBaseConfiguration)

protected PacketMirroringsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListPacketMirroringsRequest, CallOptions)

public virtual PacketMirroringAggregatedList AggregatedList(AggregatedListPacketMirroringsRequest request, CallOptions options)

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

Parameters
NameDescription
requestAggregatedListPacketMirroringsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
PacketMirroringAggregatedList

The response received from the server.

AggregatedList(AggregatedListPacketMirroringsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestAggregatedListPacketMirroringsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
PacketMirroringAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListPacketMirroringsRequest, CallOptions)

public virtual AsyncUnaryCall<PacketMirroringAggregatedList> AggregatedListAsync(AggregatedListPacketMirroringsRequest request, CallOptions options)

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

Parameters
NameDescription
requestAggregatedListPacketMirroringsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPacketMirroringAggregatedList

The call object.

AggregatedListAsync(AggregatedListPacketMirroringsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestAggregatedListPacketMirroringsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallPacketMirroringAggregatedList

The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

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

Returns
TypeDescription
OperationsOperationsClient

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

Delete(DeletePacketMirroringRequest, CallOptions)

public virtual Operation Delete(DeletePacketMirroringRequest request, CallOptions options)

Deletes the specified PacketMirroring resource.

Parameters
NameDescription
requestDeletePacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeletePacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified PacketMirroring resource.

Parameters
NameDescription
requestDeletePacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAsync(DeletePacketMirroringRequest, CallOptions)

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

Deletes the specified PacketMirroring resource.

Parameters
NameDescription
requestDeletePacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeletePacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified PacketMirroring resource.

Parameters
NameDescription
requestDeletePacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

Get(GetPacketMirroringRequest, CallOptions)

public virtual PacketMirroring Get(GetPacketMirroringRequest request, CallOptions options)

Returns the specified PacketMirroring resource.

Parameters
NameDescription
requestGetPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
PacketMirroring

The response received from the server.

Get(GetPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified PacketMirroring resource.

Parameters
NameDescription
requestGetPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
PacketMirroring

The response received from the server.

GetAsync(GetPacketMirroringRequest, CallOptions)

public virtual AsyncUnaryCall<PacketMirroring> GetAsync(GetPacketMirroringRequest request, CallOptions options)

Returns the specified PacketMirroring resource.

Parameters
NameDescription
requestGetPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPacketMirroring

The call object.

GetAsync(GetPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified PacketMirroring resource.

Parameters
NameDescription
requestGetPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallPacketMirroring

The call object.

Insert(InsertPacketMirroringRequest, CallOptions)

public virtual Operation Insert(InsertPacketMirroringRequest request, CallOptions options)

Creates a PacketMirroring resource in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Creates a PacketMirroring resource in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

InsertAsync(InsertPacketMirroringRequest, CallOptions)

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

Creates a PacketMirroring resource in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Creates a PacketMirroring resource in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

List(ListPacketMirroringsRequest, CallOptions)

public virtual PacketMirroringList List(ListPacketMirroringsRequest request, CallOptions options)

Retrieves a list of PacketMirroring resources available to the specified project and region.

Parameters
NameDescription
requestListPacketMirroringsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
PacketMirroringList

The response received from the server.

List(ListPacketMirroringsRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of PacketMirroring resources available to the specified project and region.

Parameters
NameDescription
requestListPacketMirroringsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
PacketMirroringList

The response received from the server.

ListAsync(ListPacketMirroringsRequest, CallOptions)

public virtual AsyncUnaryCall<PacketMirroringList> ListAsync(ListPacketMirroringsRequest request, CallOptions options)

Retrieves a list of PacketMirroring resources available to the specified project and region.

Parameters
NameDescription
requestListPacketMirroringsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPacketMirroringList

The call object.

ListAsync(ListPacketMirroringsRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of PacketMirroring resources available to the specified project and region.

Parameters
NameDescription
requestListPacketMirroringsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallPacketMirroringList

The call object.

NewInstance(ClientBaseConfiguration)

protected override PacketMirrorings.PacketMirroringsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
PacketMirroringsPacketMirroringsClient
Overrides

Patch(PatchPacketMirroringRequest, CallOptions)

public virtual Operation Patch(PatchPacketMirroringRequest request, CallOptions options)

Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchAsync(PatchPacketMirroringRequest, CallOptions)

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

Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

TestIamPermissions(TestIamPermissionsPacketMirroringRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsPacketMirroringRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TestPermissionsResponse

The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsPacketMirroringRequest, CallOptions)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsPacketMirroringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTestPermissionsResponse

The call object.

TestIamPermissionsAsync(TestIamPermissionsPacketMirroringRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsPacketMirroringRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTestPermissionsResponse

The call object.