package example

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Read (ReadAccountRequest, ReadBlogPostsResponse)

  demo_multi_file_service.proto:22

  message ReadAccountRequest

  demo_multi_file_service.proto:10

  • uint64 id = 1

    For a read request, the id field is the only to be specified

  • optional infoblox.api.FieldSelection fields = 2

    fields

  message ReadBlogPostsResponse

  demo_multi_file_service.proto:17

  • repeated BlogPost posts = 1

• rpc List (ListCircleRequest, ListCircleResponse)

  demo_service.proto:187

  message ListCircleRequest

  demo_service.proto:178

  (message has no fields)

  message ListCircleResponse

  demo_service.proto:181

  • repeated Circle results = 1

• rpc Create (CreateIntPointRequest, CreateIntPointResponse)

  demo_service.proto:112

  The convention requires the rpc names have Create/Read/Update/List/Delete as a prefix. The type is inferred from the response (except for delete), so multiple objects can have CURDL handlers in the same service, provided they are given unique suffixes

• rpc Read (ReadIntPointRequest, ReadIntPointResponse)

  demo_service.proto:113

• rpc Update (UpdateIntPointRequest, UpdateIntPointResponse)

  demo_service.proto:114

• rpc UpdateSet (UpdateSetIntPointRequest, UpdateSetIntPointResponse)

  demo_service.proto:115

  message UpdateSetIntPointRequest

  demo_service.proto:55

  • repeated IntPoint objects = 1

  • repeated google.protobuf.FieldMask masks = 2

  message UpdateSetIntPointResponse

  demo_service.proto:60

  • repeated IntPoint results = 1

• rpc List (ListIntPointRequest, ListIntPointResponse)

  demo_service.proto:116

• rpc ListSomething (google.protobuf.Empty, ListSomethingResponse)

  demo_service.proto:117

  message ListSomethingResponse

  demo_service.proto:85

  • repeated Something results = 1

    Note repeated field and plural name 'results'

  • optional infoblox.api.PageInfo page_info = 2

• rpc Delete (DeleteIntPointRequest, DeleteIntPointResponse)

  demo_service.proto:118

• rpc CustomMethod (google.protobuf.Empty, google.protobuf.Empty)

  demo_service.proto:125

  CustomMethod can't be autogenerated as it matches no conventions, it will become a stub

• rpc CreateSomething (Something, Something)

  demo_service.proto:127

  CreateSomething also doesn't match conventions and will become a stub

• rpc List (ListFooRequest, ListIntPointResponse)

  demo_service.proto:140

  message ListFooRequest

  demo_service.proto:134

  (message has no fields)

• rpc Create (CreateFooRequest, ListIntPointResponse)

  demo_service.proto:141

  message CreateFooRequest

  demo_service.proto:131

  Test cases that were previously broken

  • bytes payload = 1

• rpc Create (CreateIntPointRequest, CreateIntPointResponse)

  demo_service.proto:152

  The convention requires the rpc names have Create/Read/Update/List/Delete as a prefix. The type is inferred from the response (except for delete), so multiple objects can have CURDL handlers in the same service, provided they are given unique suffixes

• rpc Read (ReadIntPointRequest, ReadIntPointResponse)

  demo_service.proto:153

• rpc Update (UpdateIntPointRequest, UpdateIntPointResponse)

  demo_service.proto:154

• rpc List (ListIntPointRequest, ListIntPointResponse)

  demo_service.proto:155

• rpc Delete (DeleteIntPointRequest, DeleteIntPointResponse)

  demo_service.proto:156

• rpc DeleteSet (DeleteIntPointsRequest, DeleteIntPointResponse)

  demo_service.proto:161

• rpc CustomMethod (google.protobuf.Empty, google.protobuf.Empty)

  demo_service.proto:168

  CustomMethod can't be autogenerated as it matches no conventions, it will become a stub

• rpc CreateSomething (Something, Something)

  demo_service.proto:170

  CreateSomething also doesn't match conventions and will become a stub

• rpc CreateA (CreateIntPointRequest, CreateIntPointResponse)

  demo_service.proto:192

• rpc CreateB (CreateIntPointRequest, CreateIntPointResponse)

  demo_service.proto:193

• rpc ReadA (ReadIntPointRequest, ReadIntPointResponse)

  demo_service.proto:194

• rpc ReadB (ReadIntPointRequest, ReadIntPointResponse)

  demo_service.proto:195

• rpc UpdateA (UpdateIntPointRequest, UpdateIntPointResponse)

  demo_service.proto:196

• rpc UpdateB (UpdateIntPointRequest, UpdateIntPointResponse)

  demo_service.proto:197

• rpc ListA (ListIntPointRequest, ListIntPointResponse)

  demo_service.proto:198

• rpc ListB (ListIntPointRequest, ListIntPointResponse)

  demo_service.proto:199

• rpc DeleteA (DeleteIntPointRequest, DeleteIntPointResponse)

  demo_service.proto:200

• rpc DeleteB (DeleteIntPointRequest, DeleteIntPointResponse)

  demo_service.proto:205

• rpc DeleteSetA (DeleteIntPointsRequest, DeleteIntPointResponse)

  demo_service.proto:210

• rpc DeleteSetB (DeleteIntPointsRequest, DeleteIntPointResponse)

  demo_service.proto:215

Used in: TypeWithID

• string contents = 1

  here the ormable flag is not used, so nothing will be generated for this object at the ORM level, and when this type is used as a field or repeated field in another message that field will be dropped in the Orm model, and would have to be set by hook

Used in: ReadBlogPostsResponse

• uint64 id = 1

• string title = 2

• string author = 3

Used in: ListCircleResponse

• uint32 r = 1

Used as request type in: IntPointService.Create, IntPointTxn.Create, MultipleMethodsAutoGen.CreateA, MultipleMethodsAutoGen.CreateB

• optional IntPoint payload = 1

  Convention dictates that this field be of the given type, and be named 'payload' in order to autogenerate the handler

Used as response type in: IntPointService.Create, IntPointTxn.Create, MultipleMethodsAutoGen.CreateA, MultipleMethodsAutoGen.CreateB

• optional IntPoint result = 1

  Convention also requires that the return type be the same and named 'result'

Used as request type in: IntPointService.Delete, IntPointTxn.Delete, MultipleMethodsAutoGen.DeleteA, MultipleMethodsAutoGen.DeleteB

• uint32 id = 1

  Only the id is needed for a delete request

By convention, on DELETE no response data is given, so either a google.protobuf.empty, or an empty struct is sufficient

Used as response type in: IntPointService.Delete, IntPointTxn.Delete, IntPointTxn.DeleteSet, MultipleMethodsAutoGen.DeleteA, MultipleMethodsAutoGen.DeleteB, MultipleMethodsAutoGen.DeleteSetA, MultipleMethodsAutoGen.DeleteSetB

(message has no fields)

Used as request type in: IntPointTxn.DeleteSet, MultipleMethodsAutoGen.DeleteSetA, MultipleMethodsAutoGen.DeleteSetB

• repeated uint32 ids = 1

  Only the id is needed for a delete request

Used in: PrimaryIncluded, PrimaryStringType, PrimaryUUIDType

• string id = 1

IntPoint is a basic message type representing a single cartesian point that we want to store in a database

Used in: CreateIntPointRequest, CreateIntPointResponse, ListIntPointResponse, ReadIntPointResponse, TypeWithID, UpdateIntPointRequest, UpdateIntPointResponse, UpdateSetIntPointRequest, UpdateSetIntPointResponse

• uint32 id = 1

• int32 x = 2

• int32 y = 3

Used as request type in: IntPointService.List, IntPointTxn.List, MultipleMethodsAutoGen.ListA, MultipleMethodsAutoGen.ListB

• optional infoblox.api.Filtering filter = 1

• optional infoblox.api.Sorting order_by = 2

• optional infoblox.api.FieldSelection fields = 3

• optional infoblox.api.Pagination paging = 4

Used as response type in: IntPointService.List, IntPointServiceB.Create, IntPointServiceB.List, IntPointTxn.List, MultipleMethodsAutoGen.ListA, MultipleMethodsAutoGen.ListB

• repeated IntPoint results = 1

  Note repeated field and plural name 'results'

• optional infoblox.api.PageInfo page_info = 2

MultiaccountTypeWithID demonstrates the generated multi-account support

• uint64 id = 1

• string some_field = 2

• string some_field = 1

• optional ExternalChild child = 1

• string id = 1

• optional ExternalChild child = 2

• optional gorm.types.UUIDValue id = 1

• optional ExternalChild child = 2

Used as request type in: IntPointService.Read, IntPointTxn.Read, MultipleMethodsAutoGen.ReadA, MultipleMethodsAutoGen.ReadB

• uint32 id = 1

  For a read request, the id field is the only to be specified

• optional infoblox.api.FieldSelection fields = 2

Used as response type in: IntPointService.Read, IntPointTxn.Read, MultipleMethodsAutoGen.ReadA, MultipleMethodsAutoGen.ReadB

• optional IntPoint result = 1

  Again the type with 'result' name

A dummy type to demo an rpc that can't be autogenerated

Used as request type in: IntPointService.CreateSomething, IntPointTxn.CreateSomething

Used as response type in: IntPointService.CreateSomething, IntPointTxn.CreateSomething

Used as field type in: ListSomethingResponse

• string field = 1

• string id = 1

• repeated TestTagAssociation testTagAssoc = 2

• string id = 1

• repeated TestTagAssociation testTagAssoc = 2

replace by default

• string id = 1

• repeated TestTagAssociation testTagAssoc = 2

• string id = 1

• repeated TestTagAssociation testTagAssoc = 2

• string id = 1

• optional TestTagAssociation testTagAssoc = 2

Used in: TestAssocHandlerAppend, TestAssocHandlerClear, TestAssocHandlerDefault, TestAssocHandlerReplace, TestTag

• string some_field = 1

test_types is a message that includes a representative sample of the available types

Used in: TypeWithID

• string api_only_string = 1

  the (gorm.field).drop option allows for setting a field to be API only

• repeated int32 numbers = 2

  repeated raw types are currently unsupported, so this field will be dropped at the ORM level

• optional google.protobuf.StringValue optional_string = 3

  a StringValue represents a Nullable string

• TestTypes.status becomes_int = 4

• optional google.protobuf.Empty nothingness = 5

  The Empty type serves no purpose outside of rpc calls and is dropped automatically from objects

• optional gorm.types.UUID uuid = 6

  The UUID custom type should act like a StringValue at the API level, but is automatically converted to and from a uuid.UUID (github.com/satori/go.uuid)

• optional google.protobuf.Timestamp created_at = 7

  Timestamps convert to golang's time.Time type, and created_at and updated_at values are automatically filled by GORM

• optional google.protobuf.Duration duration = 8

  Duration convert to golang's time.Duration type.

• uint32 type_with_id_id = 9

  This represents a foreign key to the 'type_with_id' type for associations This could be hidden from the API (or soon autogenerated).

• optional gorm.types.JSONValue json_field = 10

  This is an arbitrary JSON string that is marshalled and unmarshalled specially in grpc-gateway as a JSON object

• optional gorm.types.UUIDValue nullable_uuid = 11

  The UUIDValue custom type should act like a StringValue at the API level, but is automatically converted to and from a *uuid.UUID (github.com/satori/go.uuid)

• optional gorm.types.TimeOnly time_only = 12

  The TimeOnly should act as uint32 value at business layer, but is automatically converted to/from string at API and ORM level

• optional gorm.types.BigInt bigint = 13

• repeated gorm.types.JSONValue several_values = 14

  Repeated non-ormable objects are currently treated as single entity for purposes of an object's field masking

enums are mapped to the their underlying numeric value in the db. This is practical from an API perspective, but tougher for debugging. Strings with validation constraints can be used instead if desired

Used in: TestTypes

• UNKNOWN = 0

• GOOD = 1

• BAD = 2

TypeWithID demonstrates some basic association behavior

• uint32 id = 1

  any field named 'id' is assumed by gorm to be the primary key for the object.

• string ip = 2

  The field option also allows arbitrary tag setting, such as informing gorm of a primary key, different column names or different types in the db

• repeated TestTypes things = 3

  A default has-many relationship, will error on generation if no FK field, convention {typename}_id, is present. These FK fields will be automatically populated on create and update.

• optional TestTypes a_nested_object = 4

  A default has-one relationship, will error as above

• optional IntPoint point = 5

  An in-package and cross-package imported type (in-package can use any association type, cross-package is limited to belongs_to and many_to_many)

• optional user.User user = 6

• optional gorm.types.InetValue address = 7

• repeated uint32 multiaccount_type_ids = 8

• optional APIOnlyType synthetic_field = 9

• float tag_test = 10

• string tag_size_test = 11

• optional google.protobuf.FloatValue float_field = 12

• optional google.protobuf.DoubleValue double_field = 13

• optional gorm.types.TimeOnly time_only = 14

  Limited support for DB type 'time', implemented via strings (string -> DB && DB -> string)

• optional google.protobuf.Timestamp deleted_at = 15

• bytes metadata = 16

Used as request type in: IntPointService.Update, IntPointTxn.Update, MultipleMethodsAutoGen.UpdateA, MultipleMethodsAutoGen.UpdateB

• optional IntPoint payload = 1

• optional google.protobuf.FieldMask gerogeri_gegege = 2

Used as response type in: IntPointService.Update, IntPointTxn.Update, MultipleMethodsAutoGen.UpdateA, MultipleMethodsAutoGen.UpdateB

• optional IntPoint result = 1