helloworld

Protocol Documentation

Table of Contents

• v1alpha1/hello_world.proto

  • SayHelloRequest

  • SayHelloResponse

  • GreeterService

• v1/cloudevents.proto
  • CloudEvent
  • CloudEvent.AttributesEntry
  • CloudEvent.CloudEventAttributeValue
  • CloudEventBatch
• v1alpha2/messages.proto
  • SayHelloRequest
  • SayHelloResponse
• v1alpha2/services.proto
  • GreeterService
• Scalar Value Types

Top

v1alpha1/hello_world.proto

SayHelloRequest

The request message containing the user’s name

Field	Type	Label	Description
name	string		The name of the person to greet

SayHelloResponse

The response message containing the greetings

Field	Type	Label	Description
message	string		The message to greet the person with

GreeterService

Here is the overall greeting service definition where we define all our endpoints

Method Name	Request Type	Response Type	Description
SayHello	SayHelloRequest	SayHelloResponse	Sends a greeting

Top

v1/cloudevents.proto

CloudEvent Protobuf Format

• Required context attributes are explicitly represented.
• Optional and Extension context attributes are carried in a map structure.
• Data may be represented as binary, text, or protobuf messages.

CloudEvent

CloudEvent Protobuf Format

-- CloudEvent Context Attributes

Field	Type	Label	Description
id	string		Required Attributes
source	string		URI-reference
spec_version	string
type	string
attributes	CloudEvent.AttributesEntry	repeated	Optional & Extension Attributes
binary_data	bytes
text_data	string
proto_data	google.protobuf.Any

CloudEvent.AttributesEntry

Field	Type	Label	Description
key	string
value	CloudEvent.CloudEventAttributeValue

CloudEvent.CloudEventAttributeValue

The CloudEvent specification defines seven attribute value types…

Field	Type	Label	Description
ce_boolean	bool
ce_integer	int32
ce_string	string
ce_bytes	bytes
ce_uri	string
ce_uri_ref	string
ce_timestamp	google.protobuf.Timestamp

CloudEventBatch

CloudEvent Protobuf Batch Format

Field	Type	Label	Description
events	CloudEvent	repeated

Top

v1alpha2/messages.proto

SayHelloRequest

The request message containing the user’s name

Field	Type	Label	Description
name	string		The name of the person to greet

SayHelloResponse

The response message containing the greetings

Field	Type	Label	Description
message	api.v1.CloudEvent		The message to greet the person with

Top

v1alpha2/services.proto

GreeterService

Here is the overall greeting service definition where we define all our endpoints

Method Name	Request Type	Response Type	Description
SayHello	SayHelloRequest	SayHelloResponse	Sends a greeting

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)

This site is open source. Improve this page.