Class EndpointService

constructor

• new EndpointService(sdk: SDKInterface): EndpointService

  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>>

  Parameters

  • request: CreateEndpointRequest
  • metadata: Metadata

  Returns Request<CreateEndpointRequest, Operation<GetOperationRequest>>

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

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

  Delete an endpoint.

  Parameters

  • request: DeleteRequest

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

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

  Parameters

  • request: DeleteRequest
  • metadata: Metadata

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

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

  Parameters

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

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

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

  Delete an endpoint.

  Parameters

  • request: DeleteRequest

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

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

  Delete an endpoint.

  Parameters

  • request: DeleteRequest
  • metadata: Metadata

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

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

  Delete an endpoint.

  Parameters

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

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

get

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

  Returns the specified endpoint.

  Parameters

  • request: GetRequest

  Returns Request<GetRequest, Endpoint>

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

  Parameters

  • request: GetRequest
  • metadata: Metadata

  Returns Request<GetRequest, Endpoint>

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

  Parameters

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

  Returns Request<GetRequest, Endpoint>

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

  Returns the specified endpoint.

  Parameters

  • request: GetRequest

  Returns Request<GetRequest, Endpoint>

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

  Returns the specified endpoint.

  Parameters

  • request: GetRequest
  • metadata: Metadata

  Returns Request<GetRequest, Endpoint>

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

  Returns the specified endpoint.

  Parameters

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

  Returns Request<GetRequest, Endpoint>

getByName

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

  Returns the specified endpoint by name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Endpoint>

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

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Endpoint>

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

  Parameters

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

  Returns Request<GetByNameRequest, Endpoint>

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

  Returns the specified endpoint by name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Endpoint>

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

  Returns the specified endpoint by name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Endpoint>

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

  Returns the specified endpoint by name.

  Parameters

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

  Returns Request<GetByNameRequest, Endpoint>

getOperationService

• getOperationService(): OperationService

  Returns OperationService

list

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

  Retrieves a list of Endpoints.

  Parameters

  • request: ListRequest

  Returns Request<ListRequest, ListEndpointsResponse>

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

  Parameters

  • request: ListRequest
  • metadata: Metadata

  Returns Request<ListRequest, ListEndpointsResponse>

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

  Parameters

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

  Returns Request<ListRequest, ListEndpointsResponse>

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

  Retrieves a list of Endpoints.

  Parameters

  • request: ListRequest

  Returns Request<ListRequest, ListEndpointsResponse>

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

  Retrieves a list of Endpoints.

  Parameters

  • request: ListRequest
  • metadata: Metadata

  Returns Request<ListRequest, ListEndpointsResponse>

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

  Retrieves a list of Endpoints.

  Parameters

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

  Returns Request<ListRequest, ListEndpointsResponse>

start

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

  Start an endpoint.

  Parameters

  • request: StartRequest

  Returns Request<StartRequest, Operation<GetOperationRequest>>

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

  Parameters

  • request: StartRequest
  • metadata: Metadata

  Returns Request<StartRequest, Operation<GetOperationRequest>>

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

  Parameters

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

  Returns Request<StartRequest, Operation<GetOperationRequest>>

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

  Start an endpoint.

  Parameters

  • request: StartRequest

  Returns Request<StartRequest, Operation<GetOperationRequest>>

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

  Start an endpoint.

  Parameters

  • request: StartRequest
  • metadata: Metadata

  Returns Request<StartRequest, Operation<GetOperationRequest>>

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

  Start an endpoint.

  Parameters

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

  Returns Request<StartRequest, Operation<GetOperationRequest>>

stop

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

  Stop an endpoint.

  Parameters

  • request: StopRequest

  Returns Request<StopRequest, Operation<GetOperationRequest>>

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

  Parameters

  • request: StopRequest
  • metadata: Metadata

  Returns Request<StopRequest, Operation<GetOperationRequest>>

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

  Parameters

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

  Returns Request<StopRequest, Operation<GetOperationRequest>>

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

  Stop an endpoint.

  Parameters

  • request: StopRequest

  Returns Request<StopRequest, Operation<GetOperationRequest>>

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

  Stop an endpoint.

  Parameters

  • request: StopRequest
  • metadata: Metadata

  Returns Request<StopRequest, Operation<GetOperationRequest>>

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

  Stop an endpoint.

  Parameters

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

  Returns Request<StopRequest, Operation<GetOperationRequest>>