gen

package
v1.0.2 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2022 License: MIT Imports: 17 Imported by: 0

Documentation

Overview

Package gen is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var File_proto_imp_api_contacts_contacts_proto protoreflect.FileDescriptor

Functions

func RegisterContactsHandler

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

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

func RegisterContactsHandlerClient

func RegisterContactsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ContactsClient) error

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

func RegisterContactsHandlerFromEndpoint

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

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

func RegisterContactsHandlerServer

func RegisterContactsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ContactsServer) error

RegisterContactsHandlerServer registers the http handlers for service Contacts to "mux". UnaryRPC :call ContactsServer 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 RegisterContactsHandlerFromEndpoint instead.

func RegisterContactsServer

func RegisterContactsServer(s *grpc.Server, srv ContactsServer)

Types

type Contact

type Contact struct {
	Id           int64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`                     // The ID of the contact
	Did          string `protobuf:"bytes,2,opt,name=did,proto3" json:"did,omitempty"`                    // The DID of the contact
	DidDocument  string `protobuf:"bytes,3,opt,name=didDocument,proto3" json:"didDocument,omitempty"`    // The DID document json of the contact
	Name         string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`                  // The name of the contact
	UserDID      string `protobuf:"bytes,5,opt,name=userDID,proto3" json:"userDID,omitempty"`            // The user DID that this contact has been saved to
	HasContacted bool   `protobuf:"varint,6,opt,name=hasContacted,proto3" json:"hasContacted,omitempty"` // Whether or not this contact has been contacted before
	Metadata     string `protobuf:"bytes,7,opt,name=metadata,proto3" json:"metadata,omitempty"`          // The application specific metadata json for this contact
	// contains filtered or unexported fields
}

func (*Contact) Descriptor deprecated

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

Deprecated: Use Contact.ProtoReflect.Descriptor instead.

func (*Contact) GetDid

func (x *Contact) GetDid() string

func (*Contact) GetDidDocument

func (x *Contact) GetDidDocument() string

func (*Contact) GetHasContacted

func (x *Contact) GetHasContacted() bool

func (*Contact) GetId

func (x *Contact) GetId() int64

func (*Contact) GetMetadata

func (x *Contact) GetMetadata() string

func (*Contact) GetName

func (x *Contact) GetName() string

func (*Contact) GetUserDID

func (x *Contact) GetUserDID() string

func (*Contact) ProtoMessage

func (*Contact) ProtoMessage()

func (*Contact) ProtoReflect

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

func (*Contact) Reset

func (x *Contact) Reset()

func (*Contact) String

func (x *Contact) String() string

type ContactUpdate

type ContactUpdate struct {
	Id       int64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`            // The ID of the contact
	Did      string `protobuf:"bytes,2,opt,name=did,proto3" json:"did,omitempty"`           // The DID of the contact
	Name     string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`         // The name of the contact
	Metadata string `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"` // The application specific metadata json for this contact
	// contains filtered or unexported fields
}

func (*ContactUpdate) Descriptor deprecated

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

Deprecated: Use ContactUpdate.ProtoReflect.Descriptor instead.

func (*ContactUpdate) GetDid

func (x *ContactUpdate) GetDid() string

func (*ContactUpdate) GetId

func (x *ContactUpdate) GetId() int64

func (*ContactUpdate) GetMetadata

func (x *ContactUpdate) GetMetadata() string

func (*ContactUpdate) GetName

func (x *ContactUpdate) GetName() string

func (*ContactUpdate) ProtoMessage

func (*ContactUpdate) ProtoMessage()

func (*ContactUpdate) ProtoReflect

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

func (*ContactUpdate) Reset

func (x *ContactUpdate) Reset()

func (*ContactUpdate) String

func (x *ContactUpdate) String() string

type ContactsClient

type ContactsClient interface {
	//*
	// GetContactsList gets all of the contacts the user has saved.
	GetContactsList(ctx context.Context, in *GetContactsListRequest, opts ...grpc.CallOption) (*GetContactsListResponse, error)
	//*
	// GetContact gets a specific contact the user has saved.
	GetContact(ctx context.Context, in *GetContactRequest, opts ...grpc.CallOption) (*GetContactResponse, error)
	//*
	// CreateContact will create a specific contact. If the contact DID has not been added to the ID database,
	// it will be added first.
	CreateContact(ctx context.Context, in *CreateContactRequest, opts ...grpc.CallOption) (*CreateContactResponse, error)
	//*
	// CreateContacts will create multiple contacts passed in. A batch version of CreateContact.
	CreateContacts(ctx context.Context, in *CreateContactsRequest, opts ...grpc.CallOption) (*CreateContactsResponse, error)
	//*
	// UpdateContact will update a specific contact.
	UpdateContact(ctx context.Context, in *UpdateContactRequest, opts ...grpc.CallOption) (*UpdateContactResponse, error)
	//*
	// DeleteContact will delete a specific contact.
	DeleteContact(ctx context.Context, in *DeleteContactRequest, opts ...grpc.CallOption) (*DeleteContactResponse, error)
}

ContactsClient is the client API for Contacts service.

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

func NewContactsClient

func NewContactsClient(cc grpc.ClientConnInterface) ContactsClient

type ContactsServer

type ContactsServer interface {
	//*
	// GetContactsList gets all of the contacts the user has saved.
	GetContactsList(context.Context, *GetContactsListRequest) (*GetContactsListResponse, error)
	//*
	// GetContact gets a specific contact the user has saved.
	GetContact(context.Context, *GetContactRequest) (*GetContactResponse, error)
	//*
	// CreateContact will create a specific contact. If the contact DID has not been added to the ID database,
	// it will be added first.
	CreateContact(context.Context, *CreateContactRequest) (*CreateContactResponse, error)
	//*
	// CreateContacts will create multiple contacts passed in. A batch version of CreateContact.
	CreateContacts(context.Context, *CreateContactsRequest) (*CreateContactsResponse, error)
	//*
	// UpdateContact will update a specific contact.
	UpdateContact(context.Context, *UpdateContactRequest) (*UpdateContactResponse, error)
	//*
	// DeleteContact will delete a specific contact.
	DeleteContact(context.Context, *DeleteContactRequest) (*DeleteContactResponse, error)
}

ContactsServer is the server API for Contacts service.

type CreateContactRequest

type CreateContactRequest struct {
	Contact *Contact `protobuf:"bytes,1,opt,name=contact,proto3" json:"contact,omitempty"` // The contact to created
	// contains filtered or unexported fields
}

* Represents a request to create a contact.

func (*CreateContactRequest) Descriptor deprecated

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

Deprecated: Use CreateContactRequest.ProtoReflect.Descriptor instead.

func (*CreateContactRequest) GetContact

func (x *CreateContactRequest) GetContact() *Contact

func (*CreateContactRequest) ProtoMessage

func (*CreateContactRequest) ProtoMessage()

func (*CreateContactRequest) ProtoReflect

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

func (*CreateContactRequest) Reset

func (x *CreateContactRequest) Reset()

func (*CreateContactRequest) String

func (x *CreateContactRequest) String() string

type CreateContactResponse

type CreateContactResponse struct {
	Contact *Contact `protobuf:"bytes,1,opt,name=contact,proto3" json:"contact,omitempty"` // The contact created
	// contains filtered or unexported fields
}

* Represents a response containing the contact created.

func (*CreateContactResponse) Descriptor deprecated

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

Deprecated: Use CreateContactResponse.ProtoReflect.Descriptor instead.

func (*CreateContactResponse) GetContact

func (x *CreateContactResponse) GetContact() *Contact

func (*CreateContactResponse) ProtoMessage

func (*CreateContactResponse) ProtoMessage()

func (*CreateContactResponse) ProtoReflect

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

func (*CreateContactResponse) Reset

func (x *CreateContactResponse) Reset()

func (*CreateContactResponse) String

func (x *CreateContactResponse) String() string

type CreateContactsRequest

type CreateContactsRequest struct {
	Contacts []*Contact `protobuf:"bytes,1,rep,name=contacts,proto3" json:"contacts,omitempty"` // The contacts to created
	// contains filtered or unexported fields
}

* Represents a request to create multiple contacts.

func (*CreateContactsRequest) Descriptor deprecated

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

Deprecated: Use CreateContactsRequest.ProtoReflect.Descriptor instead.

func (*CreateContactsRequest) GetContacts

func (x *CreateContactsRequest) GetContacts() []*Contact

func (*CreateContactsRequest) ProtoMessage

func (*CreateContactsRequest) ProtoMessage()

func (*CreateContactsRequest) ProtoReflect

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

func (*CreateContactsRequest) Reset

func (x *CreateContactsRequest) Reset()

func (*CreateContactsRequest) String

func (x *CreateContactsRequest) String() string

type CreateContactsResponse

type CreateContactsResponse struct {
	Contacts []*Contact `protobuf:"bytes,1,rep,name=contacts,proto3" json:"contacts,omitempty"` // The contacts created
	// contains filtered or unexported fields
}

* Represents a response containing the contacts created.

func (*CreateContactsResponse) Descriptor deprecated

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

Deprecated: Use CreateContactsResponse.ProtoReflect.Descriptor instead.

func (*CreateContactsResponse) GetContacts

func (x *CreateContactsResponse) GetContacts() []*Contact

func (*CreateContactsResponse) ProtoMessage

func (*CreateContactsResponse) ProtoMessage()

func (*CreateContactsResponse) ProtoReflect

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

func (*CreateContactsResponse) Reset

func (x *CreateContactsResponse) Reset()

func (*CreateContactsResponse) String

func (x *CreateContactsResponse) String() string

type DeleteContactRequest

type DeleteContactRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"` // The ID of the contact to delete
	// contains filtered or unexported fields
}

* Represents a request to delete a contact.

func (*DeleteContactRequest) Descriptor deprecated

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

Deprecated: Use DeleteContactRequest.ProtoReflect.Descriptor instead.

func (*DeleteContactRequest) GetId

func (x *DeleteContactRequest) GetId() int64

func (*DeleteContactRequest) ProtoMessage

func (*DeleteContactRequest) ProtoMessage()

func (*DeleteContactRequest) ProtoReflect

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

func (*DeleteContactRequest) Reset

func (x *DeleteContactRequest) Reset()

func (*DeleteContactRequest) String

func (x *DeleteContactRequest) String() string

type DeleteContactResponse

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

* Represents a response containing the contact deletion event.

func (*DeleteContactResponse) Descriptor deprecated

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

Deprecated: Use DeleteContactResponse.ProtoReflect.Descriptor instead.

func (*DeleteContactResponse) ProtoMessage

func (*DeleteContactResponse) ProtoMessage()

func (*DeleteContactResponse) ProtoReflect

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

func (*DeleteContactResponse) Reset

func (x *DeleteContactResponse) Reset()

func (*DeleteContactResponse) String

func (x *DeleteContactResponse) String() string

type GetContactRequest

type GetContactRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"` // The ID of the contact to retrieve
	// contains filtered or unexported fields
}

* Represents a request to get a contact.

func (*GetContactRequest) Descriptor deprecated

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

Deprecated: Use GetContactRequest.ProtoReflect.Descriptor instead.

func (*GetContactRequest) GetId

func (x *GetContactRequest) GetId() int64

func (*GetContactRequest) ProtoMessage

func (*GetContactRequest) ProtoMessage()

func (*GetContactRequest) ProtoReflect

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

func (*GetContactRequest) Reset

func (x *GetContactRequest) Reset()

func (*GetContactRequest) String

func (x *GetContactRequest) String() string

type GetContactResponse

type GetContactResponse struct {
	Contact *Contact `protobuf:"bytes,1,opt,name=contact,proto3" json:"contact,omitempty"` // The contact retrieved
	// contains filtered or unexported fields
}

* Represents a response containing the contact.

func (*GetContactResponse) Descriptor deprecated

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

Deprecated: Use GetContactResponse.ProtoReflect.Descriptor instead.

func (*GetContactResponse) GetContact

func (x *GetContactResponse) GetContact() *Contact

func (*GetContactResponse) ProtoMessage

func (*GetContactResponse) ProtoMessage()

func (*GetContactResponse) ProtoReflect

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

func (*GetContactResponse) Reset

func (x *GetContactResponse) Reset()

func (*GetContactResponse) String

func (x *GetContactResponse) String() string

type GetContactsListRequest

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

* Represents a request to get a contact list.

func (*GetContactsListRequest) Descriptor deprecated

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

Deprecated: Use GetContactsListRequest.ProtoReflect.Descriptor instead.

func (*GetContactsListRequest) ProtoMessage

func (*GetContactsListRequest) ProtoMessage()

func (*GetContactsListRequest) ProtoReflect

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

func (*GetContactsListRequest) Reset

func (x *GetContactsListRequest) Reset()

func (*GetContactsListRequest) String

func (x *GetContactsListRequest) String() string

type GetContactsListResponse

type GetContactsListResponse struct {
	Contacts []*Contact `protobuf:"bytes,1,rep,name=contacts,proto3" json:"contacts,omitempty"` // The contact list
	// contains filtered or unexported fields
}

* Represents a response containing the contact list.

func (*GetContactsListResponse) Descriptor deprecated

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

Deprecated: Use GetContactsListResponse.ProtoReflect.Descriptor instead.

func (*GetContactsListResponse) GetContacts

func (x *GetContactsListResponse) GetContacts() []*Contact

func (*GetContactsListResponse) ProtoMessage

func (*GetContactsListResponse) ProtoMessage()

func (*GetContactsListResponse) ProtoReflect

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

func (*GetContactsListResponse) Reset

func (x *GetContactsListResponse) Reset()

func (*GetContactsListResponse) String

func (x *GetContactsListResponse) String() string

type UnimplementedContactsServer

type UnimplementedContactsServer struct {
}

UnimplementedContactsServer can be embedded to have forward compatible implementations.

func (*UnimplementedContactsServer) CreateContact

func (*UnimplementedContactsServer) CreateContacts

func (*UnimplementedContactsServer) DeleteContact

func (*UnimplementedContactsServer) GetContact

func (*UnimplementedContactsServer) GetContactsList

func (*UnimplementedContactsServer) UpdateContact

type UpdateContactRequest

type UpdateContactRequest struct {
	Contact *ContactUpdate `protobuf:"bytes,1,opt,name=contact,proto3" json:"contact,omitempty"` // The contact to update
	// contains filtered or unexported fields
}

* Represents a request to update a contact.

func (*UpdateContactRequest) Descriptor deprecated

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

Deprecated: Use UpdateContactRequest.ProtoReflect.Descriptor instead.

func (*UpdateContactRequest) GetContact

func (x *UpdateContactRequest) GetContact() *ContactUpdate

func (*UpdateContactRequest) ProtoMessage

func (*UpdateContactRequest) ProtoMessage()

func (*UpdateContactRequest) ProtoReflect

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

func (*UpdateContactRequest) Reset

func (x *UpdateContactRequest) Reset()

func (*UpdateContactRequest) String

func (x *UpdateContactRequest) String() string

type UpdateContactResponse

type UpdateContactResponse struct {
	Contact *Contact `protobuf:"bytes,1,opt,name=contact,proto3" json:"contact,omitempty"` // The contact update
	// contains filtered or unexported fields
}

* Represents a response containing the contact updated.

func (*UpdateContactResponse) Descriptor deprecated

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

Deprecated: Use UpdateContactResponse.ProtoReflect.Descriptor instead.

func (*UpdateContactResponse) GetContact

func (x *UpdateContactResponse) GetContact() *Contact

func (*UpdateContactResponse) ProtoMessage

func (*UpdateContactResponse) ProtoMessage()

func (*UpdateContactResponse) ProtoReflect

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

func (*UpdateContactResponse) Reset

func (x *UpdateContactResponse) Reset()

func (*UpdateContactResponse) String

func (x *UpdateContactResponse) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL