HubService - Documentation

HubService

google .cloud .networkconnectivity .v1. HubService

Represents a HubService

Constructor

new HubService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new HubService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

acceptHubSpoke(request, callback) → {undefined}

Calls AcceptHubSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IAcceptHubSpokeRequest	AcceptHubSpokeRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.AcceptHubSpokeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

acceptHubSpoke(request) → {Promise.<google.longrunning.Operation>}

Calls AcceptHubSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IAcceptHubSpokeRequest	AcceptHubSpokeRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createHub(request, callback) → {undefined}

Calls CreateHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.ICreateHubRequest	CreateHubRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.CreateHubCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createHub(request) → {Promise.<google.longrunning.Operation>}

Calls CreateHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.ICreateHubRequest	CreateHubRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createSpoke(request, callback) → {undefined}

Calls CreateSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.ICreateSpokeRequest	CreateSpokeRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.CreateSpokeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createSpoke(request) → {Promise.<google.longrunning.Operation>}

Calls CreateSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.ICreateSpokeRequest	CreateSpokeRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteHub(request, callback) → {undefined}

Calls DeleteHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IDeleteHubRequest	DeleteHubRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.DeleteHubCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteHub(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IDeleteHubRequest	DeleteHubRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteSpoke(request, callback) → {undefined}

Calls DeleteSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IDeleteSpokeRequest	DeleteSpokeRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.DeleteSpokeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteSpoke(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IDeleteSpokeRequest	DeleteSpokeRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

getGroup(request, callback) → {undefined}

Calls GetGroup.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetGroupRequest	GetGroupRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.GetGroupCallback	Node-style callback called with the error, if any, and Group

Returns:

Type	Description
undefined

getGroup(request) → {Promise.<google.cloud.networkconnectivity.v1.Group>}

Calls GetGroup.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetGroupRequest	GetGroupRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.Group>	Promise

getHub(request, callback) → {undefined}

Calls GetHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetHubRequest	GetHubRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.GetHubCallback	Node-style callback called with the error, if any, and Hub

Returns:

Type	Description
undefined

getHub(request) → {Promise.<google.cloud.networkconnectivity.v1.Hub>}

Calls GetHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetHubRequest	GetHubRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.Hub>	Promise

getRoute(request, callback) → {undefined}

Calls GetRoute.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetRouteRequest	GetRouteRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.GetRouteCallback	Node-style callback called with the error, if any, and Route

Returns:

Type	Description
undefined

getRoute(request) → {Promise.<google.cloud.networkconnectivity.v1.Route>}

Calls GetRoute.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetRouteRequest	GetRouteRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.Route>	Promise

getRouteTable(request, callback) → {undefined}

Calls GetRouteTable.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetRouteTableRequest	GetRouteTableRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.GetRouteTableCallback	Node-style callback called with the error, if any, and RouteTable

Returns:

Type	Description
undefined

getRouteTable(request) → {Promise.<google.cloud.networkconnectivity.v1.RouteTable>}

Calls GetRouteTable.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetRouteTableRequest	GetRouteTableRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.RouteTable>	Promise

getSpoke(request, callback) → {undefined}

Calls GetSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetSpokeRequest	GetSpokeRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.GetSpokeCallback	Node-style callback called with the error, if any, and Spoke

Returns:

Type	Description
undefined

getSpoke(request) → {Promise.<google.cloud.networkconnectivity.v1.Spoke>}

Calls GetSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IGetSpokeRequest	GetSpokeRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.Spoke>	Promise

listGroups(request, callback) → {undefined}

Calls ListGroups.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListGroupsRequest	ListGroupsRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.ListGroupsCallback	Node-style callback called with the error, if any, and ListGroupsResponse

Returns:

Type	Description
undefined

listGroups(request) → {Promise.<google.cloud.networkconnectivity.v1.ListGroupsResponse>}

Calls ListGroups.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListGroupsRequest	ListGroupsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.ListGroupsResponse>	Promise

listHubSpokes(request, callback) → {undefined}

Calls ListHubSpokes.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListHubSpokesRequest	ListHubSpokesRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.ListHubSpokesCallback	Node-style callback called with the error, if any, and ListHubSpokesResponse

Returns:

Type	Description
undefined

listHubSpokes(request) → {Promise.<google.cloud.networkconnectivity.v1.ListHubSpokesResponse>}

Calls ListHubSpokes.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListHubSpokesRequest	ListHubSpokesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.ListHubSpokesResponse>	Promise

listHubs(request, callback) → {undefined}

Calls ListHubs.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListHubsRequest	ListHubsRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.ListHubsCallback	Node-style callback called with the error, if any, and ListHubsResponse

Returns:

Type	Description
undefined

listHubs(request) → {Promise.<google.cloud.networkconnectivity.v1.ListHubsResponse>}

Calls ListHubs.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListHubsRequest	ListHubsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.ListHubsResponse>	Promise

listRouteTables(request, callback) → {undefined}

Calls ListRouteTables.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListRouteTablesRequest	ListRouteTablesRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.ListRouteTablesCallback	Node-style callback called with the error, if any, and ListRouteTablesResponse

Returns:

Type	Description
undefined

listRouteTables(request) → {Promise.<google.cloud.networkconnectivity.v1.ListRouteTablesResponse>}

Calls ListRouteTables.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListRouteTablesRequest	ListRouteTablesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.ListRouteTablesResponse>	Promise

listRoutes(request, callback) → {undefined}

Calls ListRoutes.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListRoutesRequest	ListRoutesRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.ListRoutesCallback	Node-style callback called with the error, if any, and ListRoutesResponse

Returns:

Type	Description
undefined

listRoutes(request) → {Promise.<google.cloud.networkconnectivity.v1.ListRoutesResponse>}

Calls ListRoutes.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListRoutesRequest	ListRoutesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.ListRoutesResponse>	Promise

listSpokes(request, callback) → {undefined}

Calls ListSpokes.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListSpokesRequest	ListSpokesRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.ListSpokesCallback	Node-style callback called with the error, if any, and ListSpokesResponse

Returns:

Type	Description
undefined

listSpokes(request) → {Promise.<google.cloud.networkconnectivity.v1.ListSpokesResponse>}

Calls ListSpokes.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IListSpokesRequest	ListSpokesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.networkconnectivity.v1.ListSpokesResponse>	Promise

rejectHubSpoke(request, callback) → {undefined}

Calls RejectHubSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IRejectHubSpokeRequest	RejectHubSpokeRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.RejectHubSpokeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

rejectHubSpoke(request) → {Promise.<google.longrunning.Operation>}

Calls RejectHubSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IRejectHubSpokeRequest	RejectHubSpokeRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateHub(request, callback) → {undefined}

Calls UpdateHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IUpdateHubRequest	UpdateHubRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.UpdateHubCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateHub(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateHub.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IUpdateHubRequest	UpdateHubRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateSpoke(request, callback) → {undefined}

Calls UpdateSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IUpdateSpokeRequest	UpdateSpokeRequest message or plain object
`callback`	google.cloud.networkconnectivity.v1.HubService.UpdateSpokeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateSpoke(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateSpoke.

Parameters:

Name	Type	Description
`request`	google.cloud.networkconnectivity.v1.IUpdateSpokeRequest	UpdateSpokeRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {HubService}

Creates new HubService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

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

Type Definitions

AcceptHubSpokeCallback(error, responseopt)

Callback as used by acceptHubSpoke.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateHubCallback(error, responseopt)

Callback as used by createHub.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateSpokeCallback(error, responseopt)

Callback as used by createSpoke.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteHubCallback(error, responseopt)

Callback as used by deleteHub.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteSpokeCallback(error, responseopt)

Callback as used by deleteSpoke.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetGroupCallback(error, responseopt)

Callback as used by getGroup.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.Group	<optional>	Group

GetHubCallback(error, responseopt)

Callback as used by getHub.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.Hub	<optional>	Hub

GetRouteCallback(error, responseopt)

Callback as used by getRoute.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.Route	<optional>	Route

GetRouteTableCallback(error, responseopt)

Callback as used by getRouteTable.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.RouteTable	<optional>	RouteTable

GetSpokeCallback(error, responseopt)

Callback as used by getSpoke.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.Spoke	<optional>	Spoke

ListGroupsCallback(error, responseopt)

Callback as used by listGroups.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.ListGroupsResponse	<optional>	ListGroupsResponse

ListHubSpokesCallback(error, responseopt)

Callback as used by listHubSpokes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.ListHubSpokesResponse	<optional>	ListHubSpokesResponse

ListHubsCallback(error, responseopt)

Callback as used by listHubs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.ListHubsResponse	<optional>	ListHubsResponse

ListRouteTablesCallback(error, responseopt)

Callback as used by listRouteTables.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.ListRouteTablesResponse	<optional>	ListRouteTablesResponse

ListRoutesCallback(error, responseopt)

Callback as used by listRoutes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.ListRoutesResponse	<optional>	ListRoutesResponse

ListSpokesCallback(error, responseopt)

Callback as used by listSpokes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.networkconnectivity.v1.ListSpokesResponse	<optional>	ListSpokesResponse

RejectHubSpokeCallback(error, responseopt)

Callback as used by rejectHubSpoke.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateHubCallback(error, responseopt)

Callback as used by updateHub.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateSpokeCallback(error, responseopt)

Callback as used by updateSpoke.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation