org

package
v0.6.16 Latest Latest
Warning

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

 Go to latest Published: Jun 14, 2021 License: Apache-2.0 Imports: 20 Imported by: 1

Documentation

Overview

Package org is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_org_v1_org_proto protoreflect.FileDescriptor
View Source 
var OrgApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "blueapi.org.v1.OrgApi",
	HandlerType: (*OrgApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateOrg",
			Handler:    _OrgApi_CreateOrg_Handler,
		},
		{
			MethodName: "SendVerification",
			Handler:    _OrgApi_SendVerification_Handler,
		},
		{
			MethodName: "VerifyOrg",
			Handler:    _OrgApi_VerifyOrg_Handler,
		},
		{
			MethodName: "GetOrg",
			Handler:    _OrgApi_GetOrg_Handler,
		},
		{
			MethodName: "UpdateAttribute",
			Handler:    _OrgApi_UpdateAttribute_Handler,
		},
		{
			MethodName: "UpdatePassword",
			Handler:    _OrgApi_UpdatePassword_Handler,
		},
		{
			MethodName: "ListMasterAccounts",
			Handler:    _OrgApi_ListMasterAccounts_Handler,
		},
		{
			MethodName: "DeleteOrg",
			Handler:    _OrgApi_DeleteOrg_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "org/v1/org.proto",
}

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

Functions

func RegisterOrgApiHandler added in v0.6.11 

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

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

func RegisterOrgApiHandlerClient added in v0.6.11 

func RegisterOrgApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OrgApiClient) error

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

func RegisterOrgApiHandlerFromEndpoint added in v0.6.11 

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

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

func RegisterOrgApiHandlerServer added in v0.6.11 

func RegisterOrgApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OrgApiServer) error

RegisterOrgApiHandlerServer registers the http handlers for service OrgApi to "mux". UnaryRPC :call OrgApiServer 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 RegisterOrgApiHandlerFromEndpoint instead.

func RegisterOrgApiServer added in v0.6.11 

func RegisterOrgApiServer(s grpc.ServiceRegistrar, srv OrgApiServer)

Types

type ClientOptions added in v0.6.10 

type ClientOptions struct {
	Conn *conn.GrpcClientConn
}

ClientOptions represents the optional options to NewClient.

type CreateOrgRequest added in v0.6.13 

type CreateOrgRequest struct {
	Email       string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Request message for OrgApi.CreateOrg rpc.

func (*CreateOrgRequest) Descriptor deprecated added in v0.6.13 

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

Deprecated: Use CreateOrgRequest.ProtoReflect.Descriptor instead.

func (*CreateOrgRequest) GetDescription added in v0.6.13 

func (x *CreateOrgRequest) GetDescription() string

func (*CreateOrgRequest) GetEmail added in v0.6.13 

func (x *CreateOrgRequest) GetEmail() string

func (*CreateOrgRequest) ProtoMessage added in v0.6.13 

func (*CreateOrgRequest) ProtoMessage()

func (*CreateOrgRequest) ProtoReflect added in v0.6.13 

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

func (*CreateOrgRequest) Reset added in v0.6.13 

func (x *CreateOrgRequest) Reset()

func (*CreateOrgRequest) String added in v0.6.13 

func (x *CreateOrgRequest) String() string

type CreateOrgResponse added in v0.6.15 

type CreateOrgResponse struct {
	Org      *Org   `protobuf:"bytes,1,opt,name=org,proto3" json:"org,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

Response message for OrgApi.CreateOrg rpc.

func (*CreateOrgResponse) Descriptor deprecated added in v0.6.15 

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

Deprecated: Use CreateOrgResponse.ProtoReflect.Descriptor instead.

func (*CreateOrgResponse) GetOrg added in v0.6.15 

func (x *CreateOrgResponse) GetOrg() *Org

func (*CreateOrgResponse) GetPassword added in v0.6.15 

func (x *CreateOrgResponse) GetPassword() string

func (*CreateOrgResponse) ProtoMessage added in v0.6.15 

func (*CreateOrgResponse) ProtoMessage()

func (*CreateOrgResponse) ProtoReflect added in v0.6.15 

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

func (*CreateOrgResponse) Reset added in v0.6.15 

func (x *CreateOrgResponse) Reset()

func (*CreateOrgResponse) String added in v0.6.15 

func (x *CreateOrgResponse) String() string

type DeleteOrgRequest added in v0.6.16 

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

Request message for OrgApi.DeleteOrg rpc.

func (*DeleteOrgRequest) Descriptor deprecated added in v0.6.16 

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

Deprecated: Use DeleteOrgRequest.ProtoReflect.Descriptor instead.

func (*DeleteOrgRequest) ProtoMessage added in v0.6.16 

func (*DeleteOrgRequest) ProtoMessage()

func (*DeleteOrgRequest) ProtoReflect added in v0.6.16 

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

func (*DeleteOrgRequest) Reset added in v0.6.16 

func (x *DeleteOrgRequest) Reset()

func (*DeleteOrgRequest) String added in v0.6.16 

func (x *DeleteOrgRequest) String() string

type GetOrgRequest added in v0.6.11 

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

Request message for OrgApi.GetOrg rpc.

func (*GetOrgRequest) Descriptor deprecated added in v0.6.11 

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

Deprecated: Use GetOrgRequest.ProtoReflect.Descriptor instead.

func (*GetOrgRequest) ProtoMessage added in v0.6.11 

func (*GetOrgRequest) ProtoMessage()

func (*GetOrgRequest) ProtoReflect added in v0.6.11 

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

func (*GetOrgRequest) Reset added in v0.6.11 

func (x *GetOrgRequest) Reset()

func (*GetOrgRequest) String added in v0.6.11 

func (x *GetOrgRequest) String() string

type GrpcClient added in v0.6.6 

type GrpcClient struct {
	OrgApiClient
	// contains filtered or unexported fields
}

func NewClient added in v0.6.6 

func NewClient(ctx context.Context, opts ...*ClientOptions) (*GrpcClient, error)

NewClient returns a client connection to the 'org' service.

func (*GrpcClient) Close added in v0.6.6 

func (c *GrpcClient) Close()

type ListMasterAccountsRequest added in v0.6.14 

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

Request message for OrgApi.ListMasterAccounts rpc.

func (*ListMasterAccountsRequest) Descriptor deprecated added in v0.6.14 

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

Deprecated: Use ListMasterAccountsRequest.ProtoReflect.Descriptor instead.

func (*ListMasterAccountsRequest) ProtoMessage added in v0.6.14 

func (*ListMasterAccountsRequest) ProtoMessage()

func (*ListMasterAccountsRequest) ProtoReflect added in v0.6.14 

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

func (*ListMasterAccountsRequest) Reset added in v0.6.14 

func (x *ListMasterAccountsRequest) Reset()

func (*ListMasterAccountsRequest) String added in v0.6.14 

func (x *ListMasterAccountsRequest) String() string

type ListMasterAccountsResponse added in v0.6.14 

type ListMasterAccountsResponse struct {
	Accounts []*aws.Account `protobuf:"bytes,1,rep,name=accounts,proto3" json:"accounts,omitempty"`
	// contains filtered or unexported fields
}

Response message for OrgApi.ListMasterAccounts rpc.

func (*ListMasterAccountsResponse) Descriptor deprecated added in v0.6.14 

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

Deprecated: Use ListMasterAccountsResponse.ProtoReflect.Descriptor instead.

func (*ListMasterAccountsResponse) GetAccounts added in v0.6.14 

func (x *ListMasterAccountsResponse) GetAccounts() []*aws.Account

func (*ListMasterAccountsResponse) ProtoMessage added in v0.6.14 

func (*ListMasterAccountsResponse) ProtoMessage()

func (*ListMasterAccountsResponse) ProtoReflect added in v0.6.14 

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

func (*ListMasterAccountsResponse) Reset added in v0.6.14 

func (x *ListMasterAccountsResponse) Reset()

func (*ListMasterAccountsResponse) String added in v0.6.14 

func (x *ListMasterAccountsResponse) String() string

type Org added in v0.6.11 

type Org struct {

	// The unique name (or id) of the organization.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The registered email of the organization.
	Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// The optional description of the organization.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The attributes (key/value pair) of the organization. Supported attributes include 'createTime'.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Org resource definition.

func (*Org) Descriptor deprecated added in v0.6.11 

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

Deprecated: Use Org.ProtoReflect.Descriptor instead.

func (*Org) GetDescription added in v0.6.11 

func (x *Org) GetDescription() string

func (*Org) GetEmail added in v0.6.11 

func (x *Org) GetEmail() string

func (*Org) GetMetadata added in v0.6.11 

func (x *Org) GetMetadata() map[string]string

func (*Org) GetName added in v0.6.11 

func (x *Org) GetName() string

func (*Org) ProtoMessage added in v0.6.11 

func (*Org) ProtoMessage()

func (*Org) ProtoReflect added in v0.6.11 

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

func (*Org) Reset added in v0.6.11 

func (x *Org) Reset()

func (*Org) String added in v0.6.11 

func (x *Org) String() string

type OrgApiClient added in v0.6.11 

type OrgApiClient interface {
	// Creates the organization account.
	CreateOrg(ctx context.Context, in *CreateOrgRequest, opts ...grpc.CallOption) (*Org, error)
	// Sends (or resends) the verification email. Only valid for unverified
	// organizations. The verification key will be valid for a day.
	SendVerification(ctx context.Context, in *SendVerificationRequest, opts ...grpc.CallOption) (*Org, error)
	// Verifies an organization using the key received from the verification email.
	// The verification key is only valid for a day.
	VerifyOrg(ctx context.Context, in *VerifyOrgRequest, opts ...grpc.CallOption) (*Org, error)
	// Gets information about the caller's organization.
	GetOrg(ctx context.Context, in *GetOrgRequest, opts ...grpc.CallOption) (*Org, error)
	// Updates organization attributes. Supported attributes include 'email', and 'description'.
	UpdateAttribute(ctx context.Context, in *UpdateAttributeRequest, opts ...grpc.CallOption) (*Org, error)
	// Updates the organization password.
	UpdatePassword(ctx context.Context, in *UpdatePasswordRequest, opts ...grpc.CallOption) (*Org, error)
	// Lists master accounts that belongs to the caller's organization.
	ListMasterAccounts(ctx context.Context, in *ListMasterAccountsRequest, opts ...grpc.CallOption) (*ListMasterAccountsResponse, error)
	// Deletes the organization.
	DeleteOrg(ctx context.Context, in *DeleteOrgRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

OrgApiClient is the client API for OrgApi 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 NewOrgApiClient added in v0.6.11 

func NewOrgApiClient(cc grpc.ClientConnInterface) OrgApiClient

type OrgApiServer added in v0.6.11 

type OrgApiServer interface {
	// Creates the organization account.
	CreateOrg(context.Context, *CreateOrgRequest) (*Org, error)
	// Sends (or resends) the verification email. Only valid for unverified
	// organizations. The verification key will be valid for a day.
	SendVerification(context.Context, *SendVerificationRequest) (*Org, error)
	// Verifies an organization using the key received from the verification email.
	// The verification key is only valid for a day.
	VerifyOrg(context.Context, *VerifyOrgRequest) (*Org, error)
	// Gets information about the caller's organization.
	GetOrg(context.Context, *GetOrgRequest) (*Org, error)
	// Updates organization attributes. Supported attributes include 'email', and 'description'.
	UpdateAttribute(context.Context, *UpdateAttributeRequest) (*Org, error)
	// Updates the organization password.
	UpdatePassword(context.Context, *UpdatePasswordRequest) (*Org, error)
	// Lists master accounts that belongs to the caller's organization.
	ListMasterAccounts(context.Context, *ListMasterAccountsRequest) (*ListMasterAccountsResponse, error)
	// Deletes the organization.
	DeleteOrg(context.Context, *DeleteOrgRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

OrgApiServer is the server API for OrgApi service. All implementations must embed UnimplementedOrgApiServer for forward compatibility

type SendVerificationRequest added in v0.6.13 

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

Request message for OrgApi.SendVerification rpc.

func (*SendVerificationRequest) Descriptor deprecated added in v0.6.13 

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

Deprecated: Use SendVerificationRequest.ProtoReflect.Descriptor instead.

func (*SendVerificationRequest) ProtoMessage added in v0.6.13 

func (*SendVerificationRequest) ProtoMessage()

func (*SendVerificationRequest) ProtoReflect added in v0.6.13 

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

func (*SendVerificationRequest) Reset added in v0.6.13 

func (x *SendVerificationRequest) Reset()

func (*SendVerificationRequest) String added in v0.6.13 

func (x *SendVerificationRequest) String() string

type UnimplementedOrgApiServer added in v0.6.11 

type UnimplementedOrgApiServer struct {
}

UnimplementedOrgApiServer must be embedded to have forward compatible implementations.

func (UnimplementedOrgApiServer) CreateOrg added in v0.6.13 

func (UnimplementedOrgApiServer) CreateOrg(context.Context, *CreateOrgRequest) (*Org, error)

func (UnimplementedOrgApiServer) DeleteOrg added in v0.6.16 

func (UnimplementedOrgApiServer) DeleteOrg(context.Context, *DeleteOrgRequest) (*emptypb.Empty, error)

func (UnimplementedOrgApiServer) GetOrg added in v0.6.11 

func (UnimplementedOrgApiServer) GetOrg(context.Context, *GetOrgRequest) (*Org, error)

func (UnimplementedOrgApiServer) ListMasterAccounts added in v0.6.14 

func (UnimplementedOrgApiServer) ListMasterAccounts(context.Context, *ListMasterAccountsRequest) (*ListMasterAccountsResponse, error)

func (UnimplementedOrgApiServer) SendVerification added in v0.6.13 

func (UnimplementedOrgApiServer) SendVerification(context.Context, *SendVerificationRequest) (*Org, error)

func (UnimplementedOrgApiServer) UpdateAttribute added in v0.6.15 

func (UnimplementedOrgApiServer) UpdateAttribute(context.Context, *UpdateAttributeRequest) (*Org, error)

func (UnimplementedOrgApiServer) UpdatePassword added in v0.6.15 

func (UnimplementedOrgApiServer) UpdatePassword(context.Context, *UpdatePasswordRequest) (*Org, error)

func (UnimplementedOrgApiServer) VerifyOrg added in v0.6.13 

func (UnimplementedOrgApiServer) VerifyOrg(context.Context, *VerifyOrgRequest) (*Org, error)

type UnsafeOrgApiServer added in v0.6.11 

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

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

type UpdateAttributeRequest added in v0.6.15 

type UpdateAttributeRequest struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Request message for OrgApi.UpdateAttribute rpc.

func (*UpdateAttributeRequest) Descriptor deprecated added in v0.6.15 

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

Deprecated: Use UpdateAttributeRequest.ProtoReflect.Descriptor instead.

func (*UpdateAttributeRequest) GetKey added in v0.6.15 

func (x *UpdateAttributeRequest) GetKey() string

func (*UpdateAttributeRequest) GetValue added in v0.6.15 

func (x *UpdateAttributeRequest) GetValue() string

func (*UpdateAttributeRequest) ProtoMessage added in v0.6.15 

func (*UpdateAttributeRequest) ProtoMessage()

func (*UpdateAttributeRequest) ProtoReflect added in v0.6.15 

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

func (*UpdateAttributeRequest) Reset added in v0.6.15 

func (x *UpdateAttributeRequest) Reset()

func (*UpdateAttributeRequest) String added in v0.6.15 

func (x *UpdateAttributeRequest) String() string

type UpdatePasswordRequest added in v0.6.15 

type UpdatePasswordRequest struct {
	OldPassword string `protobuf:"bytes,1,opt,name=old_password,json=oldPassword,proto3" json:"old_password,omitempty"`
	NewPassword string `protobuf:"bytes,2,opt,name=new_password,json=newPassword,proto3" json:"new_password,omitempty"`
	// contains filtered or unexported fields
}

Request message for OrgApi.UpdatePassword rpc.

func (*UpdatePasswordRequest) Descriptor deprecated added in v0.6.15 

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

Deprecated: Use UpdatePasswordRequest.ProtoReflect.Descriptor instead.

func (*UpdatePasswordRequest) GetNewPassword added in v0.6.15 

func (x *UpdatePasswordRequest) GetNewPassword() string

func (*UpdatePasswordRequest) GetOldPassword added in v0.6.15 

func (x *UpdatePasswordRequest) GetOldPassword() string

func (*UpdatePasswordRequest) ProtoMessage added in v0.6.15 

func (*UpdatePasswordRequest) ProtoMessage()

func (*UpdatePasswordRequest) ProtoReflect added in v0.6.15 

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

func (*UpdatePasswordRequest) Reset added in v0.6.15 

func (x *UpdatePasswordRequest) Reset()

func (*UpdatePasswordRequest) String added in v0.6.15 

func (x *UpdatePasswordRequest) String() string

type VerifyOrgRequest added in v0.6.13 

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

Request message for OrgApi.VerifyOrg rpc.

func (*VerifyOrgRequest) Descriptor deprecated added in v0.6.13 

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

Deprecated: Use VerifyOrgRequest.ProtoReflect.Descriptor instead.

func (*VerifyOrgRequest) GetKey added in v0.6.13 

func (x *VerifyOrgRequest) GetKey() string

func (*VerifyOrgRequest) ProtoMessage added in v0.6.13 

func (*VerifyOrgRequest) ProtoMessage()

func (*VerifyOrgRequest) ProtoReflect added in v0.6.13 

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

func (*VerifyOrgRequest) Reset added in v0.6.13 

func (x *VerifyOrgRequest) Reset()

func (*VerifyOrgRequest) String added in v0.6.13 

func (x *VerifyOrgRequest) String() string

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.