Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 3.94 KB

UserWorkspaceConnectionTree.md

File metadata and controls

90 lines (59 loc) · 3.94 KB
Raw

\UserWorkspaceConnectionTree

All URIs are relative to https://pipes.turbot.com/api/v0

Method HTTP request Description
List Get /user/{user_handle}/workspace/{workspace_handle}/connection_tree List user workspace connection tree

List

ListConnectionsResponse List(ctx, userHandle, workspaceHandle).Prefix(prefix).Where(where).Limit(limit).NextToken(nextToken).Execute()

List user workspace connection tree

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userHandle := "userHandle_example" // string | The handle of the user to which the workspace belongs to.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace for which we want to retrieve the connection tree.
    prefix := "prefix_example" // string | The prefix to be used when listing items in a connection tree (optional)
    where := "where_example" // string | The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API. (optional)
    limit := int32(56) // int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. (optional) (default to 25)
    nextToken := "nextToken_example" // string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserWorkspaceConnectionTree.List(context.Background(), userHandle, workspaceHandle).Prefix(prefix).Where(where).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserWorkspaceConnectionTree.List``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `List`: ListConnectionsResponse
    fmt.Fprintf(os.Stdout, "Response from `UserWorkspaceConnectionTree.List`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle string The handle of the user to which the workspace belongs to.
workspaceHandle string The handle of the workspace for which we want to retrieve the connection tree.

Other Parameters

Other parameters are passed through a pointer to a apiListRequest struct via the builder pattern

Name Type Description Notes

prefix | string | The prefix to be used when listing items in a connection tree | where | string | The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API. | limit | int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | [default to 25] nextToken | string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |

Return type

ListConnectionsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]