onboarding

package
v0.9.2 Latest Latest
Warning

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

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

Documentation

Overview

Package onboarding is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Onboarding_ClaimTenant_FullMethodName     = "/aserto.tenant.onboarding.v1.Onboarding/ClaimTenant"
	Onboarding_TenantAvailable_FullMethodName = "/aserto.tenant.onboarding.v1.Onboarding/TenantAvailable"
	Onboarding_InviteUser_FullMethodName      = "/aserto.tenant.onboarding.v1.Onboarding/InviteUser"
)

Variables

View Source 
var (
	TenantAvailability_name = map[int32]string{
		0: "TENANT_AVAILABILITY_UNKNOWN",
		1: "TENANT_AVAILABILITY_AVAILABLE",
		2: "TENANT_AVAILABILITY_UNAVAILABLE",
		3: "TENANT_AVAILABILITY_INVALID",
		4: "TENANT_AVAILABILITY_PROFANE",
		5: "TENANT_AVAILABILITY_RESERVED",
		6: "TENANT_AVAILABILITY_MARKED_DELETED",
	}
	TenantAvailability_value = map[string]int32{
		"TENANT_AVAILABILITY_UNKNOWN":        0,
		"TENANT_AVAILABILITY_AVAILABLE":      1,
		"TENANT_AVAILABILITY_UNAVAILABLE":    2,
		"TENANT_AVAILABILITY_INVALID":        3,
		"TENANT_AVAILABILITY_PROFANE":        4,
		"TENANT_AVAILABILITY_RESERVED":       5,
		"TENANT_AVAILABILITY_MARKED_DELETED": 6,
	}
)

Enum value maps for TenantAvailability.

View Source 
var File_aserto_tenant_onboarding_v1_onboarding_proto protoreflect.FileDescriptor
View Source 
var Onboarding_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "aserto.tenant.onboarding.v1.Onboarding",
	HandlerType: (*OnboardingServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ClaimTenant",
			Handler:    _Onboarding_ClaimTenant_Handler,
		},
		{
			MethodName: "TenantAvailable",
			Handler:    _Onboarding_TenantAvailable_Handler,
		},
		{
			MethodName: "InviteUser",
			Handler:    _Onboarding_InviteUser_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "aserto/tenant/onboarding/v1/onboarding.proto",
}

Onboarding_ServiceDesc is the grpc.ServiceDesc for Onboarding service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterOnboardingHandler 

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

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

func RegisterOnboardingHandlerClient 

func RegisterOnboardingHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OnboardingClient) error

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

func RegisterOnboardingHandlerFromEndpoint 

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

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

func RegisterOnboardingHandlerServer 

func RegisterOnboardingHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OnboardingServer) error

RegisterOnboardingHandlerServer registers the http handlers for service Onboarding to "mux". UnaryRPC :call OnboardingServer 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 RegisterOnboardingHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterOnboardingServer 

func RegisterOnboardingServer(s grpc.ServiceRegistrar, srv OnboardingServer)

Types

type ClaimTenantRequest 

type ClaimTenantRequest struct {
	Name             string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Personal         bool   `protobuf:"varint,2,opt,name=personal,proto3" json:"personal,omitempty"`
	DefaultArtifacts bool   `protobuf:"varint,3,opt,name=default_artifacts,json=defaultArtifacts,proto3" json:"default_artifacts,omitempty"`
	// contains filtered or unexported fields
}

func (*ClaimTenantRequest) Descriptor deprecated 

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

Deprecated: Use ClaimTenantRequest.ProtoReflect.Descriptor instead.

func (*ClaimTenantRequest) GetDefaultArtifacts added in v0.8.13 

func (x *ClaimTenantRequest) GetDefaultArtifacts() bool

func (*ClaimTenantRequest) GetName 

func (x *ClaimTenantRequest) GetName() string

func (*ClaimTenantRequest) GetPersonal 

func (x *ClaimTenantRequest) GetPersonal() bool

func (*ClaimTenantRequest) ProtoMessage 

func (*ClaimTenantRequest) ProtoMessage()

func (*ClaimTenantRequest) ProtoReflect 

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

func (*ClaimTenantRequest) Reset 

func (x *ClaimTenantRequest) Reset()

func (*ClaimTenantRequest) String 

func (x *ClaimTenantRequest) String() string

type ClaimTenantResponse 

type ClaimTenantResponse struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*ClaimTenantResponse) Descriptor deprecated 

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

Deprecated: Use ClaimTenantResponse.ProtoReflect.Descriptor instead.

func (*ClaimTenantResponse) GetId 

func (x *ClaimTenantResponse) GetId() string

func (*ClaimTenantResponse) ProtoMessage 

func (*ClaimTenantResponse) ProtoMessage()

func (*ClaimTenantResponse) ProtoReflect 

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

func (*ClaimTenantResponse) Reset 

func (x *ClaimTenantResponse) Reset()

func (*ClaimTenantResponse) String 

func (x *ClaimTenantResponse) String() string

type InviteUserRequest 

type InviteUserRequest struct {
	AccountId string `protobuf:"bytes,1,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// contains filtered or unexported fields
}

func (*InviteUserRequest) Descriptor deprecated 

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

Deprecated: Use InviteUserRequest.ProtoReflect.Descriptor instead.

func (*InviteUserRequest) GetAccountId 

func (x *InviteUserRequest) GetAccountId() string

func (*InviteUserRequest) ProtoMessage 

func (*InviteUserRequest) ProtoMessage()

func (*InviteUserRequest) ProtoReflect 

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

func (*InviteUserRequest) Reset 

func (x *InviteUserRequest) Reset()

func (*InviteUserRequest) String 

func (x *InviteUserRequest) String() string

type InviteUserResponse 

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

func (*InviteUserResponse) Descriptor deprecated 

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

Deprecated: Use InviteUserResponse.ProtoReflect.Descriptor instead.

func (*InviteUserResponse) ProtoMessage 

func (*InviteUserResponse) ProtoMessage()

func (*InviteUserResponse) ProtoReflect 

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

func (*InviteUserResponse) Reset 

func (x *InviteUserResponse) Reset()

func (*InviteUserResponse) String 

func (x *InviteUserResponse) String() string

type OnboardingClient 

type OnboardingClient interface {
	ClaimTenant(ctx context.Context, in *ClaimTenantRequest, opts ...grpc.CallOption) (*ClaimTenantResponse, error)
	TenantAvailable(ctx context.Context, in *TenantAvailableRequest, opts ...grpc.CallOption) (*TenantAvailableResponse, error)
	InviteUser(ctx context.Context, in *InviteUserRequest, opts ...grpc.CallOption) (*InviteUserResponse, error)
}

OnboardingClient is the client API for Onboarding service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewOnboardingClient 

func NewOnboardingClient(cc grpc.ClientConnInterface) OnboardingClient

type OnboardingServer 

type OnboardingServer interface {
	ClaimTenant(context.Context, *ClaimTenantRequest) (*ClaimTenantResponse, error)
	TenantAvailable(context.Context, *TenantAvailableRequest) (*TenantAvailableResponse, error)
	InviteUser(context.Context, *InviteUserRequest) (*InviteUserResponse, error)
}

OnboardingServer is the server API for Onboarding service. All implementations should embed UnimplementedOnboardingServer for forward compatibility.

type TenantAvailability 

type TenantAvailability int32
const (
	TenantAvailability_TENANT_AVAILABILITY_UNKNOWN        TenantAvailability = 0
	TenantAvailability_TENANT_AVAILABILITY_AVAILABLE      TenantAvailability = 1
	TenantAvailability_TENANT_AVAILABILITY_UNAVAILABLE    TenantAvailability = 2
	TenantAvailability_TENANT_AVAILABILITY_INVALID        TenantAvailability = 3
	TenantAvailability_TENANT_AVAILABILITY_PROFANE        TenantAvailability = 4
	TenantAvailability_TENANT_AVAILABILITY_RESERVED       TenantAvailability = 5
	TenantAvailability_TENANT_AVAILABILITY_MARKED_DELETED TenantAvailability = 6
)

func (TenantAvailability) Descriptor 

func (TenantAvailability) Descriptor() protoreflect.EnumDescriptor

func (TenantAvailability) Enum 

func (x TenantAvailability) Enum() *TenantAvailability

func (TenantAvailability) EnumDescriptor deprecated 

func (TenantAvailability) EnumDescriptor() ([]byte, []int)

Deprecated: Use TenantAvailability.Descriptor instead.

func (TenantAvailability) Number 

func (x TenantAvailability) Number() protoreflect.EnumNumber

func (TenantAvailability) String 

func (x TenantAvailability) String() string

func (TenantAvailability) Type 

func (TenantAvailability) Type() protoreflect.EnumType

type TenantAvailableRequest 

type TenantAvailableRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*TenantAvailableRequest) Descriptor deprecated 

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

Deprecated: Use TenantAvailableRequest.ProtoReflect.Descriptor instead.

func (*TenantAvailableRequest) GetName 

func (x *TenantAvailableRequest) GetName() string

func (*TenantAvailableRequest) ProtoMessage 

func (*TenantAvailableRequest) ProtoMessage()

func (*TenantAvailableRequest) ProtoReflect 

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

func (*TenantAvailableRequest) Reset 

func (x *TenantAvailableRequest) Reset()

func (*TenantAvailableRequest) String 

func (x *TenantAvailableRequest) String() string

type TenantAvailableResponse 

type TenantAvailableResponse struct {
	Availability TenantAvailability `` /* 130-byte string literal not displayed */
	Reason       string             `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

func (*TenantAvailableResponse) Descriptor deprecated 

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

Deprecated: Use TenantAvailableResponse.ProtoReflect.Descriptor instead.

func (*TenantAvailableResponse) GetAvailability 

func (x *TenantAvailableResponse) GetAvailability() TenantAvailability

func (*TenantAvailableResponse) GetReason 

func (x *TenantAvailableResponse) GetReason() string

func (*TenantAvailableResponse) ProtoMessage 

func (*TenantAvailableResponse) ProtoMessage()

func (*TenantAvailableResponse) ProtoReflect 

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

func (*TenantAvailableResponse) Reset 

func (x *TenantAvailableResponse) Reset()

func (*TenantAvailableResponse) String 

func (x *TenantAvailableResponse) String() string

type UnimplementedOnboardingServer 

type UnimplementedOnboardingServer struct{}

UnimplementedOnboardingServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedOnboardingServer) ClaimTenant 

func (UnimplementedOnboardingServer) ClaimTenant(context.Context, *ClaimTenantRequest) (*ClaimTenantResponse, error)

func (UnimplementedOnboardingServer) InviteUser 

func (UnimplementedOnboardingServer) InviteUser(context.Context, *InviteUserRequest) (*InviteUserResponse, error)

func (UnimplementedOnboardingServer) TenantAvailable 

func (UnimplementedOnboardingServer) TenantAvailable(context.Context, *TenantAvailableRequest) (*TenantAvailableResponse, error)

type UnsafeOnboardingServer 

type UnsafeOnboardingServer interface {
	// contains filtered or unexported methods
}

UnsafeOnboardingServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to OnboardingServer will result in compilation errors.

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.