Compute Engine v1 API - Class NetworkAttachments.NetworkAttachmentsClient (2.16.0)

public class NetworkAttachments.NetworkAttachmentsClient : ClientBase<NetworkAttachments.NetworkAttachmentsClient>

Reference documentation and code samples for the Compute Engine v1 API class NetworkAttachments.NetworkAttachmentsClient.

Client for NetworkAttachments

Inheritance

object > ClientBase > ClientBaseNetworkAttachmentsNetworkAttachmentsClient > NetworkAttachments.NetworkAttachmentsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

NetworkAttachmentsClient()

protected NetworkAttachmentsClient()

Protected parameterless constructor to allow creation of test doubles.

NetworkAttachmentsClient(CallInvoker)

public NetworkAttachmentsClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

NetworkAttachmentsClient(ChannelBase)

public NetworkAttachmentsClient(ChannelBase channel)

Creates a new client for NetworkAttachments

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

NetworkAttachmentsClient(ClientBaseConfiguration)

protected NetworkAttachmentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListNetworkAttachmentsRequest, CallOptions)

public virtual NetworkAttachmentAggregatedList AggregatedList(AggregatedListNetworkAttachmentsRequest request, CallOptions options)

Retrieves the list of all NetworkAttachment 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 AggregatedListNetworkAttachmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NetworkAttachmentAggregatedList

The response received from the server.

AggregatedList(AggregatedListNetworkAttachmentsRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all NetworkAttachment 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 AggregatedListNetworkAttachmentsRequest

The request to send to the server.

headers Metadata

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

deadline 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
NetworkAttachmentAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListNetworkAttachmentsRequest, CallOptions)

public virtual AsyncUnaryCall<NetworkAttachmentAggregatedList> AggregatedListAsync(AggregatedListNetworkAttachmentsRequest request, CallOptions options)

Retrieves the list of all NetworkAttachment 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 AggregatedListNetworkAttachmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNetworkAttachmentAggregatedList

The call object.

AggregatedListAsync(AggregatedListNetworkAttachmentsRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all NetworkAttachment 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 AggregatedListNetworkAttachmentsRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallNetworkAttachmentAggregatedList

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
Type Description
OperationsOperationsClient

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

Delete(DeleteNetworkAttachmentRequest, CallOptions)

public virtual Operation Delete(DeleteNetworkAttachmentRequest request, CallOptions options)

Deletes the specified NetworkAttachment in the given scope

Parameters
Name Description
request DeleteNetworkAttachmentRequest

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

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

Deletes the specified NetworkAttachment in the given scope

Parameters
Name Description
request DeleteNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

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

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

Deletes the specified NetworkAttachment in the given scope

Parameters
Name Description
request DeleteNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified NetworkAttachment in the given scope

Parameters
Name Description
request DeleteNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

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

public virtual NetworkAttachment Get(GetNetworkAttachmentRequest request, CallOptions options)

Returns the specified NetworkAttachment resource in the given scope.

Parameters
Name Description
request GetNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NetworkAttachment

The response received from the server.

Get(GetNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified NetworkAttachment resource in the given scope.

Parameters
Name Description
request GetNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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
NetworkAttachment

The response received from the server.

GetAsync(GetNetworkAttachmentRequest, CallOptions)

public virtual AsyncUnaryCall<NetworkAttachment> GetAsync(GetNetworkAttachmentRequest request, CallOptions options)

Returns the specified NetworkAttachment resource in the given scope.

Parameters
Name Description
request GetNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNetworkAttachment

The call object.

GetAsync(GetNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified NetworkAttachment resource in the given scope.

Parameters
Name Description
request GetNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallNetworkAttachment

The call object.

GetIamPolicy(GetIamPolicyNetworkAttachmentRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyNetworkAttachmentRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyNetworkAttachmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyNetworkAttachmentRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyNetworkAttachmentRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

GetIamPolicyAsync(GetIamPolicyNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyNetworkAttachmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallPolicy

The call object.

Insert(InsertNetworkAttachmentRequest, CallOptions)

public virtual Operation Insert(InsertNetworkAttachmentRequest request, CallOptions options)

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

Parameters
Name Description
request InsertNetworkAttachmentRequest

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

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

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

Parameters
Name Description
request InsertNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

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

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

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

Parameters
Name Description
request InsertNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request InsertNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

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

public virtual NetworkAttachmentList List(ListNetworkAttachmentsRequest request, CallOptions options)

Lists the NetworkAttachments for a project in the given scope.

Parameters
Name Description
request ListNetworkAttachmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NetworkAttachmentList

The response received from the server.

List(ListNetworkAttachmentsRequest, Metadata, DateTime?, CancellationToken)

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

Lists the NetworkAttachments for a project in the given scope.

Parameters
Name Description
request ListNetworkAttachmentsRequest

The request to send to the server.

headers Metadata

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

deadline 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
NetworkAttachmentList

The response received from the server.

ListAsync(ListNetworkAttachmentsRequest, CallOptions)

public virtual AsyncUnaryCall<NetworkAttachmentList> ListAsync(ListNetworkAttachmentsRequest request, CallOptions options)

Lists the NetworkAttachments for a project in the given scope.

Parameters
Name Description
request ListNetworkAttachmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNetworkAttachmentList

The call object.

ListAsync(ListNetworkAttachmentsRequest, Metadata, DateTime?, CancellationToken)

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

Lists the NetworkAttachments for a project in the given scope.

Parameters
Name Description
request ListNetworkAttachmentsRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallNetworkAttachmentList

The call object.

NewInstance(ClientBaseConfiguration)

protected override NetworkAttachments.NetworkAttachmentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
NetworkAttachmentsNetworkAttachmentsClient
Overrides

Patch(PatchNetworkAttachmentRequest, CallOptions)

public virtual Operation Patch(PatchNetworkAttachmentRequest request, CallOptions options)

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

Parameters
Name Description
request PatchNetworkAttachmentRequest

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

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

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

Parameters
Name Description
request PatchNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

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

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

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

Parameters
Name Description
request PatchNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request PatchNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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.

SetIamPolicy(SetIamPolicyNetworkAttachmentRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyNetworkAttachmentRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyNetworkAttachmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyNetworkAttachmentRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyNetworkAttachmentRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

SetIamPolicyAsync(SetIamPolicyNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyNetworkAttachmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallPolicy

The call object.

TestIamPermissions(TestIamPermissionsNetworkAttachmentRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsNetworkAttachmentRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsNetworkAttachmentRequest

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

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

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

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsNetworkAttachmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallTestPermissionsResponse

The call object.

TestIamPermissionsAsync(TestIamPermissionsNetworkAttachmentRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsNetworkAttachmentRequest

The request to send to the server.

headers Metadata

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

deadline 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.