Purpose

Specifies the endpoint that the driver connects to and samples. This property allows you to configure the driver to issue GET requests to a single endpoint without creating a Model file. Note that if your session does any of the following, instead of using this property, you must create a Model file and specify its location with the Config property:

  • Accesses multiple endpoints
  • Issues POST requests
  • Accesses endpoints that require paging
  • Accesses endpoints that use custom HTTP headers
  • Uses custom HTTP response code processing
  • Requires a custom authentication flow

Valid Values

URI

where:

URI

is the endpoint that you connect to and sample. For example, https://example.com/countries/. Note that the value must be valid URL-encoded syntax. For example, spaces in an endpoint are replaced with %20. See "URL-encoded values" for details.

Notes

  • The Table connection property allows you to determine the name of the table the specified endpoint maps to. If you do not provide a table name, the driver will determine the name based on the name of the endpoint.
  • When using the Sample property, the driver maps endpoints that consist of only a host name to the URL_ parent table by default. You can specify a different table name using the Table property.
  • In most scenarios, you will configure the Config property, for specifying a Model File, or the Sample property, for specifying a single endpoint to sample. However, note that these properties are not required for all use cases, such as when the driver is being used to execute dynamically created stored procedures or functions.

Data Source Methods

public URI getSample()

public void setSample(URI)

Default Value

No default value

Data Type

URI