v1

package
v0.89.1 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2024 License: Apache-2.0 Imports: 18 Imported by: 2

Documentation

Overview

Package v1 contains the API of Tools services.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	// The name of the official ArangoGraph Insights Platform CLI management tool.
	ToolNameOasisctl = "oasisctl"
	// The name of the official tool for migration from on-premise deployments to ArangoGraph Insights Platform.
	ToolNameArangosyncMigration = "arangosync-migration"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "tools/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 0
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 1
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 0
)

Variables

View Source 
var File_tools_proto protoreflect.FileDescriptor

Functions

func RegisterToolsServiceHandler 

func RegisterToolsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterToolsServiceHandler registers the http handlers for service ToolsService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterToolsServiceHandlerClient 

func RegisterToolsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ToolsServiceClient) error

RegisterToolsServiceHandlerClient registers the http handlers for service ToolsService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ToolsServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ToolsServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ToolsServiceClient" to call the correct interceptors.

func RegisterToolsServiceHandlerFromEndpoint 

func RegisterToolsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterToolsServiceHandlerFromEndpoint is same as RegisterToolsServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterToolsServiceHandlerServer 

func RegisterToolsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ToolsServiceServer) error

RegisterToolsServiceHandlerServer registers the http handlers for service ToolsService to "mux". UnaryRPC :call ToolsServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterToolsServiceHandlerFromEndpoint instead.

func RegisterToolsServiceServer 

func RegisterToolsServiceServer(s *grpc.Server, srv ToolsServiceServer)

Types

type APIVersionPair 

type APIVersionPair struct {

	// ID of the api.
	ApiId string `protobuf:"bytes,1,opt,name=api_id,json=apiId,proto3" json:"api_id,omitempty"`
	// Expected version of the api.
	Version *v1.Version `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

The version pair describing the tools compatibility with an API.

func (*APIVersionPair) Descriptor deprecated 

func (*APIVersionPair) Descriptor() ([]byte, []int)

Deprecated: Use APIVersionPair.ProtoReflect.Descriptor instead.

func (*APIVersionPair) GetApiId 

func (x *APIVersionPair) GetApiId() string

func (*APIVersionPair) GetVersion 

func (x *APIVersionPair) GetVersion() *v1.Version

func (*APIVersionPair) ProtoMessage 

func (*APIVersionPair) ProtoMessage()

func (*APIVersionPair) ProtoReflect added in v0.89.0 

func (x *APIVersionPair) ProtoReflect() protoreflect.Message

func (*APIVersionPair) Reset 

func (x *APIVersionPair) Reset()

func (*APIVersionPair) String 

func (x *APIVersionPair) String() string

type GetLatestVersionRequest 

type GetLatestVersionRequest struct {

	// Name of the tool
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Version pair for the tool depicting compatibility with a given API.
	ExpectedApiVersions []*APIVersionPair `protobuf:"bytes,2,rep,name=expected_api_versions,json=expectedApiVersions,proto3" json:"expected_api_versions,omitempty"`
	// contains filtered or unexported fields
}

Request for GetLatestVersion

func (*GetLatestVersionRequest) Descriptor deprecated 

func (*GetLatestVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetLatestVersionRequest.ProtoReflect.Descriptor instead.

func (*GetLatestVersionRequest) GetExpectedApiVersions 

func (x *GetLatestVersionRequest) GetExpectedApiVersions() []*APIVersionPair

func (*GetLatestVersionRequest) GetName 

func (x *GetLatestVersionRequest) GetName() string

func (*GetLatestVersionRequest) ProtoMessage 

func (*GetLatestVersionRequest) ProtoMessage()

func (*GetLatestVersionRequest) ProtoReflect added in v0.89.0 

func (x *GetLatestVersionRequest) ProtoReflect() protoreflect.Message

func (*GetLatestVersionRequest) Reset 

func (x *GetLatestVersionRequest) Reset()

func (*GetLatestVersionRequest) String 

func (x *GetLatestVersionRequest) String() string

type ToolsServiceClient 

type ToolsServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// Get the latest version for a tool.
	// Required permissions:
	// - None
	GetLatestVersion(ctx context.Context, in *GetLatestVersionRequest, opts ...grpc.CallOption) (*ToolsVersion, error)
}

ToolsServiceClient is the client API for ToolsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewToolsServiceClient 

func NewToolsServiceClient(cc grpc.ClientConnInterface) ToolsServiceClient

type ToolsServiceServer 

type ToolsServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Get the latest version for a tool.
	// Required permissions:
	// - None
	GetLatestVersion(context.Context, *GetLatestVersionRequest) (*ToolsVersion, error)
}

ToolsServiceServer is the server API for ToolsService service.

type ToolsVersion 

type ToolsVersion struct {

	// Semantic versioning format of the latest known version of the tool that is compatible with the current API.
	LatestVersion string `protobuf:"bytes,1,opt,name=latest_version,json=latestVersion,proto3" json:"latest_version,omitempty"`
	// Download url of the latest version for a tool.
	DownloadUrl string `protobuf:"bytes,2,opt,name=download_url,json=downloadUrl,proto3" json:"download_url,omitempty"`
	// True if the current list of API-ID+versions is still compatible with current API.
	IsCompatible bool `protobuf:"varint,3,opt,name=is_compatible,json=isCompatible,proto3" json:"is_compatible,omitempty"`
	// contains filtered or unexported fields
}

Response for GetLatestVersion

func (*ToolsVersion) Descriptor deprecated 

func (*ToolsVersion) Descriptor() ([]byte, []int)

Deprecated: Use ToolsVersion.ProtoReflect.Descriptor instead.

func (*ToolsVersion) GetDownloadUrl 

func (x *ToolsVersion) GetDownloadUrl() string

func (*ToolsVersion) GetIsCompatible 

func (x *ToolsVersion) GetIsCompatible() bool

func (*ToolsVersion) GetLatestVersion 

func (x *ToolsVersion) GetLatestVersion() string

func (*ToolsVersion) ProtoMessage 

func (*ToolsVersion) ProtoMessage()

func (*ToolsVersion) ProtoReflect added in v0.89.0 

func (x *ToolsVersion) ProtoReflect() protoreflect.Message

func (*ToolsVersion) Reset 

func (x *ToolsVersion) Reset()

func (*ToolsVersion) String 

func (x *ToolsVersion) String() string

type UnimplementedToolsServiceServer 

type UnimplementedToolsServiceServer struct {
}

UnimplementedToolsServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedToolsServiceServer) GetAPIVersion 

func (*UnimplementedToolsServiceServer) GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)

func (*UnimplementedToolsServiceServer) GetLatestVersion 

func (*UnimplementedToolsServiceServer) GetLatestVersion(context.Context, *GetLatestVersionRequest) (*ToolsVersion, error)

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.