Skip to content

Latest commit

 

History

History
476 lines (316 loc) · 14.6 KB

PITRManagementApi.md

File metadata and controls

476 lines (316 loc) · 14.6 KB

\PITRManagementApi

All URIs are relative to http://localhost

Method HTTP request Description
CloneNamespace Post /api/v1/customers/{cUUID}/universes/{uniUUID}/keyspaces/{tableType}/{keyspaceName}/clone Create clone of a namespace in a universe
CreatePitrConfig Post /api/v1/customers/{cUUID}/universes/{uniUUID}/keyspaces/{tableType}/{keyspaceName}/pitr_config Create pitr config for a keyspace in a universe
DeletePitrConfig Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config/{pUUID} Delete pitr config on a universe
ListOfPitrConfigs Get /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config List the PITR configs of a universe
PerformPitr Post /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr Perform PITR on a universe
UpdatePitrConfig Put /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config/{pUUID} Update pitr config for a keyspace in a universe

CloneNamespace

YBPTask CloneNamespace(ctx, cUUID, uniUUID, tableType, keyspaceName).NamespaceClone(namespaceClone).Request(request).Execute()

Create clone of a namespace in a universe

Example

package main

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

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    tableType := "tableType_example" // string | 
    keyspaceName := "keyspaceName_example" // string | 
    namespaceClone := *openapiclient.NewCloneNamespaceParams(*openapiclient.NewUsers("[email protected]", []string{"GroupMemberships_example"}, false), "PlatformUrl_example", "PlatformVersion_example", int32(123), int32(123)) // CloneNamespaceParams | post namespace clone
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.PITRManagementApi.CloneNamespace(context.Background(), cUUID, uniUUID, tableType, keyspaceName).NamespaceClone(namespaceClone).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PITRManagementApi.CloneNamespace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloneNamespace`: YBPTask
    fmt.Fprintf(os.Stdout, "Response from `PITRManagementApi.CloneNamespace`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

namespaceClone | CloneNamespaceParams | post namespace clone | request | interface{} | |

Return type

YBPTask

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]

CreatePitrConfig

YBPTask CreatePitrConfig(ctx, cUUID, uniUUID, tableType, keyspaceName).PitrConfig(pitrConfig).Request(request).Execute()

Create pitr config for a keyspace in a universe

Example

package main

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

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    tableType := "tableType_example" // string | 
    keyspaceName := "keyspaceName_example" // string | 
    pitrConfig := *openapiclient.NewCreatePitrConfigParams(*openapiclient.NewUsers("[email protected]", []string{"GroupMemberships_example"}, false), "PlatformUrl_example", "PlatformVersion_example", int32(123), int32(123)) // CreatePitrConfigParams | post pitr config
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.PITRManagementApi.CreatePitrConfig(context.Background(), cUUID, uniUUID, tableType, keyspaceName).PitrConfig(pitrConfig).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PITRManagementApi.CreatePitrConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreatePitrConfig`: YBPTask
    fmt.Fprintf(os.Stdout, "Response from `PITRManagementApi.CreatePitrConfig`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

pitrConfig | CreatePitrConfigParams | post pitr config | request | interface{} | |

Return type

YBPTask

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]

DeletePitrConfig

YBPSuccess DeletePitrConfig(ctx, cUUID, uniUUID, pUUID).Request(request).Execute()

Delete pitr config on a universe

Example

package main

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

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    pUUID := TODO // string | 
    request := TODO // interface{} |  (optional)

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiDeletePitrConfigRequest 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]

ListOfPitrConfigs

[]PitrConfig ListOfPitrConfigs(ctx, cUUID, uniUUID).Execute()

List the PITR configs of a universe

Example

package main

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

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]PitrConfig

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]

PerformPitr

YBPTask PerformPitr(ctx, cUUID, uniUUID).PerformPitr(performPitr).Request(request).Execute()

Perform PITR on a universe

Example

package main

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

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    performPitr := *openapiclient.NewRestoreSnapshotScheduleParams(*openapiclient.NewUsers("[email protected]", []string{"GroupMemberships_example"}, false), "PlatformUrl_example", "PlatformVersion_example", int32(123), int32(123)) // RestoreSnapshotScheduleParams | perform PITR
    request := TODO // interface{} |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

performPitr | RestoreSnapshotScheduleParams | perform PITR | request | interface{} | |

Return type

YBPTask

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]

UpdatePitrConfig

YBPTask UpdatePitrConfig(ctx, cUUID, uniUUID, pUUID).PitrConfig(pitrConfig).Request(request).Execute()

Update pitr config for a keyspace in a universe

Example

package main

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

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    pUUID := TODO // string | 
    pitrConfig := *openapiclient.NewUpdatePitrConfigParams(*openapiclient.NewUsers("[email protected]", []string{"GroupMemberships_example"}, false), "PlatformUrl_example", "PlatformVersion_example", int32(123), int32(123)) // UpdatePitrConfigParams | put pitr config
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.PITRManagementApi.UpdatePitrConfig(context.Background(), cUUID, uniUUID, pUUID).PitrConfig(pitrConfig).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PITRManagementApi.UpdatePitrConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdatePitrConfig`: YBPTask
    fmt.Fprintf(os.Stdout, "Response from `PITRManagementApi.UpdatePitrConfig`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

pitrConfig | UpdatePitrConfigParams | put pitr config | request | interface{} | |

Return type

YBPTask

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]