Class protos.google.cloud.networkconnectivity.v1.HubService (4.6.0)

Represents a HubService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.networkconnectivity.v1.HubService

Package

@google-cloud/network-connectivity

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new HubService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

acceptHubSpoke(request, callback)

public acceptHubSpoke(request: google.cloud.networkconnectivity.v1.IAcceptHubSpokeRequest, callback: google.cloud.networkconnectivity.v1.HubService.AcceptHubSpokeCallback): void;

Calls AcceptHubSpoke.

Parameters
Name Description
request IAcceptHubSpokeRequest

AcceptHubSpokeRequest message or plain object
callback AcceptHubSpokeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

acceptHubSpoke(request)

public acceptHubSpoke(request: google.cloud.networkconnectivity.v1.IAcceptHubSpokeRequest): Promise<google.longrunning.Operation>;

Calls AcceptHubSpoke.

Parameter
Name Description
request IAcceptHubSpokeRequest

AcceptHubSpokeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

acceptSpokeUpdate(request, callback)

public acceptSpokeUpdate(request: google.cloud.networkconnectivity.v1.IAcceptSpokeUpdateRequest, callback: google.cloud.networkconnectivity.v1.HubService.AcceptSpokeUpdateCallback): void;

Calls AcceptSpokeUpdate.

Parameters
Name Description
request IAcceptSpokeUpdateRequest

AcceptSpokeUpdateRequest message or plain object
callback AcceptSpokeUpdateCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

acceptSpokeUpdate(request)

public acceptSpokeUpdate(request: google.cloud.networkconnectivity.v1.IAcceptSpokeUpdateRequest): Promise<google.longrunning.Operation>;

Calls AcceptSpokeUpdate.

Parameter
Name Description
request IAcceptSpokeUpdateRequest

AcceptSpokeUpdateRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): HubService;

Creates new HubService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
HubService

RPC service. Useful where requests and/or responses are streamed.

createHub(request, callback)

public createHub(request: google.cloud.networkconnectivity.v1.ICreateHubRequest, callback: google.cloud.networkconnectivity.v1.HubService.CreateHubCallback): void;

Calls CreateHub.

Parameters
Name Description
request ICreateHubRequest

CreateHubRequest message or plain object
callback CreateHubCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createHub(request)

public createHub(request: google.cloud.networkconnectivity.v1.ICreateHubRequest): Promise<google.longrunning.Operation>;

Calls CreateHub.

Parameter
Name Description
request ICreateHubRequest

CreateHubRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createSpoke(request, callback)

public createSpoke(request: google.cloud.networkconnectivity.v1.ICreateSpokeRequest, callback: google.cloud.networkconnectivity.v1.HubService.CreateSpokeCallback): void;

Calls CreateSpoke.

Parameters
Name Description
request ICreateSpokeRequest

CreateSpokeRequest message or plain object
callback CreateSpokeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createSpoke(request)

public createSpoke(request: google.cloud.networkconnectivity.v1.ICreateSpokeRequest): Promise<google.longrunning.Operation>;

Calls CreateSpoke.

Parameter
Name Description
request ICreateSpokeRequest

CreateSpokeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteHub(request, callback)

public deleteHub(request: google.cloud.networkconnectivity.v1.IDeleteHubRequest, callback: google.cloud.networkconnectivity.v1.HubService.DeleteHubCallback): void;

Calls DeleteHub.

Parameters
Name Description
request IDeleteHubRequest

DeleteHubRequest message or plain object
callback DeleteHubCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteHub(request)

public deleteHub(request: google.cloud.networkconnectivity.v1.IDeleteHubRequest): Promise<google.longrunning.Operation>;

Calls DeleteHub.

Parameter
Name Description
request IDeleteHubRequest

DeleteHubRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteSpoke(request, callback)

public deleteSpoke(request: google.cloud.networkconnectivity.v1.IDeleteSpokeRequest, callback: google.cloud.networkconnectivity.v1.HubService.DeleteSpokeCallback): void;

Calls DeleteSpoke.

Parameters
Name Description
request IDeleteSpokeRequest

DeleteSpokeRequest message or plain object
callback DeleteSpokeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteSpoke(request)

public deleteSpoke(request: google.cloud.networkconnectivity.v1.IDeleteSpokeRequest): Promise<google.longrunning.Operation>;

Calls DeleteSpoke.

Parameter
Name Description
request IDeleteSpokeRequest

DeleteSpokeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getGroup(request, callback)

public getGroup(request: google.cloud.networkconnectivity.v1.IGetGroupRequest, callback: google.cloud.networkconnectivity.v1.HubService.GetGroupCallback): void;

Calls GetGroup.

Parameters
Name Description
request IGetGroupRequest

GetGroupRequest message or plain object
callback GetGroupCallback

Node-style callback called with the error, if any, and Group
Returns
Type Description
void

getGroup(request)

public getGroup(request: google.cloud.networkconnectivity.v1.IGetGroupRequest): Promise<google.cloud.networkconnectivity.v1.Group>;

Calls GetGroup.

Parameter
Name Description
request IGetGroupRequest

GetGroupRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.Group>

Promise

getHub(request, callback)

public getHub(request: google.cloud.networkconnectivity.v1.IGetHubRequest, callback: google.cloud.networkconnectivity.v1.HubService.GetHubCallback): void;

Calls GetHub.

Parameters
Name Description
request IGetHubRequest

GetHubRequest message or plain object
callback GetHubCallback

Node-style callback called with the error, if any, and Hub
Returns
Type Description
void

getHub(request)

public getHub(request: google.cloud.networkconnectivity.v1.IGetHubRequest): Promise<google.cloud.networkconnectivity.v1.Hub>;

Calls GetHub.

Parameter
Name Description
request IGetHubRequest

GetHubRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.Hub>

Promise

getRoute(request, callback)

public getRoute(request: google.cloud.networkconnectivity.v1.IGetRouteRequest, callback: google.cloud.networkconnectivity.v1.HubService.GetRouteCallback): void;

Calls GetRoute.

Parameters
Name Description
request IGetRouteRequest

GetRouteRequest message or plain object
callback GetRouteCallback

Node-style callback called with the error, if any, and Route
Returns
Type Description
void

getRoute(request)

public getRoute(request: google.cloud.networkconnectivity.v1.IGetRouteRequest): Promise<google.cloud.networkconnectivity.v1.Route>;

Calls GetRoute.

Parameter
Name Description
request IGetRouteRequest

GetRouteRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.Route>

Promise

getRouteTable(request, callback)

public getRouteTable(request: google.cloud.networkconnectivity.v1.IGetRouteTableRequest, callback: google.cloud.networkconnectivity.v1.HubService.GetRouteTableCallback): void;

Calls GetRouteTable.

Parameters
Name Description
request IGetRouteTableRequest

GetRouteTableRequest message or plain object
callback GetRouteTableCallback

Node-style callback called with the error, if any, and RouteTable
Returns
Type Description
void

getRouteTable(request)

public getRouteTable(request: google.cloud.networkconnectivity.v1.IGetRouteTableRequest): Promise<google.cloud.networkconnectivity.v1.RouteTable>;

Calls GetRouteTable.

Parameter
Name Description
request IGetRouteTableRequest

GetRouteTableRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.RouteTable>

Promise

getSpoke(request, callback)

public getSpoke(request: google.cloud.networkconnectivity.v1.IGetSpokeRequest, callback: google.cloud.networkconnectivity.v1.HubService.GetSpokeCallback): void;

Calls GetSpoke.

Parameters
Name Description
request IGetSpokeRequest

GetSpokeRequest message or plain object
callback GetSpokeCallback

Node-style callback called with the error, if any, and Spoke
Returns
Type Description
void

getSpoke(request)

public getSpoke(request: google.cloud.networkconnectivity.v1.IGetSpokeRequest): Promise<google.cloud.networkconnectivity.v1.Spoke>;

Calls GetSpoke.

Parameter
Name Description
request IGetSpokeRequest

GetSpokeRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.Spoke>

Promise

listGroups(request, callback)

public listGroups(request: google.cloud.networkconnectivity.v1.IListGroupsRequest, callback: google.cloud.networkconnectivity.v1.HubService.ListGroupsCallback): void;

Calls ListGroups.

Parameters
Name Description
request IListGroupsRequest

ListGroupsRequest message or plain object
callback ListGroupsCallback

Node-style callback called with the error, if any, and ListGroupsResponse
Returns
Type Description
void

listGroups(request)

public listGroups(request: google.cloud.networkconnectivity.v1.IListGroupsRequest): Promise<google.cloud.networkconnectivity.v1.ListGroupsResponse>;

Calls ListGroups.

Parameter
Name Description
request IListGroupsRequest

ListGroupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.ListGroupsResponse>

Promise

listHubs(request, callback)

public listHubs(request: google.cloud.networkconnectivity.v1.IListHubsRequest, callback: google.cloud.networkconnectivity.v1.HubService.ListHubsCallback): void;

Calls ListHubs.

Parameters
Name Description
request IListHubsRequest

ListHubsRequest message or plain object
callback ListHubsCallback

Node-style callback called with the error, if any, and ListHubsResponse
Returns
Type Description
void

listHubs(request)

public listHubs(request: google.cloud.networkconnectivity.v1.IListHubsRequest): Promise<google.cloud.networkconnectivity.v1.ListHubsResponse>;

Calls ListHubs.

Parameter
Name Description
request IListHubsRequest

ListHubsRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.ListHubsResponse>

Promise

listHubSpokes(request, callback)

public listHubSpokes(request: google.cloud.networkconnectivity.v1.IListHubSpokesRequest, callback: google.cloud.networkconnectivity.v1.HubService.ListHubSpokesCallback): void;

Calls ListHubSpokes.

Parameters
Name Description
request IListHubSpokesRequest

ListHubSpokesRequest message or plain object
callback ListHubSpokesCallback

Node-style callback called with the error, if any, and ListHubSpokesResponse
Returns
Type Description
void

listHubSpokes(request)

public listHubSpokes(request: google.cloud.networkconnectivity.v1.IListHubSpokesRequest): Promise<google.cloud.networkconnectivity.v1.ListHubSpokesResponse>;

Calls ListHubSpokes.

Parameter
Name Description
request IListHubSpokesRequest

ListHubSpokesRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.ListHubSpokesResponse>

Promise

listRoutes(request, callback)

public listRoutes(request: google.cloud.networkconnectivity.v1.IListRoutesRequest, callback: google.cloud.networkconnectivity.v1.HubService.ListRoutesCallback): void;

Calls ListRoutes.

Parameters
Name Description
request IListRoutesRequest

ListRoutesRequest message or plain object
callback ListRoutesCallback

Node-style callback called with the error, if any, and ListRoutesResponse
Returns
Type Description
void

listRoutes(request)

public listRoutes(request: google.cloud.networkconnectivity.v1.IListRoutesRequest): Promise<google.cloud.networkconnectivity.v1.ListRoutesResponse>;

Calls ListRoutes.

Parameter
Name Description
request IListRoutesRequest

ListRoutesRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.ListRoutesResponse>

Promise

listRouteTables(request, callback)

public listRouteTables(request: google.cloud.networkconnectivity.v1.IListRouteTablesRequest, callback: google.cloud.networkconnectivity.v1.HubService.ListRouteTablesCallback): void;

Calls ListRouteTables.

Parameters
Name Description
request IListRouteTablesRequest

ListRouteTablesRequest message or plain object
callback ListRouteTablesCallback

Node-style callback called with the error, if any, and ListRouteTablesResponse
Returns
Type Description
void

listRouteTables(request)

public listRouteTables(request: google.cloud.networkconnectivity.v1.IListRouteTablesRequest): Promise<google.cloud.networkconnectivity.v1.ListRouteTablesResponse>;

Calls ListRouteTables.

Parameter
Name Description
request IListRouteTablesRequest

ListRouteTablesRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.ListRouteTablesResponse>

Promise

listSpokes(request, callback)

public listSpokes(request: google.cloud.networkconnectivity.v1.IListSpokesRequest, callback: google.cloud.networkconnectivity.v1.HubService.ListSpokesCallback): void;

Calls ListSpokes.

Parameters
Name Description
request IListSpokesRequest

ListSpokesRequest message or plain object
callback ListSpokesCallback

Node-style callback called with the error, if any, and ListSpokesResponse
Returns
Type Description
void

listSpokes(request)

public listSpokes(request: google.cloud.networkconnectivity.v1.IListSpokesRequest): Promise<google.cloud.networkconnectivity.v1.ListSpokesResponse>;

Calls ListSpokes.

Parameter
Name Description
request IListSpokesRequest

ListSpokesRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.ListSpokesResponse>

Promise

queryHubStatus(request, callback)

public queryHubStatus(request: google.cloud.networkconnectivity.v1.IQueryHubStatusRequest, callback: google.cloud.networkconnectivity.v1.HubService.QueryHubStatusCallback): void;

Calls QueryHubStatus.

Parameters
Name Description
request IQueryHubStatusRequest

QueryHubStatusRequest message or plain object
callback QueryHubStatusCallback

Node-style callback called with the error, if any, and QueryHubStatusResponse
Returns
Type Description
void

queryHubStatus(request)

public queryHubStatus(request: google.cloud.networkconnectivity.v1.IQueryHubStatusRequest): Promise<google.cloud.networkconnectivity.v1.QueryHubStatusResponse>;

Calls QueryHubStatus.

Parameter
Name Description
request IQueryHubStatusRequest

QueryHubStatusRequest message or plain object
Returns
Type Description
Promise<google.cloud.networkconnectivity.v1.QueryHubStatusResponse>

Promise

rejectHubSpoke(request, callback)

public rejectHubSpoke(request: google.cloud.networkconnectivity.v1.IRejectHubSpokeRequest, callback: google.cloud.networkconnectivity.v1.HubService.RejectHubSpokeCallback): void;

Calls RejectHubSpoke.

Parameters
Name Description
request IRejectHubSpokeRequest

RejectHubSpokeRequest message or plain object
callback RejectHubSpokeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

rejectHubSpoke(request)

public rejectHubSpoke(request: google.cloud.networkconnectivity.v1.IRejectHubSpokeRequest): Promise<google.longrunning.Operation>;

Calls RejectHubSpoke.

Parameter
Name Description
request IRejectHubSpokeRequest

RejectHubSpokeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

rejectSpokeUpdate(request, callback)

public rejectSpokeUpdate(request: google.cloud.networkconnectivity.v1.IRejectSpokeUpdateRequest, callback: google.cloud.networkconnectivity.v1.HubService.RejectSpokeUpdateCallback): void;

Calls RejectSpokeUpdate.

Parameters
Name Description
request IRejectSpokeUpdateRequest

RejectSpokeUpdateRequest message or plain object
callback RejectSpokeUpdateCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

rejectSpokeUpdate(request)

public rejectSpokeUpdate(request: google.cloud.networkconnectivity.v1.IRejectSpokeUpdateRequest): Promise<google.longrunning.Operation>;

Calls RejectSpokeUpdate.

Parameter
Name Description
request IRejectSpokeUpdateRequest

RejectSpokeUpdateRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateGroup(request, callback)

public updateGroup(request: google.cloud.networkconnectivity.v1.IUpdateGroupRequest, callback: google.cloud.networkconnectivity.v1.HubService.UpdateGroupCallback): void;

Calls UpdateGroup.

Parameters
Name Description
request IUpdateGroupRequest

UpdateGroupRequest message or plain object
callback UpdateGroupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateGroup(request)

public updateGroup(request: google.cloud.networkconnectivity.v1.IUpdateGroupRequest): Promise<google.longrunning.Operation>;

Calls UpdateGroup.

Parameter
Name Description
request IUpdateGroupRequest

UpdateGroupRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateHub(request, callback)

public updateHub(request: google.cloud.networkconnectivity.v1.IUpdateHubRequest, callback: google.cloud.networkconnectivity.v1.HubService.UpdateHubCallback): void;

Calls UpdateHub.

Parameters
Name Description
request IUpdateHubRequest

UpdateHubRequest message or plain object
callback UpdateHubCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateHub(request)

public updateHub(request: google.cloud.networkconnectivity.v1.IUpdateHubRequest): Promise<google.longrunning.Operation>;

Calls UpdateHub.

Parameter
Name Description
request IUpdateHubRequest

UpdateHubRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateSpoke(request, callback)

public updateSpoke(request: google.cloud.networkconnectivity.v1.IUpdateSpokeRequest, callback: google.cloud.networkconnectivity.v1.HubService.UpdateSpokeCallback): void;

Calls UpdateSpoke.

Parameters
Name Description
request IUpdateSpokeRequest

UpdateSpokeRequest message or plain object
callback UpdateSpokeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateSpoke(request)

public updateSpoke(request: google.cloud.networkconnectivity.v1.IUpdateSpokeRequest): Promise<google.longrunning.Operation>;

Calls UpdateSpoke.

Parameter
Name Description
request IUpdateSpokeRequest

UpdateSpokeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise