Compute Engine v1 API - Class PublicAdvertisedPrefixes.PublicAdvertisedPrefixesClient (2.13.0)

public class PublicAdvertisedPrefixes.PublicAdvertisedPrefixesClient : ClientBase<PublicAdvertisedPrefixes.PublicAdvertisedPrefixesClient>

Reference documentation and code samples for the Compute Engine v1 API class PublicAdvertisedPrefixes.PublicAdvertisedPrefixesClient.

Client for PublicAdvertisedPrefixes

Inheritance

object > ClientBase > ClientBasePublicAdvertisedPrefixesPublicAdvertisedPrefixesClient > PublicAdvertisedPrefixes.PublicAdvertisedPrefixesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

PublicAdvertisedPrefixesClient()

protected PublicAdvertisedPrefixesClient()

Protected parameterless constructor to allow creation of test doubles.

PublicAdvertisedPrefixesClient(CallInvoker)

public PublicAdvertisedPrefixesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

PublicAdvertisedPrefixesClient(ChannelBase)

public PublicAdvertisedPrefixesClient(ChannelBase channel)

Creates a new client for PublicAdvertisedPrefixes

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

PublicAdvertisedPrefixesClient(ClientBaseConfiguration)

protected PublicAdvertisedPrefixesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

Announce(AnnouncePublicAdvertisedPrefixeRequest, CallOptions)

public virtual Operation Announce(AnnouncePublicAdvertisedPrefixeRequest request, CallOptions options)

Announces the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestAnnouncePublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Announce(AnnouncePublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Announces the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestAnnouncePublicAdvertisedPrefixeRequest

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.

AnnounceAsync(AnnouncePublicAdvertisedPrefixeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AnnounceAsync(AnnouncePublicAdvertisedPrefixeRequest request, CallOptions options)

Announces the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestAnnouncePublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

AnnounceAsync(AnnouncePublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Announces the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestAnnouncePublicAdvertisedPrefixeRequest

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.

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
TypeDescription
OperationsOperationsClient

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

Delete(DeletePublicAdvertisedPrefixeRequest, CallOptions)

public virtual Operation Delete(DeletePublicAdvertisedPrefixeRequest request, CallOptions options)

Deletes the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestDeletePublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeletePublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestDeletePublicAdvertisedPrefixeRequest

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

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

Deletes the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestDeletePublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeletePublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestDeletePublicAdvertisedPrefixeRequest

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

public virtual PublicAdvertisedPrefix Get(GetPublicAdvertisedPrefixeRequest request, CallOptions options)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
NameDescription
requestGetPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
PublicAdvertisedPrefix

The response received from the server.

Get(GetPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified PublicAdvertisedPrefix resource.

Parameters
NameDescription
requestGetPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefix

The response received from the server.

GetAsync(GetPublicAdvertisedPrefixeRequest, CallOptions)

public virtual AsyncUnaryCall<PublicAdvertisedPrefix> GetAsync(GetPublicAdvertisedPrefixeRequest request, CallOptions options)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
NameDescription
requestGetPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPublicAdvertisedPrefix

The call object.

GetAsync(GetPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified PublicAdvertisedPrefix resource.

Parameters
NameDescription
requestGetPublicAdvertisedPrefixeRequest

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
AsyncUnaryCallPublicAdvertisedPrefix

The call object.

Insert(InsertPublicAdvertisedPrefixeRequest, CallOptions)

public virtual Operation Insert(InsertPublicAdvertisedPrefixeRequest request, CallOptions options)

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
NameDescription
requestInsertPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
NameDescription
requestInsertPublicAdvertisedPrefixeRequest

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

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

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
NameDescription
requestInsertPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
NameDescription
requestInsertPublicAdvertisedPrefixeRequest

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

public virtual PublicAdvertisedPrefixList List(ListPublicAdvertisedPrefixesRequest request, CallOptions options)

Lists the PublicAdvertisedPrefixes for a project.

Parameters
NameDescription
requestListPublicAdvertisedPrefixesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
PublicAdvertisedPrefixList

The response received from the server.

List(ListPublicAdvertisedPrefixesRequest, Metadata, DateTime?, CancellationToken)

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

Lists the PublicAdvertisedPrefixes for a project.

Parameters
NameDescription
requestListPublicAdvertisedPrefixesRequest

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
PublicAdvertisedPrefixList

The response received from the server.

ListAsync(ListPublicAdvertisedPrefixesRequest, CallOptions)

public virtual AsyncUnaryCall<PublicAdvertisedPrefixList> ListAsync(ListPublicAdvertisedPrefixesRequest request, CallOptions options)

Lists the PublicAdvertisedPrefixes for a project.

Parameters
NameDescription
requestListPublicAdvertisedPrefixesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPublicAdvertisedPrefixList

The call object.

ListAsync(ListPublicAdvertisedPrefixesRequest, Metadata, DateTime?, CancellationToken)

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

Lists the PublicAdvertisedPrefixes for a project.

Parameters
NameDescription
requestListPublicAdvertisedPrefixesRequest

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
AsyncUnaryCallPublicAdvertisedPrefixList

The call object.

NewInstance(ClientBaseConfiguration)

protected override PublicAdvertisedPrefixes.PublicAdvertisedPrefixesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
PublicAdvertisedPrefixesPublicAdvertisedPrefixesClient
Overrides

Patch(PatchPublicAdvertisedPrefixeRequest, CallOptions)

public virtual Operation Patch(PatchPublicAdvertisedPrefixeRequest request, CallOptions options)

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

Parameters
NameDescription
requestPatchPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestPatchPublicAdvertisedPrefixeRequest

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

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

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

Parameters
NameDescription
requestPatchPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestPatchPublicAdvertisedPrefixeRequest

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.

Withdraw(WithdrawPublicAdvertisedPrefixeRequest, CallOptions)

public virtual Operation Withdraw(WithdrawPublicAdvertisedPrefixeRequest request, CallOptions options)

Withdraws the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestWithdrawPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Withdraw(WithdrawPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Withdraws the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestWithdrawPublicAdvertisedPrefixeRequest

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.

WithdrawAsync(WithdrawPublicAdvertisedPrefixeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> WithdrawAsync(WithdrawPublicAdvertisedPrefixeRequest request, CallOptions options)

Withdraws the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestWithdrawPublicAdvertisedPrefixeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

WithdrawAsync(WithdrawPublicAdvertisedPrefixeRequest, Metadata, DateTime?, CancellationToken)

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

Withdraws the specified PublicAdvertisedPrefix

Parameters
NameDescription
requestWithdrawPublicAdvertisedPrefixeRequest

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.