Skip to content

UploadReleasePackagesAPI.md

Latest commit

 

History

History
157 lines (100 loc) · 4.25 KB

UploadReleasePackagesAPI.md

File metadata and controls

157 lines (100 loc) · 4.25 KB

\UploadReleasePackagesAPI

All URIs are relative to http://localhost

Method HTTP request Description
GetUploadRelease Get /api/v1/customers/{cUUID}/ybdb_release/upload/{rUUID} get an uploaded release metadata
UploadRelease Post /api/v1/customers/{cUUID}/ybdb_release/upload upload a release tgz

GetUploadRelease

ResponseExtractMetadata GetUploadRelease(ctx, cUUID, rUUID).Request(request).Execute()

get an uploaded release metadata

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

request | interface{} | |

Return type

ResponseExtractMetadata

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]

UploadRelease

YBPCreateSuccess UploadRelease(ctx, cUUID).Request(request).Execute()

upload a release tgz

Example

package main

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

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UploadReleasePackagesAPI.UploadRelease(context.Background(), cUUID).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UploadReleasePackagesAPI.UploadRelease``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UploadRelease`: YBPCreateSuccess
	fmt.Fprintf(os.Stdout, "Response from `UploadReleasePackagesAPI.UploadRelease`: %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 apiUploadReleaseRequest struct via the builder pattern

Name Type Description Notes

request | interface{} | |

Return type

YBPCreateSuccess

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]