Class TunnelService

constructor

• new TunnelService(sdk: SDKInterface): TunnelService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns TunnelService

$type

create

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

  Creates a new tunnel.

  Parameters

  • request: CreateTunnelRequest

  Returns Request<CreateTunnelRequest, Operation<GetOperationRequest>>

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

  Creates a new tunnel.

  Parameters

  • request: CreateTunnelRequest
  • metadata: Metadata

  Returns Request<CreateTunnelRequest, Operation<GetOperationRequest>>

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

  Creates a new tunnel.

  Parameters

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

  Returns Request<CreateTunnelRequest, Operation<GetOperationRequest>>

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

  Creates a new tunnel.

  Parameters

  • request: CreateTunnelRequest

  Returns Request<CreateTunnelRequest, Operation<GetOperationRequest>>

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

  Creates a new tunnel.

  Parameters

  • request: CreateTunnelRequest
  • metadata: Metadata

  Returns Request<CreateTunnelRequest, Operation<GetOperationRequest>>

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

  Creates a new tunnel.

  Parameters

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

  Returns Request<CreateTunnelRequest, Operation<GetOperationRequest>>

delete

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

  Deletes a tunnel by its identifier.

  Parameters

  • request: DeleteTunnelRequest

  Returns Request<DeleteTunnelRequest, Operation<GetOperationRequest>>

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

  Deletes a tunnel by its identifier.

  Parameters

  • request: DeleteTunnelRequest
  • metadata: Metadata

  Returns Request<DeleteTunnelRequest, Operation<GetOperationRequest>>

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

  Deletes a tunnel by its identifier.

  Parameters

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

  Returns Request<DeleteTunnelRequest, Operation<GetOperationRequest>>

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

  Deletes a tunnel by its identifier.

  Parameters

  • request: DeleteTunnelRequest

  Returns Request<DeleteTunnelRequest, Operation<GetOperationRequest>>

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

  Deletes a tunnel by its identifier.

  Parameters

  • request: DeleteTunnelRequest
  • metadata: Metadata

  Returns Request<DeleteTunnelRequest, Operation<GetOperationRequest>>

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

  Deletes a tunnel by its identifier.

  Parameters

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

  Returns Request<DeleteTunnelRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<Tunnel>

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

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

  Parameters

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

  Returns AsyncGenerator<Tunnel>

get

• get(request: GetTunnelRequest): Request<GetTunnelRequest, Tunnel>

  Retrieves a tunnel by its identifier.

  Parameters

  • request: GetTunnelRequest

  Returns Request<GetTunnelRequest, Tunnel>

• get(
      request: GetTunnelRequest,
      metadata: Metadata,
  ): Request<GetTunnelRequest, Tunnel>

  Retrieves a tunnel by its identifier.

  Parameters

  • request: GetTunnelRequest
  • metadata: Metadata

  Returns Request<GetTunnelRequest, Tunnel>

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

  Retrieves a tunnel by its identifier.

  Parameters

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

  Returns Request<GetTunnelRequest, Tunnel>

• get(request: GetTunnelRequest): Request<GetTunnelRequest, Tunnel>

  Retrieves a tunnel by its identifier.

  Parameters

  • request: GetTunnelRequest

  Returns Request<GetTunnelRequest, Tunnel>

• get(
      request: GetTunnelRequest,
      metadata: Metadata,
  ): Request<GetTunnelRequest, Tunnel>

  Retrieves a tunnel by its identifier.

  Parameters

  • request: GetTunnelRequest
  • metadata: Metadata

  Returns Request<GetTunnelRequest, Tunnel>

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

  Retrieves a tunnel by its identifier.

  Parameters

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

  Returns Request<GetTunnelRequest, Tunnel>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListTunnelRequest,
  ): Request<ListTunnelRequest, ListTunnelsResponse>

  Lists all tunnels within a parent.

  Parameters

  • request: ListTunnelRequest

  Returns Request<ListTunnelRequest, ListTunnelsResponse>

• list(
      request: ListTunnelRequest,
      metadata: Metadata,
  ): Request<ListTunnelRequest, ListTunnelsResponse>

  Lists all tunnels within a parent.

  Parameters

  • request: ListTunnelRequest
  • metadata: Metadata

  Returns Request<ListTunnelRequest, ListTunnelsResponse>

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

  Lists all tunnels within a parent.

  Parameters

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

  Returns Request<ListTunnelRequest, ListTunnelsResponse>

• list(
      request: ListTunnelRequest,
  ): Request<ListTunnelRequest, ListTunnelsResponse>

  Lists all tunnels within a parent.

  Parameters

  • request: ListTunnelRequest

  Returns Request<ListTunnelRequest, ListTunnelsResponse>

• list(
      request: ListTunnelRequest,
      metadata: Metadata,
  ): Request<ListTunnelRequest, ListTunnelsResponse>

  Lists all tunnels within a parent.

  Parameters

  • request: ListTunnelRequest
  • metadata: Metadata

  Returns Request<ListTunnelRequest, ListTunnelsResponse>

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

  Lists all tunnels within a parent.

  Parameters

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

  Returns Request<ListTunnelRequest, ListTunnelsResponse>

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: UpdateTunnelRequest,
  ): Request<UpdateTunnelRequest, Operation<GetOperationRequest>>

  Updates an existing tunnel.

  Parameters

  • request: UpdateTunnelRequest

  Returns Request<UpdateTunnelRequest, Operation<GetOperationRequest>>

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

  Updates an existing tunnel.

  Parameters

  • request: UpdateTunnelRequest
  • metadata: Metadata

  Returns Request<UpdateTunnelRequest, Operation<GetOperationRequest>>

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

  Updates an existing tunnel.

  Parameters

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

  Returns Request<UpdateTunnelRequest, Operation<GetOperationRequest>>

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

  Updates an existing tunnel.

  Parameters

  • request: UpdateTunnelRequest

  Returns Request<UpdateTunnelRequest, Operation<GetOperationRequest>>

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

  Updates an existing tunnel.

  Parameters

  • request: UpdateTunnelRequest
  • metadata: Metadata

  Returns Request<UpdateTunnelRequest, Operation<GetOperationRequest>>

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

  Updates an existing tunnel.

  Parameters

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

  Returns Request<UpdateTunnelRequest, Operation<GetOperationRequest>>