Class EndpointService

constructor

• new EndpointService(sdk: SDKInterface): EndpointService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns EndpointService

$type

create

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

  Creates an endpoint.

  Parameters

  • request: CreateEndpointRequest

  Returns Request<CreateEndpointRequest, Operation<GetOperationRequest>>

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

  Creates an endpoint.

  Parameters

  • request: CreateEndpointRequest
  • metadata: Metadata

  Returns Request<CreateEndpointRequest, Operation<GetOperationRequest>>

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

  Creates an endpoint.

  Parameters

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

  Returns Request<CreateEndpointRequest, Operation<GetOperationRequest>>

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

  Creates an endpoint.

  Parameters

  • request: CreateEndpointRequest

  Returns Request<CreateEndpointRequest, Operation<GetOperationRequest>>

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

  Creates an endpoint.

  Parameters

  • request: CreateEndpointRequest
  • metadata: Metadata

  Returns Request<CreateEndpointRequest, Operation<GetOperationRequest>>

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

  Creates an endpoint.

  Parameters

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

  Returns Request<CreateEndpointRequest, Operation<GetOperationRequest>>

delete

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

  Deletes an endpoint.

  Parameters

  • request: DeleteEndpointRequest

  Returns Request<DeleteEndpointRequest, Operation<GetOperationRequest>>

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

  Deletes an endpoint.

  Parameters

  • request: DeleteEndpointRequest
  • metadata: Metadata

  Returns Request<DeleteEndpointRequest, Operation<GetOperationRequest>>

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

  Deletes an endpoint.

  Parameters

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

  Returns Request<DeleteEndpointRequest, Operation<GetOperationRequest>>

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

  Deletes an endpoint.

  Parameters

  • request: DeleteEndpointRequest

  Returns Request<DeleteEndpointRequest, Operation<GetOperationRequest>>

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

  Deletes an endpoint.

  Parameters

  • request: DeleteEndpointRequest
  • metadata: Metadata

  Returns Request<DeleteEndpointRequest, Operation<GetOperationRequest>>

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

  Deletes an endpoint.

  Parameters

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

  Returns Request<DeleteEndpointRequest, Operation<GetOperationRequest>>

get

• get(request: GetEndpointRequest): Request<GetEndpointRequest, Endpoint>

  Returns the specified endpoint.

  Parameters

  • request: GetEndpointRequest

  Returns Request<GetEndpointRequest, Endpoint>

• get(
      request: GetEndpointRequest,
      metadata: Metadata,
  ): Request<GetEndpointRequest, Endpoint>

  Returns the specified endpoint.

  Parameters

  • request: GetEndpointRequest
  • metadata: Metadata

  Returns Request<GetEndpointRequest, Endpoint>

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

  Returns the specified endpoint.

  Parameters

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

  Returns Request<GetEndpointRequest, Endpoint>

• get(request: GetEndpointRequest): Request<GetEndpointRequest, Endpoint>

  Returns the specified endpoint.

  Parameters

  • request: GetEndpointRequest

  Returns Request<GetEndpointRequest, Endpoint>

• get(
      request: GetEndpointRequest,
      metadata: Metadata,
  ): Request<GetEndpointRequest, Endpoint>

  Returns the specified endpoint.

  Parameters

  • request: GetEndpointRequest
  • metadata: Metadata

  Returns Request<GetEndpointRequest, Endpoint>

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

  Returns the specified endpoint.

  Parameters

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

  Returns Request<GetEndpointRequest, Endpoint>

getByName

• getByName(
      request: GetEndpointByNameRequest,
  ): Request<GetEndpointByNameRequest, Endpoint>

  Returns the specified endpoint by name.

  Parameters

  • request: GetEndpointByNameRequest

  Returns Request<GetEndpointByNameRequest, Endpoint>

• getByName(
      request: GetEndpointByNameRequest,
      metadata: Metadata,
  ): Request<GetEndpointByNameRequest, Endpoint>

  Returns the specified endpoint by name.

  Parameters

  • request: GetEndpointByNameRequest
  • metadata: Metadata

  Returns Request<GetEndpointByNameRequest, Endpoint>

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

  Returns the specified endpoint by name.

  Parameters

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

  Returns Request<GetEndpointByNameRequest, Endpoint>

• getByName(
      request: GetEndpointByNameRequest,
  ): Request<GetEndpointByNameRequest, Endpoint>

  Returns the specified endpoint by name.

  Parameters

  • request: GetEndpointByNameRequest

  Returns Request<GetEndpointByNameRequest, Endpoint>

• getByName(
      request: GetEndpointByNameRequest,
      metadata: Metadata,
  ): Request<GetEndpointByNameRequest, Endpoint>

  Returns the specified endpoint by name.

  Parameters

  • request: GetEndpointByNameRequest
  • metadata: Metadata

  Returns Request<GetEndpointByNameRequest, Endpoint>

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

  Returns the specified endpoint by name.

  Parameters

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

  Returns Request<GetEndpointByNameRequest, Endpoint>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListEndpointsRequest,
  ): Request<ListEndpointsRequest, ListEndpointsResponse>

  Retrieves a list of endpoints.

  Parameters

  • request: ListEndpointsRequest

  Returns Request<ListEndpointsRequest, ListEndpointsResponse>

• list(
      request: ListEndpointsRequest,
      metadata: Metadata,
  ): Request<ListEndpointsRequest, ListEndpointsResponse>

  Retrieves a list of endpoints.

  Parameters

  • request: ListEndpointsRequest
  • metadata: Metadata

  Returns Request<ListEndpointsRequest, ListEndpointsResponse>

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

  Retrieves a list of endpoints.

  Parameters

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

  Returns Request<ListEndpointsRequest, ListEndpointsResponse>

• list(
      request: ListEndpointsRequest,
  ): Request<ListEndpointsRequest, ListEndpointsResponse>

  Retrieves a list of endpoints.

  Parameters

  • request: ListEndpointsRequest

  Returns Request<ListEndpointsRequest, ListEndpointsResponse>

• list(
      request: ListEndpointsRequest,
      metadata: Metadata,
  ): Request<ListEndpointsRequest, ListEndpointsResponse>

  Retrieves a list of endpoints.

  Parameters

  • request: ListEndpointsRequest
  • metadata: Metadata

  Returns Request<ListEndpointsRequest, ListEndpointsResponse>

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

  Retrieves a list of endpoints.

  Parameters

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

  Returns Request<ListEndpointsRequest, ListEndpointsResponse>

restart

• restart(
      request: RestartEndpointRequest,
  ): Request<RestartEndpointRequest, Operation<GetOperationRequest>>

  Restarts an endpoint.

  Parameters

  • request: RestartEndpointRequest

  Returns Request<RestartEndpointRequest, Operation<GetOperationRequest>>

• restart(
      request: RestartEndpointRequest,
      metadata: Metadata,
  ): Request<RestartEndpointRequest, Operation<GetOperationRequest>>

  Restarts an endpoint.

  Parameters

  • request: RestartEndpointRequest
  • metadata: Metadata

  Returns Request<RestartEndpointRequest, Operation<GetOperationRequest>>

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

  Restarts an endpoint.

  Parameters

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

  Returns Request<RestartEndpointRequest, Operation<GetOperationRequest>>

• restart(
      request: RestartEndpointRequest,
  ): Request<RestartEndpointRequest, Operation<GetOperationRequest>>

  Restarts an endpoint.

  Parameters

  • request: RestartEndpointRequest

  Returns Request<RestartEndpointRequest, Operation<GetOperationRequest>>

• restart(
      request: RestartEndpointRequest,
      metadata: Metadata,
  ): Request<RestartEndpointRequest, Operation<GetOperationRequest>>

  Restarts an endpoint.

  Parameters

  • request: RestartEndpointRequest
  • metadata: Metadata

  Returns Request<RestartEndpointRequest, Operation<GetOperationRequest>>

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

  Restarts an endpoint.

  Parameters

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

  Returns Request<RestartEndpointRequest, Operation<GetOperationRequest>>

start

• start(
      request: StartEndpointRequest,
  ): Request<StartEndpointRequest, Operation<GetOperationRequest>>

  Starts an endpoint.

  Parameters

  • request: StartEndpointRequest

  Returns Request<StartEndpointRequest, Operation<GetOperationRequest>>

• start(
      request: StartEndpointRequest,
      metadata: Metadata,
  ): Request<StartEndpointRequest, Operation<GetOperationRequest>>

  Starts an endpoint.

  Parameters

  • request: StartEndpointRequest
  • metadata: Metadata

  Returns Request<StartEndpointRequest, Operation<GetOperationRequest>>

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

  Starts an endpoint.

  Parameters

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

  Returns Request<StartEndpointRequest, Operation<GetOperationRequest>>

• start(
      request: StartEndpointRequest,
  ): Request<StartEndpointRequest, Operation<GetOperationRequest>>

  Starts an endpoint.

  Parameters

  • request: StartEndpointRequest

  Returns Request<StartEndpointRequest, Operation<GetOperationRequest>>

• start(
      request: StartEndpointRequest,
      metadata: Metadata,
  ): Request<StartEndpointRequest, Operation<GetOperationRequest>>

  Starts an endpoint.

  Parameters

  • request: StartEndpointRequest
  • metadata: Metadata

  Returns Request<StartEndpointRequest, Operation<GetOperationRequest>>

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

  Starts an endpoint.

  Parameters

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

  Returns Request<StartEndpointRequest, Operation<GetOperationRequest>>

stop

• stop(
      request: StopEndpointRequest,
  ): Request<StopEndpointRequest, Operation<GetOperationRequest>>

  Stops an endpoint.

  Parameters

  • request: StopEndpointRequest

  Returns Request<StopEndpointRequest, Operation<GetOperationRequest>>

• stop(
      request: StopEndpointRequest,
      metadata: Metadata,
  ): Request<StopEndpointRequest, Operation<GetOperationRequest>>

  Stops an endpoint.

  Parameters

  • request: StopEndpointRequest
  • metadata: Metadata

  Returns Request<StopEndpointRequest, Operation<GetOperationRequest>>

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

  Stops an endpoint.

  Parameters

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

  Returns Request<StopEndpointRequest, Operation<GetOperationRequest>>

• stop(
      request: StopEndpointRequest,
  ): Request<StopEndpointRequest, Operation<GetOperationRequest>>

  Stops an endpoint.

  Parameters

  • request: StopEndpointRequest

  Returns Request<StopEndpointRequest, Operation<GetOperationRequest>>

• stop(
      request: StopEndpointRequest,
      metadata: Metadata,
  ): Request<StopEndpointRequest, Operation<GetOperationRequest>>

  Stops an endpoint.

  Parameters

  • request: StopEndpointRequest
  • metadata: Metadata

  Returns Request<StopEndpointRequest, Operation<GetOperationRequest>>

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

  Stops an endpoint.

  Parameters

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

  Returns Request<StopEndpointRequest, Operation<GetOperationRequest>>