Skip to content

TopologySynchronizationApi.md

Latest commit

 

History

History
273 lines (171 loc) · 8.42 KB

TopologySynchronizationApi.md

File metadata and controls

273 lines (171 loc) · 8.42 KB

\TopologySynchronizationApi

All URIs are relative to http://localhost

Method HTTP request Description
GetTopologySynchronizationStreamById Get /synchronization/topology/streams/sync Overview of a specific Topology Stream, queried by node id or sync identifier
GetTopologySynchronizationStreamStatusById Get /synchronization/topology/streams/status Metrics of a specific Topology Stream, queried by node id
GetTopologySynchronizationStreams Get /synchronization/topology/streams Overview of the topology synchronization streams
PostTopologySynchronizationStreamClearErrors Post /synchronization/topology/streams/clearErrors Clear all the errors related to a specific sync

GetTopologySynchronizationStreamById

TopologyStreamListItemWithErrorDetails GetTopologySynchronizationStreamById(ctx).Identifier(identifier).IdentifierType(identifierType).Execute()

Overview of a specific Topology Stream, queried by node id or sync identifier

Example

package main

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

func main() {
    identifier := "identifier_example" // string | 
    identifierType := openapiclient.IdentifierType("NodeId") // IdentifierType | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TopologySynchronizationApi.GetTopologySynchronizationStreamById(context.Background()).Identifier(identifier).IdentifierType(identifierType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TopologySynchronizationApi.GetTopologySynchronizationStreamById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTopologySynchronizationStreamById`: TopologyStreamListItemWithErrorDetails
    fmt.Fprintf(os.Stdout, "Response from `TopologySynchronizationApi.GetTopologySynchronizationStreamById`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
identifier string
identifierType IdentifierType

Return type

TopologyStreamListItemWithErrorDetails

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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

GetTopologySynchronizationStreamStatusById

TopologyStreamMetrics GetTopologySynchronizationStreamStatusById(ctx).Identifier(identifier).Execute()

Metrics of a specific Topology Stream, queried by node id

Example

package main

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

func main() {
    identifier := "identifier_example" // string | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
identifier string

Return type

TopologyStreamMetrics

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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

GetTopologySynchronizationStreams

TopologyStreamList GetTopologySynchronizationStreams(ctx).Execute()

Overview of the topology synchronization streams

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

TopologyStreamList

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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

PostTopologySynchronizationStreamClearErrors

PostTopologySynchronizationStreamClearErrors(ctx).Identifier(identifier).IdentifierType(identifierType).Execute()

Clear all the errors related to a specific sync

Example

package main

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

func main() {
    identifier := "identifier_example" // string | 
    identifierType := openapiclient.IdentifierType("NodeId") // IdentifierType | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TopologySynchronizationApi.PostTopologySynchronizationStreamClearErrors(context.Background()).Identifier(identifier).IdentifierType(identifierType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TopologySynchronizationApi.PostTopologySynchronizationStreamClearErrors``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

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

Name Type Description Notes
identifier string
identifierType IdentifierType

Return type

(empty response body)

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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