v1

package
v0.88.9 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 16 Imported by: 2

Documentation

Overview

Package tools/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 = 0
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 3
)

Variables

View Source 
var (
	ErrInvalidLengthTools        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTools          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupTools = fmt.Errorf("proto: unexpected end of group")
)

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.

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"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

The version pair describing the tools compatibility with an API.

func (*APIVersionPair) Descriptor 

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

func (*APIVersionPair) GetApiId 

func (m *APIVersionPair) GetApiId() string

func (*APIVersionPair) GetVersion 

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

func (*APIVersionPair) Marshal 

func (m *APIVersionPair) Marshal() (dAtA []byte, err error)

func (*APIVersionPair) MarshalTo 

func (m *APIVersionPair) MarshalTo(dAtA []byte) (int, error)

func (*APIVersionPair) MarshalToSizedBuffer 

func (m *APIVersionPair) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*APIVersionPair) ProtoMessage 

func (*APIVersionPair) ProtoMessage()

func (*APIVersionPair) Reset 

func (m *APIVersionPair) Reset()

func (*APIVersionPair) Size 

func (m *APIVersionPair) Size() (n int)

func (*APIVersionPair) String 

func (m *APIVersionPair) String() string

func (*APIVersionPair) Unmarshal 

func (m *APIVersionPair) Unmarshal(dAtA []byte) error

func (*APIVersionPair) XXX_DiscardUnknown 

func (m *APIVersionPair) XXX_DiscardUnknown()

func (*APIVersionPair) XXX_Marshal 

func (m *APIVersionPair) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*APIVersionPair) XXX_Merge 

func (m *APIVersionPair) XXX_Merge(src proto.Message)

func (*APIVersionPair) XXX_Size 

func (m *APIVersionPair) XXX_Size() int

func (*APIVersionPair) XXX_Unmarshal 

func (m *APIVersionPair) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

Request for GetLatestVersion

func (*GetLatestVersionRequest) Descriptor 

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

func (*GetLatestVersionRequest) GetExpectedApiVersions 

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

func (*GetLatestVersionRequest) GetName 

func (m *GetLatestVersionRequest) GetName() string

func (*GetLatestVersionRequest) Marshal 

func (m *GetLatestVersionRequest) Marshal() (dAtA []byte, err error)

func (*GetLatestVersionRequest) MarshalTo 

func (m *GetLatestVersionRequest) MarshalTo(dAtA []byte) (int, error)

func (*GetLatestVersionRequest) MarshalToSizedBuffer 

func (m *GetLatestVersionRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetLatestVersionRequest) ProtoMessage 

func (*GetLatestVersionRequest) ProtoMessage()

func (*GetLatestVersionRequest) Reset 

func (m *GetLatestVersionRequest) Reset()

func (*GetLatestVersionRequest) Size 

func (m *GetLatestVersionRequest) Size() (n int)

func (*GetLatestVersionRequest) String 

func (m *GetLatestVersionRequest) String() string

func (*GetLatestVersionRequest) Unmarshal 

func (m *GetLatestVersionRequest) Unmarshal(dAtA []byte) error

func (*GetLatestVersionRequest) XXX_DiscardUnknown 

func (m *GetLatestVersionRequest) XXX_DiscardUnknown()

func (*GetLatestVersionRequest) XXX_Marshal 

func (m *GetLatestVersionRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetLatestVersionRequest) XXX_Merge 

func (m *GetLatestVersionRequest) XXX_Merge(src proto.Message)

func (*GetLatestVersionRequest) XXX_Size 

func (m *GetLatestVersionRequest) XXX_Size() int

func (*GetLatestVersionRequest) XXX_Unmarshal 

func (m *GetLatestVersionRequest) XXX_Unmarshal(b []byte) error

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.ClientConn) 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Response for GetLatestVersion

func (*ToolsVersion) Descriptor 

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

func (*ToolsVersion) GetDownloadUrl 

func (m *ToolsVersion) GetDownloadUrl() string

func (*ToolsVersion) GetIsCompatible 

func (m *ToolsVersion) GetIsCompatible() bool

func (*ToolsVersion) GetLatestVersion 

func (m *ToolsVersion) GetLatestVersion() string

func (*ToolsVersion) Marshal 

func (m *ToolsVersion) Marshal() (dAtA []byte, err error)

func (*ToolsVersion) MarshalTo 

func (m *ToolsVersion) MarshalTo(dAtA []byte) (int, error)

func (*ToolsVersion) MarshalToSizedBuffer 

func (m *ToolsVersion) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ToolsVersion) ProtoMessage 

func (*ToolsVersion) ProtoMessage()

func (*ToolsVersion) Reset 

func (m *ToolsVersion) Reset()

func (*ToolsVersion) Size 

func (m *ToolsVersion) Size() (n int)

func (*ToolsVersion) String 

func (m *ToolsVersion) String() string

func (*ToolsVersion) Unmarshal 

func (m *ToolsVersion) Unmarshal(dAtA []byte) error

func (*ToolsVersion) XXX_DiscardUnknown 

func (m *ToolsVersion) XXX_DiscardUnknown()

func (*ToolsVersion) XXX_Marshal 

func (m *ToolsVersion) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ToolsVersion) XXX_Merge 

func (m *ToolsVersion) XXX_Merge(src proto.Message)

func (*ToolsVersion) XXX_Size 

func (m *ToolsVersion) XXX_Size() int

func (*ToolsVersion) XXX_Unmarshal 

func (m *ToolsVersion) XXX_Unmarshal(b []byte) error

type UnimplementedToolsServiceServer 

type UnimplementedToolsServiceServer struct {
}

UnimplementedToolsServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedToolsServiceServer) GetAPIVersion 

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

func (*UnimplementedToolsServiceServer) GetLatestVersion 

func (*UnimplementedToolsServiceServer) GetLatestVersion(ctx context.Context, req *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.