Skip to content

Latest commit

 

History

History
316 lines (202 loc) · 10.8 KB

UserWorkspaceConnectionAssociations.md

File metadata and controls

316 lines (202 loc) · 10.8 KB
Raw

\UserWorkspaceConnectionAssociations

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

Method HTTP request Description
Create Post /user/{user_handle}/workspace/{workspace_handle}/conn Create user workspace connection association
Delete Delete /user/{user_handle}/workspace/{workspace_handle}/conn/{conn_handle} Delete user workspace connection association
Get Get /user/{user_handle}/workspace/{workspace_handle}/conn/{conn_handle} Get user workspace connection association
List Get /user/{user_handle}/workspace/{workspace_handle}/conn List user workspace connection associations

Create

WorkspaceConn Create(ctx, userHandle, workspaceHandle).Request(request).Execute()

Create user workspace connection association

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where we want to create an association.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace where the connection will be associated.
    request := *openapiclient.NewCreateWorkspaceConnRequest("ConnectionHandle_example") // CreateWorkspaceConnRequest | The request body for the association to be created.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserWorkspaceConnectionAssociations.Create(context.Background(), userHandle, workspaceHandle).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserWorkspaceConnectionAssociations.Create``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Create`: WorkspaceConn
    fmt.Fprintf(os.Stdout, "Response from `UserWorkspaceConnectionAssociations.Create`: %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 where we want to create an association.
workspaceHandle string The handle of the workspace where the connection will be associated.

Other Parameters

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

Name Type Description Notes

request | CreateWorkspaceConnRequest | The request body for the association to be created. |

Return type

WorkspaceConn

Authorization

No authorization required

HTTP request headers

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

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

Delete

WorkspaceConn Delete(ctx, userHandle, workspaceHandle, connHandle).Execute()

Delete user workspace connection association

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user performing the action.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace whose association needs to be deleted.
    connHandle := "connHandle_example" // string | The handle of the conn whose association needs to be deleted.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserWorkspaceConnectionAssociations.Delete(context.Background(), userHandle, workspaceHandle, connHandle).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserWorkspaceConnectionAssociations.Delete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Delete`: WorkspaceConn
    fmt.Fprintf(os.Stdout, "Response from `UserWorkspaceConnectionAssociations.Delete`: %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 performing the action.
workspaceHandle string The handle of the workspace whose association needs to be deleted.
connHandle string The handle of the conn whose association needs to be deleted.

Other Parameters

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

Name Type Description Notes

Return type

WorkspaceConn

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]

Get

WorkspaceConn Get(ctx, userHandle, workspaceHandle, connHandle).Execute()

Get user workspace connection association

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user for which you want to get the association.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace wherethe association exist.
    connHandle := "connHandle_example" // string | The handle of the conn whose association details needs to be fetched.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserWorkspaceConnectionAssociations.Get(context.Background(), userHandle, workspaceHandle, connHandle).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserWorkspaceConnectionAssociations.Get``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Get`: WorkspaceConn
    fmt.Fprintf(os.Stdout, "Response from `UserWorkspaceConnectionAssociations.Get`: %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 for which you want to get the association.
workspaceHandle string The handle of the workspace wherethe association exist.
connHandle string The handle of the conn whose association details needs to be fetched.

Other Parameters

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

Name Type Description Notes

Return type

WorkspaceConn

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]

List

ListWorkspaceConnResponse List(ctx, userHandle, workspaceHandle).Limit(limit).NextToken(nextToken).Execute()

List user workspace connection associations

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user for which you want to start listing associations.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace where you want to list the associations.
    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.UserWorkspaceConnectionAssociations.List(context.Background(), userHandle, workspaceHandle).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserWorkspaceConnectionAssociations.List``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `List`: ListWorkspaceConnResponse
    fmt.Fprintf(os.Stdout, "Response from `UserWorkspaceConnectionAssociations.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 for which you want to start listing associations.
workspaceHandle string The handle of the workspace where you want to list the associations.

Other Parameters

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

Name Type Description Notes

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

ListWorkspaceConnResponse

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]