v1

package
v0.89.2 Latest Latest
Warning

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

 Go to latest Published: Feb 23, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package v1 contains the API used to fetch support information.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	// Critical severity.
	SupportRequestSeverityCritical = "critical"
	// High severity.
	SupportRequestSeverityHigh = "high"
	// Normal severity.
	SupportRequestSeverityNormal = "normal"
	// Low severity.
	SupportRequestSeverityLow = "low"
)
View Source 
const (
	// SupportHoursBusiness indicates that support is handled during business hours.
	SupportHoursBusiness = "business"
	// SupportHours24x7 indicates that support is handled 24/7.
	SupportHours24x7 = "24x7"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "support/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 3
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 0
)

Variables

View Source 
var File_support_proto protoreflect.FileDescriptor

Functions

func ForEachPlan 

func ForEachPlan(ctx context.Context, listFunc func(ctx context.Context, req *ListPlansRequest) (*PlanList, error),
	req *ListPlansRequest, cb PlanCallback) error

ForEachPlan iterates over all support plans that match given given filter, invoking the given callback for each plan.

func RegisterSupportServiceHandler 

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

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

func RegisterSupportServiceHandlerClient 

func RegisterSupportServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SupportServiceClient) error

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

func RegisterSupportServiceHandlerFromEndpoint 

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

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

func RegisterSupportServiceHandlerServer 

func RegisterSupportServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SupportServiceServer) error

RegisterSupportServiceHandlerServer registers the http handlers for service SupportService to "mux". UnaryRPC :call SupportServiceServer 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 RegisterSupportServiceHandlerFromEndpoint instead.

func RegisterSupportServiceServer 

func RegisterSupportServiceServer(s *grpc.Server, srv SupportServiceServer)

Types

type FaqGroup 

type FaqGroup struct {

	// ID of the FAQ Group
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the FAQ Group
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

FaqGroup contains groups of faq entries

func (*FaqGroup) Descriptor deprecated 

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

Deprecated: Use FaqGroup.ProtoReflect.Descriptor instead.

func (*FaqGroup) GetId 

func (x *FaqGroup) GetId() string

func (*FaqGroup) GetName 

func (x *FaqGroup) GetName() string

func (*FaqGroup) ProtoMessage 

func (*FaqGroup) ProtoMessage()

func (*FaqGroup) ProtoReflect added in v0.89.0 

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

func (*FaqGroup) Reset 

func (x *FaqGroup) Reset()

func (*FaqGroup) String 

func (x *FaqGroup) String() string

type FaqGroupEntry 

type FaqGroupEntry struct {

	// The question of this entry
	Question string `protobuf:"bytes,1,opt,name=question,proto3" json:"question,omitempty"`
	// The answer to the question in this entry
	Answer string `protobuf:"bytes,2,opt,name=answer,proto3" json:"answer,omitempty"`
	// contains filtered or unexported fields
}

FaqGroupEntry contains entries for a group

func (*FaqGroupEntry) Descriptor deprecated 

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

Deprecated: Use FaqGroupEntry.ProtoReflect.Descriptor instead.

func (*FaqGroupEntry) GetAnswer 

func (x *FaqGroupEntry) GetAnswer() string

func (*FaqGroupEntry) GetQuestion 

func (x *FaqGroupEntry) GetQuestion() string

func (*FaqGroupEntry) ProtoMessage 

func (*FaqGroupEntry) ProtoMessage()

func (*FaqGroupEntry) ProtoReflect added in v0.89.0 

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

func (*FaqGroupEntry) Reset 

func (x *FaqGroupEntry) Reset()

func (*FaqGroupEntry) String 

func (x *FaqGroupEntry) String() string

type FaqGroupEntryList 

type FaqGroupEntryList struct {
	Items []*FaqGroupEntry `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of faq group entries.

func (*FaqGroupEntryList) Descriptor deprecated 

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

Deprecated: Use FaqGroupEntryList.ProtoReflect.Descriptor instead.

func (*FaqGroupEntryList) GetItems 

func (x *FaqGroupEntryList) GetItems() []*FaqGroupEntry

func (*FaqGroupEntryList) ProtoMessage 

func (*FaqGroupEntryList) ProtoMessage()

func (*FaqGroupEntryList) ProtoReflect added in v0.89.0 

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

func (*FaqGroupEntryList) Reset 

func (x *FaqGroupEntryList) Reset()

func (*FaqGroupEntryList) String 

func (x *FaqGroupEntryList) String() string

type FaqGroupList 

type FaqGroupList struct {
	Items []*FaqGroup `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of faq groups.

func (*FaqGroupList) Descriptor deprecated 

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

Deprecated: Use FaqGroupList.ProtoReflect.Descriptor instead.

func (*FaqGroupList) GetItems 

func (x *FaqGroupList) GetItems() []*FaqGroup

func (*FaqGroupList) ProtoMessage 

func (*FaqGroupList) ProtoMessage()

func (*FaqGroupList) ProtoReflect added in v0.89.0 

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

func (*FaqGroupList) Reset 

func (x *FaqGroupList) Reset()

func (*FaqGroupList) String 

func (x *FaqGroupList) String() string

type ListPlansRequest 

type ListPlansRequest struct {

	// Common list options
	Options *v1.ListOptions `protobuf:"bytes,1,opt,name=options,proto3" json:"options,omitempty"`
	// If set, list plans as they are available for the organization identified by this ID.
	OrganizationId string `protobuf:"bytes,2,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// If set, list plans as they are available for the deployment model identified by this field.
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// contains filtered or unexported fields
}

Arguments for a ListPlans request

func (*ListPlansRequest) Descriptor deprecated 

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

Deprecated: Use ListPlansRequest.ProtoReflect.Descriptor instead.

func (*ListPlansRequest) GetModel added in v0.63.12 

func (x *ListPlansRequest) GetModel() string

func (*ListPlansRequest) GetOptions 

func (x *ListPlansRequest) GetOptions() *v1.ListOptions

func (*ListPlansRequest) GetOrganizationId 

func (x *ListPlansRequest) GetOrganizationId() string

func (*ListPlansRequest) ProtoMessage 

func (*ListPlansRequest) ProtoMessage()

func (*ListPlansRequest) ProtoReflect added in v0.89.0 

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

func (*ListPlansRequest) Reset 

func (x *ListPlansRequest) Reset()

func (*ListPlansRequest) String 

func (x *ListPlansRequest) String() string

type Plan 

type Plan struct {

	// System identifier of the plan.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the plan.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// If set, this plan is the default support plan.
	IsDefault bool `protobuf:"varint,3,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// Human readable description of the plan
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// If set, this plan is shown, but not selectable.
	IsUnavailable bool `protobuf:"varint,5,opt,name=is_unavailable,json=isUnavailable,proto3" json:"is_unavailable,omitempty"`
	// SLA times to first response for various situations.
	// When this plan is unavailable, this field is optional.
	FirstResponseTimes *ResponseTimes `protobuf:"bytes,6,opt,name=first_response_times,json=firstResponseTimes,proto3" json:"first_response_times,omitempty"`
	// Support hours applicable to the SLA.
	// Possible values are "business" and "24x7".
	SupportHours string `protobuf:"bytes,7,opt,name=support_hours,json=supportHours,proto3" json:"support_hours,omitempty"`
	// contains filtered or unexported fields
}

Plan represents a specific support plan such as Bronze, Silver or Gold.

func (*Plan) Descriptor deprecated 

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

Deprecated: Use Plan.ProtoReflect.Descriptor instead.

func (*Plan) GetDescription 

func (x *Plan) GetDescription() string

func (*Plan) GetFirstResponseTimes 

func (x *Plan) GetFirstResponseTimes() *ResponseTimes

func (*Plan) GetId 

func (x *Plan) GetId() string

func (*Plan) GetIsDefault 

func (x *Plan) GetIsDefault() bool

func (*Plan) GetIsUnavailable 

func (x *Plan) GetIsUnavailable() bool

func (*Plan) GetName 

func (x *Plan) GetName() string

func (*Plan) GetSupportHours added in v0.49.1 

func (x *Plan) GetSupportHours() string

func (*Plan) ProtoMessage 

func (*Plan) ProtoMessage()

func (*Plan) ProtoReflect added in v0.89.0 

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

func (*Plan) Reset 

func (x *Plan) Reset()

func (*Plan) String 

func (x *Plan) String() string

type PlanCallback 

type PlanCallback func(context.Context, *Plan) error

PlanCallback is a callback for individual support plan.

type PlanList 

type PlanList struct {
	Items []*Plan `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of plans.

func (*PlanList) Descriptor deprecated 

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

Deprecated: Use PlanList.ProtoReflect.Descriptor instead.

func (*PlanList) GetItems 

func (x *PlanList) GetItems() []*Plan

func (*PlanList) ProtoMessage 

func (*PlanList) ProtoMessage()

func (*PlanList) ProtoReflect added in v0.89.0 

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

func (*PlanList) Reset 

func (x *PlanList) Reset()

func (*PlanList) String 

func (x *PlanList) String() string

type ResponseTimes 

type ResponseTimes struct {

	// Response time for operation-impeding Error in a production environment.
	Critical int32 `protobuf:"varint,1,opt,name=critical,proto3" json:"critical,omitempty"`
	// Response time for operation-limiting error.
	High int32 `protobuf:"varint,2,opt,name=high,proto3" json:"high,omitempty"`
	// Response time for minor error.
	Normal int32 `protobuf:"varint,3,opt,name=normal,proto3" json:"normal,omitempty"`
	// Response time for usage question.
	Low int32 `protobuf:"varint,4,opt,name=low,proto3" json:"low,omitempty"`
	// contains filtered or unexported fields
}

Response for various categories on situations. All values are in minutes. A value of 0 means "best effort".

func (*ResponseTimes) Descriptor deprecated 

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

Deprecated: Use ResponseTimes.ProtoReflect.Descriptor instead.

func (*ResponseTimes) GetCritical 

func (x *ResponseTimes) GetCritical() int32

func (*ResponseTimes) GetHigh 

func (x *ResponseTimes) GetHigh() int32

func (*ResponseTimes) GetLow 

func (x *ResponseTimes) GetLow() int32

func (*ResponseTimes) GetNormal 

func (x *ResponseTimes) GetNormal() int32

func (*ResponseTimes) ProtoMessage 

func (*ResponseTimes) ProtoMessage()

func (*ResponseTimes) ProtoReflect added in v0.89.0 

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

func (*ResponseTimes) Reset 

func (x *ResponseTimes) Reset()

func (*ResponseTimes) String 

func (x *ResponseTimes) String() string

type SupportRequest 

type SupportRequest struct {

	// ID of the request
	// This is a read-only field
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the user who submitted the support request
	// This is a required field
	UserName string `protobuf:"bytes,2,opt,name=user_name,json=userName,proto3" json:"user_name,omitempty"`
	// User ID is only provided if the user submitting the request has authenticated
	// This is an optional field
	UserId string `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Email address of the user if applicable submitting the request
	EmailAddress string `protobuf:"bytes,4,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"`
	// Optional identifier of the organization that is the subject of the support request
	OrganizationId string `protobuf:"bytes,5,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Optional identifier of the project that is the subject of the support request
	ProjectId string `protobuf:"bytes,6,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Optional identifier of the deployment that is the subject of the support request
	DeploymentId string `protobuf:"bytes,7,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Desciption which will contain the details provided by the submitter
	Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
	// Severity of the request. Can be one of the following: (low|normal|high|critical)
	Severity string `protobuf:"bytes,9,opt,name=severity,proto3" json:"severity,omitempty"`
	// Optional title which will contain the summary provided by the submitter (max 100 characters)
	// If not provided a title will be extracted from the description.
	Title string `protobuf:"bytes,10,opt,name=title,proto3" json:"title,omitempty"`
	// contains filtered or unexported fields
}

SupportRequest contains information about the request

func (*SupportRequest) Descriptor deprecated 

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

Deprecated: Use SupportRequest.ProtoReflect.Descriptor instead.

func (*SupportRequest) GetDeploymentId 

func (x *SupportRequest) GetDeploymentId() string

func (*SupportRequest) GetDescription 

func (x *SupportRequest) GetDescription() string

func (*SupportRequest) GetEmailAddress 

func (x *SupportRequest) GetEmailAddress() string

func (*SupportRequest) GetId 

func (x *SupportRequest) GetId() string

func (*SupportRequest) GetOrganizationId 

func (x *SupportRequest) GetOrganizationId() string

func (*SupportRequest) GetProjectId 

func (x *SupportRequest) GetProjectId() string

func (*SupportRequest) GetSeverity 

func (x *SupportRequest) GetSeverity() string

func (*SupportRequest) GetTitle added in v0.77.8 

func (x *SupportRequest) GetTitle() string

func (*SupportRequest) GetUserId 

func (x *SupportRequest) GetUserId() string

func (*SupportRequest) GetUserName 

func (x *SupportRequest) GetUserName() string

func (*SupportRequest) ProtoMessage 

func (*SupportRequest) ProtoMessage()

func (*SupportRequest) ProtoReflect added in v0.89.0 

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

func (*SupportRequest) Reset 

func (x *SupportRequest) Reset()

func (*SupportRequest) String 

func (x *SupportRequest) String() string

type SupportServiceClient 

type SupportServiceClient 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)
	// Fetch all support plans that are supported by the ArangoDB cloud.
	// Required permissions:
	// - None
	ListPlans(ctx context.Context, in *ListPlansRequest, opts ...grpc.CallOption) (*PlanList, error)
	// Fetch a support plan by its id.
	// Required permissions:
	// - None
	GetPlan(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*Plan, error)
	// Fetch all FAQ groups.
	// Required permissions:
	// - None
	ListFaqGroups(ctx context.Context, in *v1.ListOptions, opts ...grpc.CallOption) (*FaqGroupList, error)
	// Fetch all FAQ group entries of the FAQ group identified by the given context ID.
	// Required permissions:
	// - None
	ListFaqGroupEntries(ctx context.Context, in *v1.ListOptions, opts ...grpc.CallOption) (*FaqGroupEntryList, error)
	// Submit a support request.
	// Required permissions:
	// - resourcemanager.organization.get (if organization id is set)
	// - resourcemanager.project.get (if project id is set)
	// - data.deployment.get (if deployment id is set)
	// - None (if no ids are set)
	CreateSupportRequest(ctx context.Context, in *SupportRequest, opts ...grpc.CallOption) (*SupportRequest, error)
}

SupportServiceClient is the client API for SupportService service.

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

func NewSupportServiceClient 

func NewSupportServiceClient(cc grpc.ClientConnInterface) SupportServiceClient

type SupportServiceServer 

type SupportServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Fetch all support plans that are supported by the ArangoDB cloud.
	// Required permissions:
	// - None
	ListPlans(context.Context, *ListPlansRequest) (*PlanList, error)
	// Fetch a support plan by its id.
	// Required permissions:
	// - None
	GetPlan(context.Context, *v1.IDOptions) (*Plan, error)
	// Fetch all FAQ groups.
	// Required permissions:
	// - None
	ListFaqGroups(context.Context, *v1.ListOptions) (*FaqGroupList, error)
	// Fetch all FAQ group entries of the FAQ group identified by the given context ID.
	// Required permissions:
	// - None
	ListFaqGroupEntries(context.Context, *v1.ListOptions) (*FaqGroupEntryList, error)
	// Submit a support request.
	// Required permissions:
	// - resourcemanager.organization.get (if organization id is set)
	// - resourcemanager.project.get (if project id is set)
	// - data.deployment.get (if deployment id is set)
	// - None (if no ids are set)
	CreateSupportRequest(context.Context, *SupportRequest) (*SupportRequest, error)
}

SupportServiceServer is the server API for SupportService service.

type UnimplementedSupportServiceServer 

type UnimplementedSupportServiceServer struct {
}

UnimplementedSupportServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSupportServiceServer) CreateSupportRequest 

func (*UnimplementedSupportServiceServer) CreateSupportRequest(context.Context, *SupportRequest) (*SupportRequest, error)

func (*UnimplementedSupportServiceServer) GetAPIVersion 

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

func (*UnimplementedSupportServiceServer) GetPlan 

func (*UnimplementedSupportServiceServer) GetPlan(context.Context, *v1.IDOptions) (*Plan, error)

func (*UnimplementedSupportServiceServer) ListFaqGroupEntries 

func (*UnimplementedSupportServiceServer) ListFaqGroupEntries(context.Context, *v1.ListOptions) (*FaqGroupEntryList, error)

func (*UnimplementedSupportServiceServer) ListFaqGroups 

func (*UnimplementedSupportServiceServer) ListFaqGroups(context.Context, *v1.ListOptions) (*FaqGroupList, error)

func (*UnimplementedSupportServiceServer) ListPlans 

func (*UnimplementedSupportServiceServer) ListPlans(context.Context, *ListPlansRequest) (*PlanList, 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.