Skip to content

Latest commit

 

History

History
304 lines (194 loc) · 8.53 KB

File metadata and controls

304 lines (194 loc) · 8.53 KB

\TelemetryProviderAPI

All URIs are relative to http://localhost

Method HTTP request Description
CreateTelemetry Post /api/v1/customers/{cUUID}/telemetry_provider Create Telemetry Provider
DeleteTelemetryProvider Delete /api/v1/customers/{cUUID}/telemetry_provider/{intUUID} Delete a telemetry provider
GetTelemetryProvider Get /api/v1/customers/{cUUID}/telemetry_provider/{intUUID} Get Telemetry Provider
ListAllTelemetryProviders Get /api/v1/customers/{cUUID}/telemetry_provider List All Telemetry Providers

CreateTelemetry

TelemetryProvider CreateTelemetry(ctx, cUUID).ProviderData(providerData).Request(request).Execute()

Create Telemetry Provider

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	providerData := *openapiclient.NewTelemetryProvider(*openapiclient.NewTelemetryProviderConfig(), "CustomerUUID_example", "Name_example", map[string]string{"key": "Inner_example"}, "Uuid_example") // TelemetryProvider | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TelemetryProviderAPI.CreateTelemetry(context.Background(), cUUID).ProviderData(providerData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TelemetryProviderAPI.CreateTelemetry``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateTelemetry`: TelemetryProvider
	fmt.Fprintf(os.Stdout, "Response from `TelemetryProviderAPI.CreateTelemetry`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string

Other Parameters

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

Name Type Description Notes

providerData | TelemetryProvider | | request | interface{} | |

Return type

TelemetryProvider

Authorization

apiKeyAuth

HTTP request headers

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

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

DeleteTelemetryProvider

YBPSuccess DeleteTelemetryProvider(ctx, cUUID, intUUID).Request(request).Execute()

Delete a telemetry provider

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	intUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TelemetryProviderAPI.DeleteTelemetryProvider(context.Background(), cUUID, intUUID).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TelemetryProviderAPI.DeleteTelemetryProvider``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteTelemetryProvider`: YBPSuccess
	fmt.Fprintf(os.Stdout, "Response from `TelemetryProviderAPI.DeleteTelemetryProvider`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
intUUID string

Other Parameters

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

Name Type Description Notes

request | interface{} | |

Return type

YBPSuccess

Authorization

apiKeyAuth

HTTP request headers

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

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

GetTelemetryProvider

TelemetryProvider GetTelemetryProvider(ctx, cUUID, intUUID).Execute()

Get Telemetry Provider

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	intUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TelemetryProviderAPI.GetTelemetryProvider(context.Background(), cUUID, intUUID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TelemetryProviderAPI.GetTelemetryProvider``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTelemetryProvider`: TelemetryProvider
	fmt.Fprintf(os.Stdout, "Response from `TelemetryProviderAPI.GetTelemetryProvider`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
intUUID string

Other Parameters

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

Name Type Description Notes

Return type

TelemetryProvider

Authorization

apiKeyAuth

HTTP request headers

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

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

ListAllTelemetryProviders

[]TelemetryProvider ListAllTelemetryProviders(ctx, cUUID).Execute()

List All Telemetry Providers

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TelemetryProviderAPI.ListAllTelemetryProviders(context.Background(), cUUID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TelemetryProviderAPI.ListAllTelemetryProviders``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListAllTelemetryProviders`: []TelemetryProvider
	fmt.Fprintf(os.Stdout, "Response from `TelemetryProviderAPI.ListAllTelemetryProviders`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string

Other Parameters

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

Name Type Description Notes

Return type

[]TelemetryProvider

Authorization

apiKeyAuth

HTTP request headers

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

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