Network Connectivity v1alpha1 API - Class HubService.HubServiceClient (2.0.0-alpha03)

public class HubService.HubServiceClient : ClientBase<HubService.HubServiceClient>

Reference documentation and code samples for the Network Connectivity v1alpha1 API class HubService.HubServiceClient.

Client for HubService

Inheritance

object > ClientBase > ClientBaseHubServiceHubServiceClient > HubService.HubServiceClient

Namespace

Google.Cloud.NetworkConnectivity.V1Alpha1

Assembly

Google.Cloud.NetworkConnectivity.V1Alpha1.dll

Constructors

HubServiceClient()

protected HubServiceClient()

Protected parameterless constructor to allow creation of test doubles.

HubServiceClient(CallInvoker)

public HubServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

HubServiceClient(ChannelBase)

public HubServiceClient(ChannelBase channel)

Creates a new client for HubService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

HubServiceClient(ClientBaseConfiguration)

protected HubServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateHub(CreateHubRequest, CallOptions)

public virtual Operation CreateHub(CreateHubRequest request, CallOptions options)

Creates a new Hub in a given project and location.

Parameters
Name Description
request CreateHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateHub(CreateHubRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Hub in a given project and location.

Parameters
Name Description
request CreateHubRequest

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.

CreateHubAsync(CreateHubRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateHubAsync(CreateHubRequest request, CallOptions options)

Creates a new Hub in a given project and location.

Parameters
Name Description
request CreateHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateHubAsync(CreateHubRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Hub in a given project and location.

Parameters
Name Description
request CreateHubRequest

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.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type Description
OperationsOperationsClient

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

CreateSpoke(CreateSpokeRequest, CallOptions)

public virtual Operation CreateSpoke(CreateSpokeRequest request, CallOptions options)

Creates a new Spoke in a given project and location.

Parameters
Name Description
request CreateSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateSpoke(CreateSpokeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Spoke in a given project and location.

Parameters
Name Description
request CreateSpokeRequest

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.

CreateSpokeAsync(CreateSpokeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateSpokeAsync(CreateSpokeRequest request, CallOptions options)

Creates a new Spoke in a given project and location.

Parameters
Name Description
request CreateSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateSpokeAsync(CreateSpokeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Spoke in a given project and location.

Parameters
Name Description
request CreateSpokeRequest

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.

DeleteHub(DeleteHubRequest, CallOptions)

public virtual Operation DeleteHub(DeleteHubRequest request, CallOptions options)

Deletes a single Hub.

Parameters
Name Description
request DeleteHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteHub(DeleteHubRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Hub.

Parameters
Name Description
request DeleteHubRequest

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.

DeleteHubAsync(DeleteHubRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteHubAsync(DeleteHubRequest request, CallOptions options)

Deletes a single Hub.

Parameters
Name Description
request DeleteHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteHubAsync(DeleteHubRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Hub.

Parameters
Name Description
request DeleteHubRequest

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.

DeleteSpoke(DeleteSpokeRequest, CallOptions)

public virtual Operation DeleteSpoke(DeleteSpokeRequest request, CallOptions options)

Deletes a single Spoke.

Parameters
Name Description
request DeleteSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteSpoke(DeleteSpokeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Spoke.

Parameters
Name Description
request DeleteSpokeRequest

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.

DeleteSpokeAsync(DeleteSpokeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteSpokeAsync(DeleteSpokeRequest request, CallOptions options)

Deletes a single Spoke.

Parameters
Name Description
request DeleteSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteSpokeAsync(DeleteSpokeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Spoke.

Parameters
Name Description
request DeleteSpokeRequest

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.

GetHub(GetHubRequest, CallOptions)

public virtual Hub GetHub(GetHubRequest request, CallOptions options)

Gets details of a single Hub.

Parameters
Name Description
request GetHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Hub

The response received from the server.

GetHub(GetHubRequest, Metadata, DateTime?, CancellationToken)

public virtual Hub GetHub(GetHubRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Hub.

Parameters
Name Description
request GetHubRequest

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
Hub

The response received from the server.

GetHubAsync(GetHubRequest, CallOptions)

public virtual AsyncUnaryCall<Hub> GetHubAsync(GetHubRequest request, CallOptions options)

Gets details of a single Hub.

Parameters
Name Description
request GetHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallHub

The call object.

GetHubAsync(GetHubRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Hub> GetHubAsync(GetHubRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Hub.

Parameters
Name Description
request GetHubRequest

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
AsyncUnaryCallHub

The call object.

GetSpoke(GetSpokeRequest, CallOptions)

public virtual Spoke GetSpoke(GetSpokeRequest request, CallOptions options)

Gets details of a single Spoke.

Parameters
Name Description
request GetSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Spoke

The response received from the server.

GetSpoke(GetSpokeRequest, Metadata, DateTime?, CancellationToken)

public virtual Spoke GetSpoke(GetSpokeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Spoke.

Parameters
Name Description
request GetSpokeRequest

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
Spoke

The response received from the server.

GetSpokeAsync(GetSpokeRequest, CallOptions)

public virtual AsyncUnaryCall<Spoke> GetSpokeAsync(GetSpokeRequest request, CallOptions options)

Gets details of a single Spoke.

Parameters
Name Description
request GetSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSpoke

The call object.

GetSpokeAsync(GetSpokeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Spoke> GetSpokeAsync(GetSpokeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Spoke.

Parameters
Name Description
request GetSpokeRequest

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
AsyncUnaryCallSpoke

The call object.

ListHubs(ListHubsRequest, CallOptions)

public virtual ListHubsResponse ListHubs(ListHubsRequest request, CallOptions options)

Lists Hubs in a given project and location.

Parameters
Name Description
request ListHubsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListHubsResponse

The response received from the server.

ListHubs(ListHubsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListHubsResponse ListHubs(ListHubsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Hubs in a given project and location.

Parameters
Name Description
request ListHubsRequest

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
ListHubsResponse

The response received from the server.

ListHubsAsync(ListHubsRequest, CallOptions)

public virtual AsyncUnaryCall<ListHubsResponse> ListHubsAsync(ListHubsRequest request, CallOptions options)

Lists Hubs in a given project and location.

Parameters
Name Description
request ListHubsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListHubsResponse

The call object.

ListHubsAsync(ListHubsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListHubsResponse> ListHubsAsync(ListHubsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Hubs in a given project and location.

Parameters
Name Description
request ListHubsRequest

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
AsyncUnaryCallListHubsResponse

The call object.

ListSpokes(ListSpokesRequest, CallOptions)

public virtual ListSpokesResponse ListSpokes(ListSpokesRequest request, CallOptions options)

Lists Spokes in a given project and location.

Parameters
Name Description
request ListSpokesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListSpokesResponse

The response received from the server.

ListSpokes(ListSpokesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSpokesResponse ListSpokes(ListSpokesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Spokes in a given project and location.

Parameters
Name Description
request ListSpokesRequest

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
ListSpokesResponse

The response received from the server.

ListSpokesAsync(ListSpokesRequest, CallOptions)

public virtual AsyncUnaryCall<ListSpokesResponse> ListSpokesAsync(ListSpokesRequest request, CallOptions options)

Lists Spokes in a given project and location.

Parameters
Name Description
request ListSpokesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListSpokesResponse

The call object.

ListSpokesAsync(ListSpokesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSpokesResponse> ListSpokesAsync(ListSpokesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Spokes in a given project and location.

Parameters
Name Description
request ListSpokesRequest

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
AsyncUnaryCallListSpokesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override HubService.HubServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
HubServiceHubServiceClient
Overrides

UpdateHub(UpdateHubRequest, CallOptions)

public virtual Operation UpdateHub(UpdateHubRequest request, CallOptions options)

Updates the parameters of a single Hub.

Parameters
Name Description
request UpdateHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateHub(UpdateHubRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single Hub.

Parameters
Name Description
request UpdateHubRequest

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.

UpdateHubAsync(UpdateHubRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateHubAsync(UpdateHubRequest request, CallOptions options)

Updates the parameters of a single Hub.

Parameters
Name Description
request UpdateHubRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateHubAsync(UpdateHubRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single Hub.

Parameters
Name Description
request UpdateHubRequest

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.

UpdateSpoke(UpdateSpokeRequest, CallOptions)

public virtual Operation UpdateSpoke(UpdateSpokeRequest request, CallOptions options)

Updates the parameters of a single Spoke.

Parameters
Name Description
request UpdateSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateSpoke(UpdateSpokeRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single Spoke.

Parameters
Name Description
request UpdateSpokeRequest

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.

UpdateSpokeAsync(UpdateSpokeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateSpokeAsync(UpdateSpokeRequest request, CallOptions options)

Updates the parameters of a single Spoke.

Parameters
Name Description
request UpdateSpokeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateSpokeAsync(UpdateSpokeRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single Spoke.

Parameters
Name Description
request UpdateSpokeRequest

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.