get_or_create_endpoint: get_or_create_endpoint

Description Usage Arguments Details Value

View source: R/client_api_scaffold.R

Description

Attaches an endpoint to this Client.

Usage

1
2
3
4
5
6
7
8
get_or_create_endpoint(
  path = NULL,
  description = NULL,
  workspace = NULL,
  public_within_org = NULL,
  visibility = NULL,
  id = NULL
)

Arguments

path

Path for the endpoint.

description

Description of the endpoint.

workspace

Workspace under which the endpoint with name name exists. If not provided, the current

public_within_org

If creating an endpoint in an organization's workspace: True

visibility

Visibility to set when creating this endpoint. If not provided, an

id

ID of the endpoint. This parameter cannot be provided alongside name, and other

Details

If an accessible endpoint with name 'path' does not already exist, it will be created and initialized with specified metadata parameters. If such an endpoint does already exist, it will be retrieved; specifying metadata parameters in this case will raise a warning.

Value

:class:'verta.endpoint._endpoint.Endpoint'


botchkoAI/vertaReticulateClient documentation built on Dec. 19, 2021, 10:50 a.m.