api

package
v11.1.4-modfix Latest Latest
Warning

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

 Go to latest Published: Aug 20, 2024 License: AGPL-3.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CloudMigrationAPI 

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

func RegisterApi 

func RegisterApi(
	rr routing.RouteRegister,
	cms cloudmigration.Service,
	tracer tracing.Tracer,
) *CloudMigrationAPI

func (*CloudMigrationAPI) CreateMigration 

func (cma *CloudMigrationAPI) CreateMigration(c *contextmodel.ReqContext) response.Response

swagger:route POST /cloudmigration/migration migrations createMigration

Create a migration.

Responses: 200: cloudMigrationResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) CreateToken 

func (cma *CloudMigrationAPI) CreateToken(c *contextmodel.ReqContext) response.Response

swagger:route POST /cloudmigration/token migrations createCloudMigrationToken

Create gcom access token.

Responses: 200: cloudMigrationCreateTokenResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) DeleteMigration 

func (cma *CloudMigrationAPI) DeleteMigration(c *contextmodel.ReqContext) response.Response

swagger:route DELETE /cloudmigration/migration/{uid} migrations deleteCloudMigration

Delete a migration.

Responses: 200 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) DeleteToken 

func (cma *CloudMigrationAPI) DeleteToken(c *contextmodel.ReqContext) response.Response

swagger:route DELETE /cloudmigration/token/{uid} migrations deleteCloudMigrationToken

Deletes a cloud migration token.

Responses: 204: cloudMigrationDeleteTokenResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) GetMigration 

func (cma *CloudMigrationAPI) GetMigration(c *contextmodel.ReqContext) response.Response

swagger:route GET /cloudmigration/migration/{uid} migrations getCloudMigration

Get a cloud migration.

It returns migrations that has been created.

Responses: 200: cloudMigrationResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) GetMigrationList 

func (cma *CloudMigrationAPI) GetMigrationList(c *contextmodel.ReqContext) response.Response

swagger:route GET /cloudmigration/migration migrations getMigrationList

Get a list of all cloud migrations.

Responses: 200: cloudMigrationListResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) GetMigrationRun 

func (cma *CloudMigrationAPI) GetMigrationRun(c *contextmodel.ReqContext) response.Response

swagger:route GET /cloudmigration/migration/run/{runUID} migrations getCloudMigrationRun

Get the result of a single migration run.

Responses: 200: cloudMigrationRunResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) GetMigrationRunList 

func (cma *CloudMigrationAPI) GetMigrationRunList(c *contextmodel.ReqContext) response.Response

swagger:route GET /cloudmigration/migration/{uid}/run migrations getCloudMigrationRunList

Get a list of migration runs for a migration.

Responses: 200: cloudMigrationRunListResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) GetToken 

func (cma *CloudMigrationAPI) GetToken(c *contextmodel.ReqContext) response.Response

swagger:route GET /cloudmigration/token migrations getCloudMigrationToken

Fetch the cloud migration token if it exists.

Responses: 200: cloudMigrationGetTokenResponse 401: unauthorisedError 404: notFoundError 403: forbiddenError 500: internalServerError

func (*CloudMigrationAPI) RunMigration 

func (cma *CloudMigrationAPI) RunMigration(c *contextmodel.ReqContext) response.Response

swagger:route POST /cloudmigration/migration/{uid}/run migrations runCloudMigration

Trigger the run of a migration to the Grafana Cloud.

It returns migrations that has been created.

Responses: 200: cloudMigrationRunResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

type CloudMigrationCreateTokenResponse 

type CloudMigrationCreateTokenResponse struct {
	// in: body
	Body CreateAccessTokenResponseDTO
}

swagger:response cloudMigrationCreateTokenResponse

type CloudMigrationDeleteTokenResponse 

type CloudMigrationDeleteTokenResponse struct {
}

swagger:response cloudMigrationDeleteTokenResponse

type CloudMigrationGetTokenResponse 

type CloudMigrationGetTokenResponse struct {
	// in: body
	Body GetAccessTokenResponseDTO
}

swagger:response cloudMigrationGetTokenResponse

type CloudMigrationListResponse 

type CloudMigrationListResponse struct {
	// in: body
	Body cloudmigration.CloudMigrationListResponse
}

swagger:response cloudMigrationListResponse

type CloudMigrationResponse 

type CloudMigrationResponse struct {
	// in: body
	Body cloudmigration.CloudMigrationResponse
}

swagger:response cloudMigrationResponse

type CloudMigrationRunListResponse 

type CloudMigrationRunListResponse struct {
	// in: body
	Body cloudmigration.CloudMigrationRunList
}

swagger:response cloudMigrationRunListResponse

type CloudMigrationRunResponse 

type CloudMigrationRunResponse struct {
	// in: body
	Body cloudmigration.MigrateDataResponseDTO
}

swagger:response cloudMigrationRunResponse

type CreateAccessTokenResponseDTO 

type CreateAccessTokenResponseDTO struct {
	Token string `json:"token"`
}

type CreateMigration 

type CreateMigration struct {
	// in:body
	// required:true
	Body cloudmigration.CloudMigrationRequest
}

swagger:parameters createMigration

type DeleteCloudMigrationToken 

type DeleteCloudMigrationToken struct {
	// UID of a cloud migration token
	//
	// in: path
	UID string `json:"uid"`
}

swagger:parameters deleteCloudMigrationToken

type DeleteMigrationRequest 

type DeleteMigrationRequest struct {
	// UID of a migration
	//
	// in: path
	UID string `json:"uid"`
}

swagger:parameters deleteCloudMigration

type GetAccessTokenResponseDTO 

type GetAccessTokenResponseDTO struct {
	ID          string `json:"id"`
	DisplayName string `json:"displayName"`
	ExpiresAt   string `json:"expiresAt"`
	FirstUsedAt string `json:"firstUsedAt"`
	LastUsedAt  string `json:"lastUsedAt"`
	CreatedAt   string `json:"createdAt"`
}

type GetCloudMigrationRequest 

type GetCloudMigrationRequest struct {
	// UID of a migration
	//
	// in: path
	UID string `json:"uid"`
}

swagger:parameters getCloudMigration

type GetCloudMigrationRunList 

type GetCloudMigrationRunList struct {
	// UID of a migration
	//
	// in: path
	UID string `json:"uid"`
}

swagger:parameters getCloudMigrationRunList

type GetCloudMigrationToken 

type GetCloudMigrationToken struct {
}

swagger:parameters getCloudMigrationToken

type GetMigrationRunParams 

type GetMigrationRunParams struct {
	// RunUID of a migration run
	//
	// in: path
	RunUID string `json:"runUID"`
}

swagger:parameters getCloudMigrationRun

type RunCloudMigrationRequest 

type RunCloudMigrationRequest struct {
	// UID of a migration
	//
	// in: path
	UID string `json:"uid"`
}

swagger:parameters runCloudMigration

Source Files

View all Source files

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.