Class RouteService

constructor

• new RouteService(sdk: SDKInterface): RouteService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns RouteService

$type

create

• create(
      request: CreateRouteRequest,
  ): Request<CreateRouteRequest, Operation<GetOperationRequest>>

  Creates a new route with the specified configuration.

  Parameters

  • request: CreateRouteRequest

  Returns Request<CreateRouteRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRouteRequest,
      metadata: Metadata,
  ): Request<CreateRouteRequest, Operation<GetOperationRequest>>

  Creates a new route with the specified configuration.

  Parameters

  • request: CreateRouteRequest
  • metadata: Metadata

  Returns Request<CreateRouteRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateRouteRequest, Operation<GetOperationRequest>>

  Creates a new route with the specified configuration.

  Parameters

  • request: CreateRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateRouteRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRouteRequest,
  ): Request<CreateRouteRequest, Operation<GetOperationRequest>>

  Creates a new route with the specified configuration.

  Parameters

  • request: CreateRouteRequest

  Returns Request<CreateRouteRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRouteRequest,
      metadata: Metadata,
  ): Request<CreateRouteRequest, Operation<GetOperationRequest>>

  Creates a new route with the specified configuration.

  Parameters

  • request: CreateRouteRequest
  • metadata: Metadata

  Returns Request<CreateRouteRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateRouteRequest, Operation<GetOperationRequest>>

  Creates a new route with the specified configuration.

  Parameters

  • request: CreateRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateRouteRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteRouteRequest,
  ): Request<DeleteRouteRequest, Operation<GetOperationRequest>>

  Deletes a route by its ID.

  Parameters

  • request: DeleteRouteRequest

  Returns Request<DeleteRouteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRouteRequest,
      metadata: Metadata,
  ): Request<DeleteRouteRequest, Operation<GetOperationRequest>>

  Deletes a route by its ID.

  Parameters

  • request: DeleteRouteRequest
  • metadata: Metadata

  Returns Request<DeleteRouteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteRouteRequest, Operation<GetOperationRequest>>

  Deletes a route by its ID.

  Parameters

  • request: DeleteRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteRouteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRouteRequest,
  ): Request<DeleteRouteRequest, Operation<GetOperationRequest>>

  Deletes a route by its ID.

  Parameters

  • request: DeleteRouteRequest

  Returns Request<DeleteRouteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRouteRequest,
      metadata: Metadata,
  ): Request<DeleteRouteRequest, Operation<GetOperationRequest>>

  Deletes a route by its ID.

  Parameters

  • request: DeleteRouteRequest
  • metadata: Metadata

  Returns Request<DeleteRouteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteRouteRequest, Operation<GetOperationRequest>>

  Deletes a route by its ID.

  Parameters

  • request: DeleteRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteRouteRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListRoutesRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Route>

  Calls the filter method.

  Parameters

  • request: ListRoutesRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Route>

• filter(
      request: ListRoutesRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Route>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListRoutesRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Route>

get

• get(request: GetRouteRequest): Request<GetRouteRequest, Route>

  Retrieves a route by its ID.

  Parameters

  • request: GetRouteRequest

  Returns Request<GetRouteRequest, Route>

• get(
      request: GetRouteRequest,
      metadata: Metadata,
  ): Request<GetRouteRequest, Route>

  Retrieves a route by its ID.

  Parameters

  • request: GetRouteRequest
  • metadata: Metadata

  Returns Request<GetRouteRequest, Route>

• get(
      request: GetRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRouteRequest, Route>

  Retrieves a route by its ID.

  Parameters

  • request: GetRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRouteRequest, Route>

• get(request: GetRouteRequest): Request<GetRouteRequest, Route>

  Retrieves a route by its ID.

  Parameters

  • request: GetRouteRequest

  Returns Request<GetRouteRequest, Route>

• get(
      request: GetRouteRequest,
      metadata: Metadata,
  ): Request<GetRouteRequest, Route>

  Retrieves a route by its ID.

  Parameters

  • request: GetRouteRequest
  • metadata: Metadata

  Returns Request<GetRouteRequest, Route>

• get(
      request: GetRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRouteRequest, Route>

  Retrieves a route by its ID.

  Parameters

  • request: GetRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRouteRequest, Route>

getByName

• getByName(request: GetRouteByNameRequest): Request<GetRouteByNameRequest, Route>

  Retrieves a route by its name within a specified route table.

  Parameters

  • request: GetRouteByNameRequest

  Returns Request<GetRouteByNameRequest, Route>

• getByName(
      request: GetRouteByNameRequest,
      metadata: Metadata,
  ): Request<GetRouteByNameRequest, Route>

  Retrieves a route by its name within a specified route table.

  Parameters

  • request: GetRouteByNameRequest
  • metadata: Metadata

  Returns Request<GetRouteByNameRequest, Route>

• getByName(
      request: GetRouteByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRouteByNameRequest, Route>

  Retrieves a route by its name within a specified route table.

  Parameters

  • request: GetRouteByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRouteByNameRequest, Route>

• getByName(request: GetRouteByNameRequest): Request<GetRouteByNameRequest, Route>

  Retrieves a route by its name within a specified route table.

  Parameters

  • request: GetRouteByNameRequest

  Returns Request<GetRouteByNameRequest, Route>

• getByName(
      request: GetRouteByNameRequest,
      metadata: Metadata,
  ): Request<GetRouteByNameRequest, Route>

  Retrieves a route by its name within a specified route table.

  Parameters

  • request: GetRouteByNameRequest
  • metadata: Metadata

  Returns Request<GetRouteByNameRequest, Route>

• getByName(
      request: GetRouteByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRouteByNameRequest, Route>

  Retrieves a route by its name within a specified route table.

  Parameters

  • request: GetRouteByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRouteByNameRequest, Route>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(request: ListRoutesRequest): Request<ListRoutesRequest, ListRoutesResponse>

  Lists routes in a specified route table.

  Parameters

  • request: ListRoutesRequest

  Returns Request<ListRoutesRequest, ListRoutesResponse>

• list(
      request: ListRoutesRequest,
      metadata: Metadata,
  ): Request<ListRoutesRequest, ListRoutesResponse>

  Lists routes in a specified route table.

  Parameters

  • request: ListRoutesRequest
  • metadata: Metadata

  Returns Request<ListRoutesRequest, ListRoutesResponse>

• list(
      request: ListRoutesRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRoutesRequest, ListRoutesResponse>

  Lists routes in a specified route table.

  Parameters

  • request: ListRoutesRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRoutesRequest, ListRoutesResponse>

• list(request: ListRoutesRequest): Request<ListRoutesRequest, ListRoutesResponse>

  Lists routes in a specified route table.

  Parameters

  • request: ListRoutesRequest

  Returns Request<ListRoutesRequest, ListRoutesResponse>

• list(
      request: ListRoutesRequest,
      metadata: Metadata,
  ): Request<ListRoutesRequest, ListRoutesResponse>

  Lists routes in a specified route table.

  Parameters

  • request: ListRoutesRequest
  • metadata: Metadata

  Returns Request<ListRoutesRequest, ListRoutesResponse>

• list(
      request: ListRoutesRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRoutesRequest, ListRoutesResponse>

  Lists routes in a specified route table.

  Parameters

  • request: ListRoutesRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRoutesRequest, ListRoutesResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

update

• update(
      request: UpdateRouteRequest,
  ): Request<UpdateRouteRequest, Operation<GetOperationRequest>>

  Updates an existing route with new configuration parameters.

  Parameters

  • request: UpdateRouteRequest

  Returns Request<UpdateRouteRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRouteRequest,
      metadata: Metadata,
  ): Request<UpdateRouteRequest, Operation<GetOperationRequest>>

  Updates an existing route with new configuration parameters.

  Parameters

  • request: UpdateRouteRequest
  • metadata: Metadata

  Returns Request<UpdateRouteRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateRouteRequest, Operation<GetOperationRequest>>

  Updates an existing route with new configuration parameters.

  Parameters

  • request: UpdateRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateRouteRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRouteRequest,
  ): Request<UpdateRouteRequest, Operation<GetOperationRequest>>

  Updates an existing route with new configuration parameters.

  Parameters

  • request: UpdateRouteRequest

  Returns Request<UpdateRouteRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRouteRequest,
      metadata: Metadata,
  ): Request<UpdateRouteRequest, Operation<GetOperationRequest>>

  Updates an existing route with new configuration parameters.

  Parameters

  • request: UpdateRouteRequest
  • metadata: Metadata

  Returns Request<UpdateRouteRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRouteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateRouteRequest, Operation<GetOperationRequest>>

  Updates an existing route with new configuration parameters.

  Parameters

  • request: UpdateRouteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateRouteRequest, Operation<GetOperationRequest>>