sdk

package module
v0.202638.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 14, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

README

RDP SDK for Go

The RDP SDK for Go is part of the unified SDK family for client applications interacting with Raft Data Platform (RDP). It provides Go-friendly configuration, authentication, TLS, timeout, and logging helpers while exposing generated service clients for the RDP API surface.

For platform concepts, API guides, and integration details, see https://developer.teamraft.com.

See Terms of Use.

Installation

From an existing Go module:

go get github.com/raft-tech/rdp-sdk-go@latest

For a new project, create a module first:

mkdir my-rdp-client
cd my-rdp-client
go mod init example.com/my-rdp-client
go get github.com/raft-tech/rdp-sdk-go@latest

The SDK consumes the public Go packages generated from the raft/wdm Buf module. Applications import WDM protobuf types from buf.build/gen/go/raft/wdm/protocolbuffers/go as shown below; the SDK wires its service clients from the matching ConnectRPC module.

Quick Start

export RDP_SERVER_URL=https://rdp.example.com
export RDP_API_KEY=your-api-key

Save the following as main.go:

package main

import (
    "context"
    "fmt"
    "log"

    wdmsvc "buf.build/gen/go/raft/wdm/protocolbuffers/go/raft/wdm/v1/service"
    "connectrpc.com/connect"
    rdpsdk "github.com/raft-tech/rdp-sdk-go"
)

func main() {
    // Load RDP_SERVER_URL and authentication from the environment.
    cfg, err := rdpsdk.LoadConfig()
    if err != nil {
        log.Fatal(err)
    }

    // Create a client from the loaded config.
    client, err := rdpsdk.NewFromConfig(cfg)
    if err != nil {
        log.Fatal(err)
    }

    // Request the first 10 WDM objects.
    resp, err := client.ObjectService().SearchObjects(
        context.Background(),
        connect.NewRequest(&wdmsvc.SearchObjectsRequest{PageSize: 10}),
    )
    if err != nil {
        log.Fatal(err)
    }

    objects := resp.Msg.GetObjects()
    if len(objects) == 0 {
        fmt.Println("No WDM objects found.")
        return
    }

    for _, object := range objects {
        fmt.Printf("%s\t%s\n", object.GetId(), object.GetName())
    }
}

Run it with:

go run ./main.go

For more examples, see examples.

Configuration

LoadConfig reads connection settings from environment variables and returns a validated config for NewFromConfig. It reads only the process environment unless you pass WithEnvFile(path).

Variable Required Description
RDP_SERVER_URL No Base RDP endpoint. Defaults to https://rdp.local; use scheme and host only.
RDP_SERVER_PORT No Optional port override for the endpoint.
TLS_SKIP_VERIFY No Set to true only for development or test endpoints with self-signed certificates.
Authentication

API key authentication is the preferred method for client applications. Use OAuth2 client credentials or a static Bearer token only when your deployment requires it.

Method Variables Request behavior
API key RDP_API_KEY Sends the value on each request as an API key header.
OAuth2 client credentials RDP_CLIENT_ID, RDP_CLIENT_SECRET Fetches a token from {RDP_SERVER_URL}/api/v1/auth/token and sends it as a bearer token.
Bearer RDP_BEARER_TOKEN Sends Authorization: Bearer <token>.

Providing multiple auth methods is an error. If no method is configured, requests are sent without auth and the SDK logs a warning.

Functional Configuration

Use functional options with New(endpoint, ...opts) or as overrides after environment loading with NewFromConfig(cfg, ...opts). Call-site options are applied after LoadConfig options, so they can override the loaded configuration.

For direct construction:

logger := slog.Default()

client, err := rdpsdk.New(
    "https://rdp.example.com",
    rdpsdk.WithAPIKey("your-api-key"),
    rdpsdk.WithTimeout(10*time.Second),
    rdpsdk.WithLogger(logger),
)
if err != nil {
    log.Fatal(err)
}

Static Authorization header auth can be configured directly as well:

bearerClient, err := rdpsdk.New(
    "https://rdp.example.com",
    rdpsdk.WithBearerToken("token"),
)

For environment-first configuration with call-site overrides:

cfg, err := rdpsdk.LoadConfig(
    rdpsdk.WithEnvFile(".env.local"),
    rdpsdk.WithConfigLogger(logger),
)
if err != nil {
    log.Fatal(err)
}

client, err := rdpsdk.NewFromConfig(
    cfg,
    rdpsdk.WithTimeout(10*time.Second),
)
if err != nil {
    log.Fatal(err)
}

Use WithClientCredentials(clientID, clientSecret) only when your deployment requires OAuth2 client credentials. Use WithTLSSkipVerify() only for development or test endpoints with self-signed certificates.

Documentation

Overview

Package sdk is the Go SDK for client applications interacting with RDP.

The client constructor wires up authentication, TLS, timeout, and logging, then exposes the Buf-generated ConnectRPC service stubs directly via the service accessor methods on Client. It also exposes fluent Catalog, Pipelines, and Transformers REST/OpenAPI clients via Client.Catalog, Client.Pipelines, and Client.Transformers. Consumers use the generated protobuf types for WDM request/response construction and the REST subpackages for request/response types. 

import rdpsdk "github.com/raft-tech/rdp-sdk-go"

client, err := rdpsdk.New("https://rdp.example.com",
    rdpsdk.WithClientCredentials(clientID, clientSecret),
)
if err != nil {
    log.Fatal(err)
}
resp, err := client.ObjectService().PublishObject(ctx, connect.NewRequest(req))

Index

Constants

View Source 
const DefaultEndpoint = internal.DefaultEndpoint

DefaultEndpoint is the default WDM server URL when none is specified.

Variables

View Source 
var (
	WithAPIKey            = internal.WithAPIKey
	WithBearerToken       = internal.WithBearerToken
	WithClientCredentials = internal.WithClientCredentials
	WithLogger            = internal.WithLogger
	WithTimeout           = internal.WithTimeout
	WithTLSSkipVerify     = internal.WithTLSSkipVerify
)

Option constructors — aliased to the internal package's so the facade owns the user-facing surface and the internal package stays hidden. Mirrors every With* defined in internal/options.go.

View Source 
var (
	LoadConfig       = internal.LoadConfig
	WithEnvFile      = internal.WithEnvFile
	WithConfigLogger = internal.WithConfigLogger
)

LoadConfig and its options — aliased to the internal package's.

View Source 
var Version = internal.Version

Version is the SDK version, re-exported from internal. It is overridden at build time via ldflags targeting the internal package: 

go build -ldflags "-X github.com/raft-tech/rdp-sdk-go/internal.Version=<semver>"

Falls back to "dev" when not set (e.g. plain `go test`).

Functions

This section is empty.

Types

type CatalogClient added in v0.202631.0 

type CatalogClient struct {
	// contains filtered or unexported fields
}

CatalogClient provides fluent access to the RDP Catalog API.

func (*CatalogClient) DataSources added in v0.202631.0 

func (c *CatalogClient) DataSources() *CatalogDataSources

DataSources returns fluent DataSource operations.

func (*CatalogClient) Datasets added in v0.202631.0 

func (c *CatalogClient) Datasets() *CatalogDatasets

Datasets returns fluent top-level DataSet operations.

func (*CatalogClient) Enablements added in v0.202631.0 

func (c *CatalogClient) Enablements() *CatalogEnablements

Enablements returns fluent top-level DataSource enablement operations.

func (*CatalogClient) Raw added in v0.202631.0 

func (c *CatalogClient) Raw() catalogapi.ClientWithResponsesInterface

Raw returns the generated OpenAPI response client for advanced use.

func (*CatalogClient) Search added in v0.202631.0 

func (c *CatalogClient) Search() *CatalogSearch

Search returns fluent global catalog search operations.

func (*CatalogClient) Storages added in v0.202631.0 

func (c *CatalogClient) Storages() *CatalogStorages

Storages returns fluent top-level DataSet storage operations.

type CatalogDataSource added in v0.202631.0 

type CatalogDataSource struct {
	// contains filtered or unexported fields
}

CatalogDataSource provides fluent operations for one DataSource.

func (*CatalogDataSource) Datasets added in v0.202631.0 

func (r *CatalogDataSource) Datasets() *CatalogDataSourceDatasets

func (*CatalogDataSource) Delete added in v0.202631.0 

func (r *CatalogDataSource) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteDatasourceResponse, error)

func (*CatalogDataSource) Documents added in v0.202631.0 

func (r *CatalogDataSource) Documents() *CatalogDataSourceDocuments

func (*CatalogDataSource) Enablements added in v0.202631.0 

func (r *CatalogDataSource) Enablements() *CatalogDataSourceEnablements

func (*CatalogDataSource) Get added in v0.202631.0 

func (r *CatalogDataSource) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasourceResponse, error)

func (*CatalogDataSource) Labels added in v0.202631.0 

func (r *CatalogDataSource) Labels() *CatalogDataSourceLabels

func (*CatalogDataSource) Patch added in v0.202631.0 

func (r *CatalogDataSource) Patch(ctx context.Context, body catalogapi.PatchDatasourceJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchDatasourceResponse, error)

func (*CatalogDataSource) Update added in v0.202631.0 

func (r *CatalogDataSource) Update(ctx context.Context, body catalogapi.UpdateDatasourceJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateDatasourceResponse, error)

type CatalogDataSourceDatasets added in v0.202631.0 

type CatalogDataSourceDatasets struct {
	// contains filtered or unexported fields
}

CatalogDataSourceDatasets provides fluent cross-enablement DataSet operations for one DataSource.

func (*CatalogDataSourceDatasets) Count added in v0.202631.0 

func (r *CatalogDataSourceDatasets) Count(ctx context.Context, params *catalogapi.CountAllDatasetsForDatasourceParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountAllDatasetsForDatasourceResponse, error)

func (*CatalogDataSourceDatasets) IngestionStatuses added in v0.202631.0 

func (r *CatalogDataSourceDatasets) IngestionStatuses(ctx context.Context, params *catalogapi.GetAllDatasetIngestionStatusesForDatasourceParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllDatasetIngestionStatusesForDatasourceResponse, error)

func (*CatalogDataSourceDatasets) Search added in v0.202631.0 

func (r *CatalogDataSourceDatasets) Search(ctx context.Context, params *catalogapi.GetAllDatasetsForDatasourceParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllDatasetsForDatasourceResponse, error)

type CatalogDataSourceDocument added in v0.202631.0 

type CatalogDataSourceDocument struct {
	// contains filtered or unexported fields
}

CatalogDataSourceDocument provides fluent operations for one DataSource document.

func (*CatalogDataSourceDocument) Delete added in v0.202631.0 

func (r *CatalogDataSourceDocument) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteDataSourceDocumentResponse, error)

func (*CatalogDataSourceDocument) Get added in v0.202631.0 

func (r *CatalogDataSourceDocument) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDataSourceDocumentResponse, error)

type CatalogDataSourceDocuments added in v0.202631.0 

type CatalogDataSourceDocuments struct {
	// contains filtered or unexported fields
}

CatalogDataSourceDocuments provides fluent DataSource document operations.

func (*CatalogDataSourceDocuments) Add added in v0.202631.0 

func (r *CatalogDataSourceDocuments) Add(ctx context.Context, body catalogapi.AddDataSourceDocumentJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.AddDataSourceDocumentResponse, error)

func (*CatalogDataSourceDocuments) ID added in v0.202631.0 

func (r *CatalogDataSourceDocuments) ID(documentID string) *CatalogDataSourceDocument

func (*CatalogDataSourceDocuments) List added in v0.202631.0 

func (r *CatalogDataSourceDocuments) List(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDataSourceDocumentsResponse, error)

type CatalogDataSourceEnablement added in v0.202631.0 

type CatalogDataSourceEnablement struct {
	// contains filtered or unexported fields
}

CatalogDataSourceEnablement provides fluent nested dataset helpers for one DataSource enablement.

func (*CatalogDataSourceEnablement) DatasetIngestionStatuses added in v0.202631.0 

func (r *CatalogDataSourceEnablement) DatasetIngestionStatuses(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllDatasetIngestionStatusesResponse, error)

func (*CatalogDataSourceEnablement) Datasets added in v0.202631.0 

func (r *CatalogDataSourceEnablement) Datasets() *CatalogDataSourceEnablementDatasets

type CatalogDataSourceEnablementDataset added in v0.202631.0 

type CatalogDataSourceEnablementDataset struct {
	// contains filtered or unexported fields
}

CatalogDataSourceEnablementDataset provides non-deprecated nested DataSet helpers.

func (*CatalogDataSourceEnablementDataset) Documents added in v0.202631.0 

func (r *CatalogDataSourceEnablementDataset) Documents() *CatalogDatasetDocuments

func (*CatalogDataSourceEnablementDataset) Metadata added in v0.202631.0 

func (r *CatalogDataSourceEnablementDataset) Metadata() *CatalogDatasetMetadata

type CatalogDataSourceEnablementDatasets added in v0.202631.0 

type CatalogDataSourceEnablementDatasets struct {
	// contains filtered or unexported fields
}

CatalogDataSourceEnablementDatasets provides fluent nested dataset helpers.

func (*CatalogDataSourceEnablementDatasets) ID added in v0.202631.0 

func (r *CatalogDataSourceEnablementDatasets) ID(datasetID catalogapi.DatasetId) *CatalogDataSourceEnablementDataset

type CatalogDataSourceEnablements added in v0.202631.0 

type CatalogDataSourceEnablements struct {
	// contains filtered or unexported fields
}

CatalogDataSourceEnablements provides fluent nested enablement helpers for one DataSource.

func (*CatalogDataSourceEnablements) ID added in v0.202631.0 

func (r *CatalogDataSourceEnablements) ID(enablementID catalogapi.EnablementId) *CatalogDataSourceEnablement

type CatalogDataSourceLabels added in v0.202631.0 

type CatalogDataSourceLabels struct {
	// contains filtered or unexported fields
}

CatalogDataSourceLabels provides fluent DataSource label operations.

func (*CatalogDataSourceLabels) Add added in v0.202631.0 

func (r *CatalogDataSourceLabels) Add(ctx context.Context, body catalogapi.AddDatasourceLabelsJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.AddDatasourceLabelsResponse, error)

func (*CatalogDataSourceLabels) Count added in v0.202631.0 

func (r *CatalogDataSourceLabels) Count(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountDatasourceLabelsResponse, error)

func (*CatalogDataSourceLabels) Delete added in v0.202631.0 

func (r *CatalogDataSourceLabels) Delete(ctx context.Context, body catalogapi.DeleteDatasourceLabelsJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteDatasourceLabelsResponse, error)

func (*CatalogDataSourceLabels) Get added in v0.202631.0 

func (r *CatalogDataSourceLabels) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasourceLabelsResponse, error)

func (*CatalogDataSourceLabels) Replace added in v0.202631.0 

func (r *CatalogDataSourceLabels) Replace(ctx context.Context, body catalogapi.UpdateDatasourceLabelsJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateDatasourceLabelsResponse, error)

type CatalogDataSources added in v0.202631.0 

type CatalogDataSources struct {
	// contains filtered or unexported fields
}

CatalogDataSources provides fluent DataSource collection operations.

func (*CatalogDataSources) AllDatasets added in v0.202631.0 

func (r *CatalogDataSources) AllDatasets(ctx context.Context, params *catalogapi.GetAllDatasetsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllDatasetsResponse, error)

func (*CatalogDataSources) AllEnablements added in v0.202631.0 

func (r *CatalogDataSources) AllEnablements(ctx context.Context, params *catalogapi.GetAllDatasourceEnablementsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllDatasourceEnablementsResponse, error)

func (*CatalogDataSources) Count added in v0.202631.0 

func (r *CatalogDataSources) Count(ctx context.Context, params *catalogapi.CountDatasourcesParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountDatasourcesResponse, error)

func (*CatalogDataSources) CountAllDatasets added in v0.202631.0 

func (r *CatalogDataSources) CountAllDatasets(ctx context.Context, params *catalogapi.CountAllDatasetsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountAllDatasetsResponse, error)

func (*CatalogDataSources) CountAllEnablements added in v0.202631.0 

func (r *CatalogDataSources) CountAllEnablements(ctx context.Context, params *catalogapi.CountAllDatasourceEnablementsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountAllDatasourceEnablementsResponse, error)

func (*CatalogDataSources) Create added in v0.202631.0 

func (r *CatalogDataSources) Create(ctx context.Context, body catalogapi.CreateDatasourceJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.CreateDatasourceResponse, error)

func (*CatalogDataSources) ID added in v0.202631.0 

func (r *CatalogDataSources) ID(datasourceID catalogapi.DatasourceId) *CatalogDataSource

func (*CatalogDataSources) Search added in v0.202631.0 

func (r *CatalogDataSources) Search(ctx context.Context, params *catalogapi.GetDatasourcesParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasourcesResponse, error)

type CatalogDataset added in v0.202631.0 

type CatalogDataset struct {
	// contains filtered or unexported fields
}

CatalogDataset provides fluent operations for one top-level DataSet.

func (*CatalogDataset) AccessControls added in v0.202631.0 

func (r *CatalogDataset) AccessControls() *CatalogDatasetAccessControls

func (*CatalogDataset) Delete added in v0.202631.0 

func (r *CatalogDataset) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteDatasetByIdResponse, error)

func (*CatalogDataset) Filters added in v0.202631.0 

func (r *CatalogDataset) Filters() *CatalogDatasetFilters

func (*CatalogDataset) Get added in v0.202631.0 

func (r *CatalogDataset) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetByIdResponse, error)

func (*CatalogDataset) Ingestion added in v0.202631.0 

func (r *CatalogDataset) Ingestion() *CatalogDatasetIngestion

func (*CatalogDataset) Labels added in v0.202631.0 

func (r *CatalogDataset) Labels() *CatalogDatasetLabelsByID

func (*CatalogDataset) Patch added in v0.202631.0 

func (r *CatalogDataset) Patch(ctx context.Context, body catalogapi.PatchDatasetByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchDatasetByIdResponse, error)

func (*CatalogDataset) Pipelines added in v0.202631.0 

func (r *CatalogDataset) Pipelines() *CatalogDatasetPipelines

func (*CatalogDataset) Schema added in v0.202631.0 

func (r *CatalogDataset) Schema() *CatalogDatasetSchema

func (*CatalogDataset) Update added in v0.202631.0 

func (r *CatalogDataset) Update(ctx context.Context, body catalogapi.UpdateDatasetByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateDatasetByIdResponse, error)

type CatalogDatasetAccessControls added in v0.202631.0 

type CatalogDatasetAccessControls struct {
	// contains filtered or unexported fields
}

CatalogDatasetAccessControls provides fluent top-level DataSet access-control operations.

func (*CatalogDatasetAccessControls) Delete added in v0.202631.0 

func (r *CatalogDatasetAccessControls) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteAccessControlsByDatasetIdResponse, error)

func (*CatalogDatasetAccessControls) DeleteOne added in v0.202631.0 

func (r *CatalogDatasetAccessControls) DeleteOne(ctx context.Context, accessControlID openapi_types.UUID, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteAccessControlByIdByDatasetIdResponse, error)

func (*CatalogDatasetAccessControls) Get added in v0.202631.0 

func (r *CatalogDatasetAccessControls) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAccessControlsByDatasetIdResponse, error)

func (*CatalogDatasetAccessControls) Patch added in v0.202631.0 

func (r *CatalogDatasetAccessControls) Patch(ctx context.Context, body catalogapi.PatchAccessControlsByDatasetIdApplicationJSONPatchPlusJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchAccessControlsByDatasetIdResponse, error)

func (*CatalogDatasetAccessControls) PatchWithBody added in v0.202631.0 

func (r *CatalogDatasetAccessControls) PatchWithBody(ctx context.Context, contentType string, body io.Reader, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchAccessControlsByDatasetIdResponse, error)

func (*CatalogDatasetAccessControls) Replace added in v0.202631.0 

func (r *CatalogDatasetAccessControls) Replace(ctx context.Context, body catalogapi.ReplaceAccessControlsByDatasetIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.ReplaceAccessControlsByDatasetIdResponse, error)

type CatalogDatasetDocument added in v0.202631.0 

type CatalogDatasetDocument struct {
	// contains filtered or unexported fields
}

CatalogDatasetDocument provides fluent operations for one nested DataSet document.

func (*CatalogDatasetDocument) Delete added in v0.202631.0 

func (r *CatalogDatasetDocument) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteDatasetDocumentResponse, error)

func (*CatalogDatasetDocument) Get added in v0.202631.0 

func (r *CatalogDatasetDocument) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetDocumentResponse, error)

type CatalogDatasetDocuments added in v0.202631.0 

type CatalogDatasetDocuments struct {
	// contains filtered or unexported fields
}

CatalogDatasetDocuments provides fluent nested DataSet document operations.

func (*CatalogDatasetDocuments) Add added in v0.202631.0 

func (r *CatalogDatasetDocuments) Add(ctx context.Context, body catalogapi.AddDatasetDocumentJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.AddDatasetDocumentResponse, error)

func (*CatalogDatasetDocuments) ID added in v0.202631.0 

func (r *CatalogDatasetDocuments) ID(documentID string) *CatalogDatasetDocument

func (*CatalogDatasetDocuments) List added in v0.202631.0 

func (r *CatalogDatasetDocuments) List(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetDocumentsResponse, error)

type CatalogDatasetFilters added in v0.202631.0 

type CatalogDatasetFilters struct {
	// contains filtered or unexported fields
}

CatalogDatasetFilters provides fluent top-level DataSet filtering operations.

func (*CatalogDatasetFilters) Create added in v0.202631.0 

func (r *CatalogDatasetFilters) Create(ctx context.Context, params *catalogapi.CreateDatasetFilterByDatasetIdParams, body catalogapi.CreateDatasetFilterByDatasetIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.CreateDatasetFilterByDatasetIdResponse, error)

func (*CatalogDatasetFilters) Derived added in v0.202631.0 

func (r *CatalogDatasetFilters) Derived(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDerivedDatasetsByDatasetIdResponse, error)

type CatalogDatasetIngestion added in v0.202631.0 

type CatalogDatasetIngestion struct {
	// contains filtered or unexported fields
}

CatalogDatasetIngestion provides fluent top-level DataSet ingestion operations.

func (*CatalogDatasetIngestion) Get added in v0.202631.0 

func (r *CatalogDatasetIngestion) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetIngestionStatusByDatasetIdResponse, error)

func (*CatalogDatasetIngestion) Patch added in v0.202631.0 

func (r *CatalogDatasetIngestion) Patch(ctx context.Context, body catalogapi.PatchIngestionByDatasetIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchIngestionByDatasetIdResponse, error)

func (*CatalogDatasetIngestion) Start added in v0.202631.0 

func (r *CatalogDatasetIngestion) Start(ctx context.Context, body catalogapi.StartDatasetIngestionByDatasetIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.StartDatasetIngestionByDatasetIdResponse, error)

func (*CatalogDatasetIngestion) Stop added in v0.202631.0 

func (r *CatalogDatasetIngestion) Stop(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteIngestionByDatasetIdResponse, error)

type CatalogDatasetLabelsByID added in v0.202631.0 

type CatalogDatasetLabelsByID struct {
	// contains filtered or unexported fields
}

CatalogDatasetLabelsByID provides fluent top-level DataSet label operations.

func (*CatalogDatasetLabelsByID) Add added in v0.202631.0 

func (r *CatalogDatasetLabelsByID) Add(ctx context.Context, body catalogapi.AddDatasetLabelsByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.AddDatasetLabelsByIdResponse, error)

func (*CatalogDatasetLabelsByID) Count added in v0.202631.0 

func (r *CatalogDatasetLabelsByID) Count(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountDatasetLabelsByIdResponse, error)

func (*CatalogDatasetLabelsByID) Delete added in v0.202631.0 

func (r *CatalogDatasetLabelsByID) Delete(ctx context.Context, body catalogapi.DeleteDatasetLabelsByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteDatasetLabelsByIdResponse, error)

func (*CatalogDatasetLabelsByID) Get added in v0.202631.0 

func (r *CatalogDatasetLabelsByID) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetLabelsByIdResponse, error)

func (*CatalogDatasetLabelsByID) Replace added in v0.202631.0 

func (r *CatalogDatasetLabelsByID) Replace(ctx context.Context, body catalogapi.UpdateDatasetLabelsByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateDatasetLabelsByIdResponse, error)

type CatalogDatasetMetadata added in v0.202631.0 

type CatalogDatasetMetadata struct {
	// contains filtered or unexported fields
}

CatalogDatasetMetadata provides fluent nested DataSet metadata operations.

func (*CatalogDatasetMetadata) Get added in v0.202631.0 

func (r *CatalogDatasetMetadata) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetMetadataResponse, error)

func (*CatalogDatasetMetadata) Replace added in v0.202631.0 

func (r *CatalogDatasetMetadata) Replace(ctx context.Context, body catalogapi.UpdateDatasetMetadataJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateDatasetMetadataResponse, error)

type CatalogDatasetPipelines added in v0.202631.0 

type CatalogDatasetPipelines struct {
	// contains filtered or unexported fields
}

CatalogDatasetPipelines provides fluent top-level DataSet pipeline operations.

func (*CatalogDatasetPipelines) List added in v0.202631.0 

func (r *CatalogDatasetPipelines) List(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetPipelinesByDatasetIdResponse, error)

type CatalogDatasetSchema added in v0.202631.0 

type CatalogDatasetSchema struct {
	// contains filtered or unexported fields
}

CatalogDatasetSchema provides fluent top-level DataSet schema operations.

func (*CatalogDatasetSchema) Get added in v0.202631.0 

func (r *CatalogDatasetSchema) Get(ctx context.Context, params *catalogapi.GetDatasetSchemaByIdParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetDatasetSchemaByIdResponse, error)

func (*CatalogDatasetSchema) Hints added in v0.202631.0 

func (r *CatalogDatasetSchema) Hints() *CatalogDatasetSchemaHints

func (*CatalogDatasetSchema) Update added in v0.202631.0 

func (r *CatalogDatasetSchema) Update(ctx context.Context, body catalogapi.UpdateDatasetSchemaByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateDatasetSchemaByIdResponse, error)

type CatalogDatasetSchemaHints added in v0.202631.0 

type CatalogDatasetSchemaHints struct {
	// contains filtered or unexported fields
}

CatalogDatasetSchemaHints provides fluent top-level DataSet schema hint operations.

func (*CatalogDatasetSchemaHints) Delete added in v0.202631.0 

func (r *CatalogDatasetSchemaHints) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteSchemaHintsByDatasetIdResponse, error)

func (*CatalogDatasetSchemaHints) Get added in v0.202631.0 

func (r *CatalogDatasetSchemaHints) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetSchemaHintsByDatasetIdResponse, error)

func (*CatalogDatasetSchemaHints) Patch added in v0.202631.0 

func (r *CatalogDatasetSchemaHints) Patch(ctx context.Context, body catalogapi.PatchSchemaHintsByDatasetIdApplicationJSONPatchPlusJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchSchemaHintsByDatasetIdResponse, error)

func (*CatalogDatasetSchemaHints) PatchWithBody added in v0.202631.0 

func (r *CatalogDatasetSchemaHints) PatchWithBody(ctx context.Context, contentType string, body io.Reader, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchSchemaHintsByDatasetIdResponse, error)

func (*CatalogDatasetSchemaHints) Replace added in v0.202631.0 

func (r *CatalogDatasetSchemaHints) Replace(ctx context.Context, body catalogapi.UpdateSchemaHintsByDatasetIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateSchemaHintsByDatasetIdResponse, error)

type CatalogDatasets added in v0.202631.0 

type CatalogDatasets struct {
	// contains filtered or unexported fields
}

CatalogDatasets provides fluent top-level DataSet operations.

func (*CatalogDatasets) Count added in v0.202631.0 

func (r *CatalogDatasets) Count(ctx context.Context, params *catalogapi.CountAllDatasetsTopLevelParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountAllDatasetsTopLevelResponse, error)

func (*CatalogDatasets) Create added in v0.202631.0 

func (r *CatalogDatasets) Create(ctx context.Context, body catalogapi.CreateDatasetTopLevelJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.CreateDatasetTopLevelResponse, error)

func (*CatalogDatasets) DeleteAll added in v0.202631.0 

func (r *CatalogDatasets) DeleteAll(ctx context.Context, params *catalogapi.DeleteAllDatasetsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteAllDatasetsResponse, error)

func (*CatalogDatasets) ID added in v0.202631.0 

func (r *CatalogDatasets) ID(datasetID catalogapi.DatasetId) *CatalogDataset

func (*CatalogDatasets) Search added in v0.202631.0 

func (r *CatalogDatasets) Search(ctx context.Context, params *catalogapi.GetAllDatasetsTopLevelParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllDatasetsTopLevelResponse, error)

type CatalogEnablement added in v0.202631.0 

type CatalogEnablement struct {
	// contains filtered or unexported fields
}

CatalogEnablement provides fluent operations for one top-level enablement.

func (*CatalogEnablement) Delete added in v0.202631.0 

func (r *CatalogEnablement) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteEnablementByIdResponse, error)

func (*CatalogEnablement) Get added in v0.202631.0 

func (r *CatalogEnablement) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetEnablementByIdResponse, error)

func (*CatalogEnablement) Patch added in v0.202631.0 

func (r *CatalogEnablement) Patch(ctx context.Context, body catalogapi.PatchEnablementByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchEnablementByIdResponse, error)

func (*CatalogEnablement) Update added in v0.202631.0 

func (r *CatalogEnablement) Update(ctx context.Context, body catalogapi.UpdateEnablementByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateEnablementByIdResponse, error)

type CatalogEnablements added in v0.202631.0 

type CatalogEnablements struct {
	// contains filtered or unexported fields
}

CatalogEnablements provides fluent top-level enablement operations.

func (*CatalogEnablements) Count added in v0.202631.0 

func (r *CatalogEnablements) Count(ctx context.Context, params *catalogapi.CountAllEnablementsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountAllEnablementsResponse, error)

func (*CatalogEnablements) Create added in v0.202631.0 

func (r *CatalogEnablements) Create(ctx context.Context, body catalogapi.CreateEnablementJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.CreateEnablementResponse, error)

func (*CatalogEnablements) DeleteAll added in v0.202631.0 

func (r *CatalogEnablements) DeleteAll(ctx context.Context, params *catalogapi.DeleteAllEnablementsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteAllEnablementsResponse, error)

func (*CatalogEnablements) ID added in v0.202631.0 

func (r *CatalogEnablements) ID(enablementID catalogapi.EnablementId) *CatalogEnablement

func (*CatalogEnablements) Search added in v0.202631.0 

func (r *CatalogEnablements) Search(ctx context.Context, params *catalogapi.GetAllEnablementsParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllEnablementsResponse, error)

type CatalogSearch added in v0.202631.0 

type CatalogSearch struct {
	// contains filtered or unexported fields
}

CatalogSearch provides fluent global catalog search operations.

func (*CatalogSearch) Global added in v0.202631.0 

func (r *CatalogSearch) Global(ctx context.Context, params *catalogapi.PostGlobalSearchParams, body catalogapi.PostGlobalSearchJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PostGlobalSearchResponse, error)

type CatalogStorage added in v0.202631.0 

type CatalogStorage struct {
	// contains filtered or unexported fields
}

CatalogStorage provides fluent operations for one top-level DataSet storage.

func (*CatalogStorage) Delete added in v0.202631.0 

func (r *CatalogStorage) Delete(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteStorageByIdResponse, error)

func (*CatalogStorage) Get added in v0.202631.0 

func (r *CatalogStorage) Get(ctx context.Context, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetStorageByIdResponse, error)

func (*CatalogStorage) Patch added in v0.202631.0 

func (r *CatalogStorage) Patch(ctx context.Context, body catalogapi.PatchStorageByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.PatchStorageByIdResponse, error)

func (*CatalogStorage) Update added in v0.202631.0 

func (r *CatalogStorage) Update(ctx context.Context, body catalogapi.UpdateStorageByIdJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.UpdateStorageByIdResponse, error)

type CatalogStorages added in v0.202631.0 

type CatalogStorages struct {
	// contains filtered or unexported fields
}

CatalogStorages provides fluent top-level DataSet storage operations.

func (*CatalogStorages) Count added in v0.202631.0 

func (r *CatalogStorages) Count(ctx context.Context, params *catalogapi.CountAllStoragesParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.CountAllStoragesResponse, error)

func (*CatalogStorages) Create added in v0.202631.0 

func (r *CatalogStorages) Create(ctx context.Context, body catalogapi.CreateStorageJSONRequestBody, editors ...catalogapi.RequestEditorFn) (*catalogapi.CreateStorageResponse, error)

func (*CatalogStorages) DeleteAll added in v0.202631.0 

func (r *CatalogStorages) DeleteAll(ctx context.Context, params *catalogapi.DeleteAllStoragesParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.DeleteAllStoragesResponse, error)

func (*CatalogStorages) ID added in v0.202631.0 

func (r *CatalogStorages) ID(storageID catalogapi.StorageId) *CatalogStorage

func (*CatalogStorages) Search added in v0.202631.0 

func (r *CatalogStorages) Search(ctx context.Context, params *catalogapi.GetAllStoragesParams, editors ...catalogapi.RequestEditorFn) (*catalogapi.GetAllStoragesResponse, error)

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides access to the canonical WDM services (ObjectService + ActionService) via ConnectRPC and the Catalog, Pipelines, and Transformers APIs via HTTP/OpenAPI. Construct with New or NewFromConfig.

func New 

func New(endpoint string, opts ...Option) (*Client, error)

New returns a RDP SDK client connected to endpoint and configured from opts. If endpoint is empty, DefaultEndpoint is used.

Example: 

import rdpsdk "github.com/raft-tech/rdp-sdk-go"

client, err := rdpsdk.New("https://wdm.example.com",
    rdpsdk.WithAPIKey(os.Getenv("RDP_API_KEY")),
)

func NewFromConfig 

func NewFromConfig(cfg *Config, opts ...Option) (*Client, error)

NewFromConfig builds a Client from a Config previously returned by LoadConfig. Call-site opts are applied after cfg.Options (last-write wins), letting callers start from an env-loaded baseline and layer on programmatic overrides.

func (*Client) ActionService 

func (c *Client) ActionService() serviceconnect.ActionServiceClient

ActionService returns the ConnectRPC ActionServiceClient.

func (*Client) Catalog added in v0.202631.0 

func (c *Client) Catalog() *CatalogClient

Catalog returns the fluent Catalog API client.

func (*Client) ObjectService 

func (c *Client) ObjectService() serviceconnect.ObjectServiceClient

ObjectService returns the ConnectRPC ObjectServiceClient.

func (*Client) Pipelines added in v0.202631.0 

func (c *Client) Pipelines() *PipelinesClient

Pipelines returns the fluent v2 Pipelines API client.

func (*Client) Transformers added in v0.202631.0 

func (c *Client) Transformers() *TransformersClient

Transformers returns the fluent v2 Transformers API client.

type ClientCredentials 

type ClientCredentials = internal.ClientCredentials

ClientCredentials holds the OAuth2 client credentials grant parameters.

type Config 

type Config = internal.Config

Config is the validated SDK configuration produced by LoadConfig.

type ConfigOption 

type ConfigOption = internal.ConfigOption

ConfigOption customizes LoadConfig behavior.

type Option 

type Option = internal.Option

Option configures a RDP SDK Client. See the With* constructors.

type PipelineCanvas added in v0.202631.0 

type PipelineCanvas struct {
	// contains filtered or unexported fields
}

PipelineCanvas provides fluent pipeline canvas catalog operations.

func (*PipelineCanvas) Catalog added in v0.202631.0 

func (r *PipelineCanvas) Catalog(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.CanvasCatalogGetResponse, error)

type PipelineEvents added in v0.202631.0 

type PipelineEvents struct {
	// contains filtered or unexported fields
}

PipelineEvents provides fluent pipeline event stream operations.

func (*PipelineEvents) All added in v0.202631.0 

func (r *PipelineEvents) All(ctx context.Context, params *pipelineapi.InstanceEventsAllGetParams, editors ...pipelineapi.RequestEditorFn) (*http.Response, error)

All streams events for all accessible pipelines. The caller owns and must close the response body.

type PipelineInstance added in v0.202631.0 

type PipelineInstance struct {
	// contains filtered or unexported fields
}

PipelineInstance provides fluent operations for one pipeline instance.

func (*PipelineInstance) AccessControls added in v0.202631.0 

func (r *PipelineInstance) AccessControls() *PipelineInstanceAccessControls

func (*PipelineInstance) Delete added in v0.202631.0 

func (r *PipelineInstance) Delete(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceDeleteResponse, error)

func (*PipelineInstance) Events added in v0.202631.0 

func (r *PipelineInstance) Events(ctx context.Context, params *pipelineapi.InstanceEventsGetParams, editors ...pipelineapi.RequestEditorFn) (*http.Response, error)

Events streams lifecycle events for this pipeline. The caller owns and must close the response body.

func (*PipelineInstance) Export added in v0.202631.0 

func (r *PipelineInstance) Export(ctx context.Context, params *pipelineapi.InstanceExportPostParams, body pipelineapi.InstanceExportPostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceExportPostResponse, error)

func (*PipelineInstance) Get added in v0.202631.0 

func (r *PipelineInstance) Get(ctx context.Context, params *pipelineapi.InstanceGetParams, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceGetResponse, error)

func (*PipelineInstance) Patch added in v0.202631.0 

func (r *PipelineInstance) Patch(ctx context.Context, params *pipelineapi.InstancePatchParams, body pipelineapi.InstancePatchJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstancePatchResponse, error)

func (*PipelineInstance) Restart added in v0.202631.0 

func (r *PipelineInstance) Restart(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceRestartPostResponse, error)

func (*PipelineInstance) Start added in v0.202631.0 

func (r *PipelineInstance) Start(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceStartPostResponse, error)

func (*PipelineInstance) Status added in v0.202631.0 

func (r *PipelineInstance) Status(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceStatusGetResponse, error)

func (*PipelineInstance) Stop added in v0.202631.0 

func (r *PipelineInstance) Stop(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceStopPostResponse, error)

func (*PipelineInstance) Transformer added in v0.202631.0 

func (r *PipelineInstance) Transformer(transformerInstanceUID string) *PipelineTransformerInstance

func (*PipelineInstance) Update added in v0.202631.0 

func (r *PipelineInstance) Update(ctx context.Context, params *pipelineapi.InstancePutParams, body pipelineapi.InstancePutJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstancePutResponse, error)

func (*PipelineInstance) UpdateLayout added in v0.202631.0 

func (r *PipelineInstance) UpdateLayout(ctx context.Context, body pipelineapi.InstanceLayoutPutJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceLayoutPutResponse, error)

type PipelineInstanceAccessControls added in v0.202631.0 

type PipelineInstanceAccessControls struct {
	// contains filtered or unexported fields
}

PipelineInstanceAccessControls provides fluent pipeline instance access-control operations.

func (*PipelineInstanceAccessControls) DeleteOne added in v0.202631.0 

func (r *PipelineInstanceAccessControls) DeleteOne(ctx context.Context, entity string, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceAccessControlsEntityDeleteResponse, error)

func (*PipelineInstanceAccessControls) Get added in v0.202631.0 

func (r *PipelineInstanceAccessControls) Get(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceAccessControlsGetResponse, error)

func (*PipelineInstanceAccessControls) Update added in v0.202631.0 

func (r *PipelineInstanceAccessControls) Update(ctx context.Context, body pipelineapi.InstanceAccessControlsPostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceAccessControlsPostResponse, error)

type PipelineInstances added in v0.202631.0 

type PipelineInstances struct {
	// contains filtered or unexported fields
}

PipelineInstances provides fluent pipeline instance collection operations.

func (*PipelineInstances) Create added in v0.202631.0 

func (r *PipelineInstances) Create(ctx context.Context, params *pipelineapi.InstanceCreatePostParams, body pipelineapi.InstanceCreatePostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceCreatePostResponse, error)

func (*PipelineInstances) Events added in v0.202631.0 

func (r *PipelineInstances) Events() *PipelineEvents

func (*PipelineInstances) ID added in v0.202631.0 

func (r *PipelineInstances) ID(uid string) *PipelineInstance

func (*PipelineInstances) Import added in v0.202631.0 

func (r *PipelineInstances) Import(ctx context.Context, params *pipelineapi.InstanceImportPostParams, body pipelineapi.InstanceImportPostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceImportPostResponse, error)

func (*PipelineInstances) List added in v0.202631.0 

func (r *PipelineInstances) List(ctx context.Context, params *pipelineapi.InstanceGetAllParams, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.InstanceGetAllResponse, error)

type PipelineMigration added in v0.202631.0 

type PipelineMigration struct {
	// contains filtered or unexported fields
}

PipelineMigration provides fluent operations for one pipeline migration.

func (*PipelineMigration) Migrate added in v0.202631.0 

func (r *PipelineMigration) Migrate(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.MigrationMigratePostResponse, error)

type PipelineMigrationInstance added in v0.202631.0 

type PipelineMigrationInstance struct {
	// contains filtered or unexported fields
}

PipelineMigrationInstance provides fluent operations for one migration instance.

func (*PipelineMigrationInstance) Delete added in v0.202631.0 

func (r *PipelineMigrationInstance) Delete(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.MigrationInstanceDeleteResponse, error)

func (*PipelineMigrationInstance) Get added in v0.202631.0 

func (r *PipelineMigrationInstance) Get(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.MigrationInstanceGetResponse, error)

func (*PipelineMigrationInstance) Update added in v0.202631.0 

func (r *PipelineMigrationInstance) Update(ctx context.Context, params *pipelineapi.MigrationInstancePutParams, body pipelineapi.MigrationInstancePutJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.MigrationInstancePutResponse, error)

type PipelineMigrationInstances added in v0.202631.0 

type PipelineMigrationInstances struct {
	// contains filtered or unexported fields
}

PipelineMigrationInstances provides fluent v1-to-v2 migration instance operations.

func (*PipelineMigrationInstances) Create added in v0.202631.0 

func (r *PipelineMigrationInstances) Create(ctx context.Context, params *pipelineapi.MigrationInstanceCreatePostParams, body pipelineapi.MigrationInstanceCreatePostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.MigrationInstanceCreatePostResponse, error)

func (*PipelineMigrationInstances) ID added in v0.202631.0 

func (r *PipelineMigrationInstances) ID(uid string) *PipelineMigrationInstance

func (*PipelineMigrationInstances) List added in v0.202631.0 

func (r *PipelineMigrationInstances) List(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.MigrationInstanceAllGetResponse, error)

type PipelineMigrations added in v0.202631.0 

type PipelineMigrations struct {
	// contains filtered or unexported fields
}

PipelineMigrations provides fluent pipeline migration operations.

func (*PipelineMigrations) ID added in v0.202631.0 

func (r *PipelineMigrations) ID(uid string) *PipelineMigration

func (*PipelineMigrations) Instances added in v0.202631.0 

func (r *PipelineMigrations) Instances() *PipelineMigrationInstances

func (*PipelineMigrations) MigrateAll added in v0.202631.0 

func (r *PipelineMigrations) MigrateAll(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.MigrationMigrateAllPostResponse, error)

type PipelineQoS added in v0.202631.0 

type PipelineQoS struct {
	// contains filtered or unexported fields
}

PipelineQoS provides fluent pipeline quality-of-service configuration operations.

func (*PipelineQoS) Configuration added in v0.202631.0 

func (r *PipelineQoS) Configuration(function pipelineapi.QosFunction, tier pipelineapi.QosTier) *PipelineQoSConfiguration

func (*PipelineQoS) Create added in v0.202631.0 

func (r *PipelineQoS) Create(ctx context.Context, body pipelineapi.CreatePipelineQosConfigurationJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.CreatePipelineQosConfigurationResponse, error)

func (*PipelineQoS) List added in v0.202631.0 

func (r *PipelineQoS) List(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.GetPipelineQosConfigurationsResponse, error)

type PipelineQoSConfiguration added in v0.202631.0 

type PipelineQoSConfiguration struct {
	// contains filtered or unexported fields
}

PipelineQoSConfiguration provides fluent operations for one pipeline QoS configuration.

func (*PipelineQoSConfiguration) Delete added in v0.202631.0 

func (r *PipelineQoSConfiguration) Delete(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.DeletePipelineQosConfigurationResponse, error)

func (*PipelineQoSConfiguration) Get added in v0.202631.0 

func (r *PipelineQoSConfiguration) Get(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.GetPipelineQosConfigurationResponse, error)

func (*PipelineQoSConfiguration) Update added in v0.202631.0 

func (r *PipelineQoSConfiguration) Update(ctx context.Context, body pipelineapi.UpdatePipelineQosConfigurationJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.UpdatePipelineQosConfigurationResponse, error)

type PipelineTemplate added in v0.202631.0 

type PipelineTemplate struct {
	// contains filtered or unexported fields
}

PipelineTemplate provides fluent operations for one pipeline template.

func (*PipelineTemplate) AccessControls added in v0.202631.0 

func (r *PipelineTemplate) AccessControls() *PipelineTemplateAccessControls

func (*PipelineTemplate) Apply added in v0.202631.0 

func (r *PipelineTemplate) Apply(ctx context.Context, params *pipelineapi.TemplateApplyPostParams, body pipelineapi.TemplateApplyPostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateApplyPostResponse, error)

func (*PipelineTemplate) Delete added in v0.202631.0 

func (r *PipelineTemplate) Delete(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateDeleteResponse, error)

func (*PipelineTemplate) Get added in v0.202631.0 

func (r *PipelineTemplate) Get(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateGetResponse, error)

func (*PipelineTemplate) Update added in v0.202631.0 

func (r *PipelineTemplate) Update(ctx context.Context, body pipelineapi.TemplateUpdateJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateUpdateResponse, error)

type PipelineTemplateAccessControls added in v0.202631.0 

type PipelineTemplateAccessControls struct {
	// contains filtered or unexported fields
}

PipelineTemplateAccessControls provides fluent pipeline template access-control operations.

func (*PipelineTemplateAccessControls) DeleteOne added in v0.202631.0 

func (r *PipelineTemplateAccessControls) DeleteOne(ctx context.Context, entity string, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateAccessControlsEntityDeleteResponse, error)

func (*PipelineTemplateAccessControls) Get added in v0.202631.0 

func (r *PipelineTemplateAccessControls) Get(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateAccessControlsGetResponse, error)

func (*PipelineTemplateAccessControls) Update added in v0.202631.0 

func (r *PipelineTemplateAccessControls) Update(ctx context.Context, body pipelineapi.TemplateAccessControlsPostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateAccessControlsPostResponse, error)

type PipelineTemplates added in v0.202631.0 

type PipelineTemplates struct {
	// contains filtered or unexported fields
}

PipelineTemplates provides fluent pipeline template collection operations.

func (*PipelineTemplates) Create added in v0.202631.0 

func (r *PipelineTemplates) Create(ctx context.Context, body pipelineapi.TemplateCreatePostJSONRequestBody, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateCreatePostResponse, error)

func (*PipelineTemplates) ID added in v0.202631.0 

func (r *PipelineTemplates) ID(uid string) *PipelineTemplate

func (*PipelineTemplates) List added in v0.202631.0 

func (r *PipelineTemplates) List(ctx context.Context, params *pipelineapi.TemplateListGetParams, editors ...pipelineapi.RequestEditorFn) (*pipelineapi.TemplateListGetResponse, error)

type PipelineTransformerInstance added in v0.202631.0 

type PipelineTransformerInstance struct {
	// contains filtered or unexported fields
}

PipelineTransformerInstance provides fluent operations for one transformer instance in a pipeline.

func (*PipelineTransformerInstance) Logs added in v0.202631.0 

func (r *PipelineTransformerInstance) Logs(ctx context.Context, editors ...pipelineapi.RequestEditorFn) (*http.Response, error)

Logs streams logs for this transformer instance. The caller owns and must close the response body.

type PipelinesClient added in v0.202631.0 

type PipelinesClient struct {
	// contains filtered or unexported fields
}

PipelinesClient provides fluent access to the RDP v2 Pipelines API.

func (*PipelinesClient) Canvas added in v0.202631.0 

func (c *PipelinesClient) Canvas() *PipelineCanvas

Canvas returns fluent pipeline canvas catalog operations.

func (*PipelinesClient) Instances added in v0.202631.0 

func (c *PipelinesClient) Instances() *PipelineInstances

Instances returns fluent pipeline instance operations.

func (*PipelinesClient) Migrations added in v0.202631.0 

func (c *PipelinesClient) Migrations() *PipelineMigrations

Migrations returns fluent pipeline migration operations.

func (*PipelinesClient) QoS added in v0.202631.0 

func (c *PipelinesClient) QoS() *PipelineQoS

QoS returns fluent pipeline quality-of-service operations.

func (*PipelinesClient) Raw added in v0.202631.0 

func (c *PipelinesClient) Raw() pipelineapi.ClientWithResponsesInterface

Raw returns the generated OpenAPI response client for advanced use.

func (*PipelinesClient) Templates added in v0.202631.0 

func (c *PipelinesClient) Templates() *PipelineTemplates

Templates returns fluent pipeline template operations.

type Transformer added in v0.202631.0 

type Transformer struct {
	// contains filtered or unexported fields
}

Transformer provides fluent operations for one transformer working copy.

func (*Transformer) Delete added in v0.202631.0 

func (r *Transformer) Delete(ctx context.Context, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformersDeleteResponse, error)

func (*Transformer) Get added in v0.202631.0 

func (r *Transformer) Get(ctx context.Context, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformersGetResponse, error)

func (*Transformer) Update added in v0.202631.0 

func (r *Transformer) Update(ctx context.Context, body transformersapi.TransformersUpdateJSONRequestBody, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformersUpdateResponse, error)

func (*Transformer) Versions added in v0.202631.0 

func (r *Transformer) Versions() *TransformerVersions

type TransformerCatalog added in v0.202631.0 

type TransformerCatalog struct {
	// contains filtered or unexported fields
}

TransformerCatalog provides fluent transformer catalog operations.

func (*TransformerCatalog) List added in v0.202631.0 

func (r *TransformerCatalog) List(ctx context.Context, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformersCatalogListResponse, error)

List returns transformer catalog entries.

type TransformerVersion added in v0.202631.0 

type TransformerVersion struct {
	// contains filtered or unexported fields
}

TransformerVersion provides fluent operations for one published transformer version.

func (*TransformerVersion) Get added in v0.202631.0 

func (r *TransformerVersion) Get(ctx context.Context, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformerVersionsGetResponse, error)

type TransformerVersions added in v0.202631.0 

type TransformerVersions struct {
	// contains filtered or unexported fields
}

TransformerVersions provides fluent published-version operations for one transformer.

func (*TransformerVersions) List added in v0.202631.0 

func (r *TransformerVersions) List(ctx context.Context, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformerVersionsListResponse, error)

func (*TransformerVersions) Publish added in v0.202631.0 

func (r *TransformerVersions) Publish(ctx context.Context, body transformersapi.TransformerVersionsPublishJSONRequestBody, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformerVersionsPublishResponse, error)

func (*TransformerVersions) Version added in v0.202631.0 

func (r *TransformerVersions) Version(version string) *TransformerVersion

type TransformersClient added in v0.202631.0 

type TransformersClient struct {
	// contains filtered or unexported fields
}

TransformersClient provides fluent access to the RDP v2 Transformers API.

func (*TransformersClient) Catalog added in v0.202631.0 

func (c *TransformersClient) Catalog() *TransformerCatalog

Catalog returns fluent transformer catalog operations.

func (*TransformersClient) Create added in v0.202631.0 

func (c *TransformersClient) Create(ctx context.Context, body transformersapi.TransformersCreateJSONRequestBody, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformersCreateResponse, error)

Create creates a transformer working copy.

func (*TransformersClient) ID added in v0.202631.0 

func (c *TransformersClient) ID(uid transformersapi.TransformerUid) *Transformer

ID returns fluent operations for one transformer working copy.

func (*TransformersClient) List added in v0.202631.0 

func (c *TransformersClient) List(ctx context.Context, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformersListResponse, error)

List returns transformer working copies.

func (*TransformersClient) Raw added in v0.202631.0 

func (c *TransformersClient) Raw() transformersapi.ClientWithResponsesInterface

Raw returns the generated OpenAPI response client for advanced use.

func (*TransformersClient) Types added in v0.202631.0 

func (c *TransformersClient) Types(ctx context.Context, editors ...transformersapi.RequestEditorFn) (*transformersapi.TransformersTypesListResponse, error)

Types lists supported transformer type values.

Source Files

View all Source files

Directories

Path Synopsis
Package catalog provides primitives to interact with the openapi HTTP API.
 Package catalog provides primitives to interact with the openapi HTTP API.
examples
objects-publish command
Run:
 Run:
objects-search command
Run:
 Run:
Package internal holds the shared HTTP/auth/config infrastructure used by the public SDK facade package.
 Package internal holds the shared HTTP/auth/config infrastructure used by the public SDK facade package.
Package pipelines provides primitives to interact with the openapi HTTP API.
 Package pipelines provides primitives to interact with the openapi HTTP API.
Package transformers provides primitives to interact with the openapi HTTP API.
 Package transformers provides primitives to interact with the openapi HTTP API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.