publishingpb

package
v1.16.1 Latest Latest
Warning

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

 Go to latest Published: Sep 18, 2025 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	Publisher_PublishChannelConnectionEvents_FullMethodName = "/google.cloud.eventarc.publishing.v1.Publisher/PublishChannelConnectionEvents"
	Publisher_PublishEvents_FullMethodName                  = "/google.cloud.eventarc.publishing.v1.Publisher/PublishEvents"
	Publisher_Publish_FullMethodName                        = "/google.cloud.eventarc.publishing.v1.Publisher/Publish"
)

Variables

View Source 
var File_google_cloud_eventarc_publishing_v1_cloud_event_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_eventarc_publishing_v1_publisher_proto protoreflect.FileDescriptor
View Source 
var Publisher_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.eventarc.publishing.v1.Publisher",
	HandlerType: (*PublisherServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "PublishChannelConnectionEvents",
			Handler:    _Publisher_PublishChannelConnectionEvents_Handler,
		},
		{
			MethodName: "PublishEvents",
			Handler:    _Publisher_PublishEvents_Handler,
		},
		{
			MethodName: "Publish",
			Handler:    _Publisher_Publish_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/eventarc/publishing/v1/publisher.proto",
}

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

Functions

func RegisterPublisherServer 

func RegisterPublisherServer(s grpc.ServiceRegistrar, srv PublisherServer)

Types

type CloudEvent added in v1.15.0 

type CloudEvent struct {

	// Required. Identifies the event. Producers MUST ensure that source + id is
	// unique for each distinct event.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. Identifies the context in which an event happened.
	// URI-reference
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// Required. The version of the CloudEvents specification which the event
	// uses.
	SpecVersion string `protobuf:"bytes,3,opt,name=spec_version,json=specVersion,proto3" json:"spec_version,omitempty"`
	// Required. This attribute contains a value describing the type of event
	// related to the originating occurrence.
	Type string `protobuf:"bytes,4,opt,name=type,proto3" json:"type,omitempty"`
	// Optional. Used for Optional & Extension Attributes
	Attributes map[string]*CloudEvent_CloudEventAttributeValue `` /* 161-byte string literal not displayed */
	// The event payload. It should be encoded into a media format which is
	// specified by the 'datacontenttype' attribute (e.g. application/json), and
	// adheres to the dataschema format when those respective attributes are
	// present.
	//
	// Types that are assignable to Data:
	//
	//	*CloudEvent_BinaryData
	//	*CloudEvent_TextData
	//	*CloudEvent_ProtoData
	Data isCloudEvent_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

CloudEvent represents a vendor-neutral specification for defining the format of event data.

func (*CloudEvent) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use CloudEvent.ProtoReflect.Descriptor instead.

func (*CloudEvent) GetAttributes added in v1.15.0 

func (x *CloudEvent) GetAttributes() map[string]*CloudEvent_CloudEventAttributeValue

func (*CloudEvent) GetBinaryData added in v1.15.0 

func (x *CloudEvent) GetBinaryData() []byte

func (*CloudEvent) GetData added in v1.15.0 

func (m *CloudEvent) GetData() isCloudEvent_Data

func (*CloudEvent) GetId added in v1.15.0 

func (x *CloudEvent) GetId() string

func (*CloudEvent) GetProtoData added in v1.15.0 

func (x *CloudEvent) GetProtoData() *anypb.Any

func (*CloudEvent) GetSource added in v1.15.0 

func (x *CloudEvent) GetSource() string

func (*CloudEvent) GetSpecVersion added in v1.15.0 

func (x *CloudEvent) GetSpecVersion() string

func (*CloudEvent) GetTextData added in v1.15.0 

func (x *CloudEvent) GetTextData() string

func (*CloudEvent) GetType added in v1.15.0 

func (x *CloudEvent) GetType() string

func (*CloudEvent) ProtoMessage added in v1.15.0 

func (*CloudEvent) ProtoMessage()

func (*CloudEvent) ProtoReflect added in v1.15.0 

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

func (*CloudEvent) Reset added in v1.15.0 

func (x *CloudEvent) Reset()

func (*CloudEvent) String added in v1.15.0 

func (x *CloudEvent) String() string

type CloudEvent_BinaryData added in v1.15.0 

type CloudEvent_BinaryData struct {
	// Optional. Binary data.
	BinaryData []byte `protobuf:"bytes,6,opt,name=binary_data,json=binaryData,proto3,oneof"`
}

type CloudEvent_CloudEventAttributeValue added in v1.15.0 

type CloudEvent_CloudEventAttributeValue struct {

	// The value of the attribute.
	//
	// Types that are assignable to Attr:
	//
	//	*CloudEvent_CloudEventAttributeValue_CeBoolean
	//	*CloudEvent_CloudEventAttributeValue_CeInteger
	//	*CloudEvent_CloudEventAttributeValue_CeString
	//	*CloudEvent_CloudEventAttributeValue_CeBytes
	//	*CloudEvent_CloudEventAttributeValue_CeUri
	//	*CloudEvent_CloudEventAttributeValue_CeUriRef
	//	*CloudEvent_CloudEventAttributeValue_CeTimestamp
	Attr isCloudEvent_CloudEventAttributeValue_Attr `protobuf_oneof:"attr"`
	// contains filtered or unexported fields
}

The following abstract data types are available for use in attributes.

func (*CloudEvent_CloudEventAttributeValue) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use CloudEvent_CloudEventAttributeValue.ProtoReflect.Descriptor instead.

func (*CloudEvent_CloudEventAttributeValue) GetAttr added in v1.15.0 

func (m *CloudEvent_CloudEventAttributeValue) GetAttr() isCloudEvent_CloudEventAttributeValue_Attr

func (*CloudEvent_CloudEventAttributeValue) GetCeBoolean added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) GetCeBoolean() bool

func (*CloudEvent_CloudEventAttributeValue) GetCeBytes added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) GetCeBytes() []byte

func (*CloudEvent_CloudEventAttributeValue) GetCeInteger added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) GetCeInteger() int32

func (*CloudEvent_CloudEventAttributeValue) GetCeString added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) GetCeString() string

func (*CloudEvent_CloudEventAttributeValue) GetCeTimestamp added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) GetCeTimestamp() *timestamppb.Timestamp

func (*CloudEvent_CloudEventAttributeValue) GetCeUri added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) GetCeUri() string

func (*CloudEvent_CloudEventAttributeValue) GetCeUriRef added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) GetCeUriRef() string

func (*CloudEvent_CloudEventAttributeValue) ProtoMessage added in v1.15.0 

func (*CloudEvent_CloudEventAttributeValue) ProtoMessage()

func (*CloudEvent_CloudEventAttributeValue) ProtoReflect added in v1.15.0 

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

func (*CloudEvent_CloudEventAttributeValue) Reset added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) Reset()

func (*CloudEvent_CloudEventAttributeValue) String added in v1.15.0 

func (x *CloudEvent_CloudEventAttributeValue) String() string

type CloudEvent_CloudEventAttributeValue_CeBoolean added in v1.15.0 

type CloudEvent_CloudEventAttributeValue_CeBoolean struct {
	// Boolean value.
	CeBoolean bool `protobuf:"varint,1,opt,name=ce_boolean,json=ceBoolean,proto3,oneof"`
}

type CloudEvent_CloudEventAttributeValue_CeBytes added in v1.15.0 

type CloudEvent_CloudEventAttributeValue_CeBytes struct {
	// Bytes value.
	CeBytes []byte `protobuf:"bytes,4,opt,name=ce_bytes,json=ceBytes,proto3,oneof"`
}

type CloudEvent_CloudEventAttributeValue_CeInteger added in v1.15.0 

type CloudEvent_CloudEventAttributeValue_CeInteger struct {
	// Integer value.
	CeInteger int32 `protobuf:"varint,2,opt,name=ce_integer,json=ceInteger,proto3,oneof"`
}

type CloudEvent_CloudEventAttributeValue_CeString added in v1.15.0 

type CloudEvent_CloudEventAttributeValue_CeString struct {
	// String value.
	CeString string `protobuf:"bytes,3,opt,name=ce_string,json=ceString,proto3,oneof"`
}

type CloudEvent_CloudEventAttributeValue_CeTimestamp added in v1.15.0 

type CloudEvent_CloudEventAttributeValue_CeTimestamp struct {
	// Timestamp value.
	CeTimestamp *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=ce_timestamp,json=ceTimestamp,proto3,oneof"`
}

type CloudEvent_CloudEventAttributeValue_CeUri added in v1.15.0 

type CloudEvent_CloudEventAttributeValue_CeUri struct {
	// URI value.
	CeUri string `protobuf:"bytes,5,opt,name=ce_uri,json=ceUri,proto3,oneof"`
}

type CloudEvent_CloudEventAttributeValue_CeUriRef added in v1.15.0 

type CloudEvent_CloudEventAttributeValue_CeUriRef struct {
	// URI-reference value.
	CeUriRef string `protobuf:"bytes,6,opt,name=ce_uri_ref,json=ceUriRef,proto3,oneof"`
}

type CloudEvent_ProtoData added in v1.15.0 

type CloudEvent_ProtoData struct {
	// Optional. Proto data.
	ProtoData *anypb.Any `protobuf:"bytes,8,opt,name=proto_data,json=protoData,proto3,oneof"`
}

type CloudEvent_TextData added in v1.15.0 

type CloudEvent_TextData struct {
	// Optional. Text data.
	TextData string `protobuf:"bytes,7,opt,name=text_data,json=textData,proto3,oneof"`
}

type PublishChannelConnectionEventsRequest 

type PublishChannelConnectionEventsRequest struct {

	// The channel_connection that the events are published from. For example:
	// `projects/{partner_project_id}/locations/{location}/channelConnections/{channel_connection_id}`.
	ChannelConnection string `protobuf:"bytes,1,opt,name=channel_connection,json=channelConnection,proto3" json:"channel_connection,omitempty"`
	// The CloudEvents v1.0 events to publish. No other types are allowed.
	// If this field is set, then the `text_events` fields must not be set.
	Events []*anypb.Any `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
	// The text representation of events to publish.
	// CloudEvent v1.0 in JSON format is the only allowed type. Refer to
	// https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md
	// for specification.
	// If this field is set, then the `events` fields must not be set.
	TextEvents []string `protobuf:"bytes,3,rep,name=text_events,json=textEvents,proto3" json:"text_events,omitempty"`
	// contains filtered or unexported fields
}

The request message for the PublishChannelConnectionEvents method.

func (*PublishChannelConnectionEventsRequest) Descriptor deprecated 

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

Deprecated: Use PublishChannelConnectionEventsRequest.ProtoReflect.Descriptor instead.

func (*PublishChannelConnectionEventsRequest) GetChannelConnection 

func (x *PublishChannelConnectionEventsRequest) GetChannelConnection() string

func (*PublishChannelConnectionEventsRequest) GetEvents 

func (x *PublishChannelConnectionEventsRequest) GetEvents() []*anypb.Any

func (*PublishChannelConnectionEventsRequest) GetTextEvents added in v1.9.0 

func (x *PublishChannelConnectionEventsRequest) GetTextEvents() []string

func (*PublishChannelConnectionEventsRequest) ProtoMessage 

func (*PublishChannelConnectionEventsRequest) ProtoMessage()

func (*PublishChannelConnectionEventsRequest) ProtoReflect 

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

func (*PublishChannelConnectionEventsRequest) Reset 

func (x *PublishChannelConnectionEventsRequest) Reset()

func (*PublishChannelConnectionEventsRequest) String 

func (x *PublishChannelConnectionEventsRequest) String() string

type PublishChannelConnectionEventsResponse 

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

The response message for the PublishChannelConnectionEvents method.

func (*PublishChannelConnectionEventsResponse) Descriptor deprecated 

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

Deprecated: Use PublishChannelConnectionEventsResponse.ProtoReflect.Descriptor instead.

func (*PublishChannelConnectionEventsResponse) ProtoMessage 

func (*PublishChannelConnectionEventsResponse) ProtoMessage()

func (*PublishChannelConnectionEventsResponse) ProtoReflect 

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

func (*PublishChannelConnectionEventsResponse) Reset 

func (x *PublishChannelConnectionEventsResponse) Reset()

func (*PublishChannelConnectionEventsResponse) String 

func (x *PublishChannelConnectionEventsResponse) String() string

type PublishEventsRequest 

type PublishEventsRequest struct {

	// The full name of the channel to publish to. For example:
	// `projects/{project}/locations/{location}/channels/{channel-id}`.
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// The CloudEvents v1.0 events to publish. No other types are allowed.
	// If this field is set, then the `text_events` fields must not be set.
	Events []*anypb.Any `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
	// The text representation of events to publish.
	// CloudEvent v1.0 in JSON format is the only allowed type. Refer to
	// https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md
	// for specification.
	// If this field is set, then the `events` fields must not be set.
	TextEvents []string `protobuf:"bytes,3,rep,name=text_events,json=textEvents,proto3" json:"text_events,omitempty"`
	// contains filtered or unexported fields
}

The request message for the PublishEvents method.

func (*PublishEventsRequest) Descriptor deprecated 

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

Deprecated: Use PublishEventsRequest.ProtoReflect.Descriptor instead.

func (*PublishEventsRequest) GetChannel 

func (x *PublishEventsRequest) GetChannel() string

func (*PublishEventsRequest) GetEvents 

func (x *PublishEventsRequest) GetEvents() []*anypb.Any

func (*PublishEventsRequest) GetTextEvents added in v1.9.0 

func (x *PublishEventsRequest) GetTextEvents() []string

func (*PublishEventsRequest) ProtoMessage 

func (*PublishEventsRequest) ProtoMessage()

func (*PublishEventsRequest) ProtoReflect 

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

func (*PublishEventsRequest) Reset 

func (x *PublishEventsRequest) Reset()

func (*PublishEventsRequest) String 

func (x *PublishEventsRequest) String() string

type PublishEventsResponse 

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

The response message for the PublishEvents method.

func (*PublishEventsResponse) Descriptor deprecated 

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

Deprecated: Use PublishEventsResponse.ProtoReflect.Descriptor instead.

func (*PublishEventsResponse) ProtoMessage 

func (*PublishEventsResponse) ProtoMessage()

func (*PublishEventsResponse) ProtoReflect 

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

func (*PublishEventsResponse) Reset 

func (x *PublishEventsResponse) Reset()

func (*PublishEventsResponse) String 

func (x *PublishEventsResponse) String() string

type PublishRequest added in v1.15.0 

type PublishRequest struct {

	// Required. The full name of the message bus to publish events to. Format:
	// `projects/{project}/locations/{location}/messageBuses/{messageBus}`.
	MessageBus string `protobuf:"bytes,1,opt,name=message_bus,json=messageBus,proto3" json:"message_bus,omitempty"`
	// Types that are assignable to Format:
	//
	//	*PublishRequest_ProtoMessage_
	//	*PublishRequest_JsonMessage
	//	*PublishRequest_AvroMessage
	Format isPublishRequest_Format `protobuf_oneof:"format"`
	// contains filtered or unexported fields
}

The request message for the Publish method.

func (*PublishRequest) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use PublishRequest.ProtoReflect.Descriptor instead.

func (*PublishRequest) GetAvroMessage added in v1.15.0 

func (x *PublishRequest) GetAvroMessage() []byte

func (*PublishRequest) GetFormat added in v1.15.0 

func (m *PublishRequest) GetFormat() isPublishRequest_Format

func (*PublishRequest) GetJsonMessage added in v1.15.0 

func (x *PublishRequest) GetJsonMessage() string

func (*PublishRequest) GetMessageBus added in v1.15.0 

func (x *PublishRequest) GetMessageBus() string

func (*PublishRequest) GetProtoMessage_ added in v1.15.0 

func (x *PublishRequest) GetProtoMessage_() *CloudEvent

func (*PublishRequest) ProtoMessage added in v1.15.0 

func (*PublishRequest) ProtoMessage()

func (*PublishRequest) ProtoReflect added in v1.15.0 

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

func (*PublishRequest) Reset added in v1.15.0 

func (x *PublishRequest) Reset()

func (*PublishRequest) String added in v1.15.0 

func (x *PublishRequest) String() string

type PublishRequest_AvroMessage added in v1.15.0 

type PublishRequest_AvroMessage struct {
	// The Avro format of the CloudEvent being published. Specification can
	// be found here:
	// https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/avro-format.md
	AvroMessage []byte `protobuf:"bytes,4,opt,name=avro_message,json=avroMessage,proto3,oneof"`
}

type PublishRequest_JsonMessage added in v1.15.0 

type PublishRequest_JsonMessage struct {
	// The JSON format of the CloudEvent being published. Specification can be
	// found here:
	// https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md
	JsonMessage string `protobuf:"bytes,3,opt,name=json_message,json=jsonMessage,proto3,oneof"`
}

type PublishRequest_ProtoMessage_ added in v1.15.0 

type PublishRequest_ProtoMessage_ struct {
	// The Protobuf format of the CloudEvent being published. Specification can
	// be found here:
	// https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/protobuf-format.md
	ProtoMessage_ *CloudEvent `protobuf:"bytes,2,opt,name=proto_message,json=protoMessage,proto3,oneof"`
}

type PublishResponse added in v1.15.0 

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

The response message for the Publish method.

func (*PublishResponse) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use PublishResponse.ProtoReflect.Descriptor instead.

func (*PublishResponse) ProtoMessage added in v1.15.0 

func (*PublishResponse) ProtoMessage()

func (*PublishResponse) ProtoReflect added in v1.15.0 

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

func (*PublishResponse) Reset added in v1.15.0 

func (x *PublishResponse) Reset()

func (*PublishResponse) String added in v1.15.0 

func (x *PublishResponse) String() string

type PublisherClient 

type PublisherClient interface {
	// Publish events to a ChannelConnection in a partner's project.
	PublishChannelConnectionEvents(ctx context.Context, in *PublishChannelConnectionEventsRequest, opts ...grpc.CallOption) (*PublishChannelConnectionEventsResponse, error)
	// Publish events to a subscriber's channel.
	PublishEvents(ctx context.Context, in *PublishEventsRequest, opts ...grpc.CallOption) (*PublishEventsResponse, error)
	// Publish events to a message bus.
	Publish(ctx context.Context, in *PublishRequest, opts ...grpc.CallOption) (*PublishResponse, error)
}

PublisherClient is the client API for Publisher 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 NewPublisherClient 

func NewPublisherClient(cc grpc.ClientConnInterface) PublisherClient

type PublisherServer 

type PublisherServer interface {
	// Publish events to a ChannelConnection in a partner's project.
	PublishChannelConnectionEvents(context.Context, *PublishChannelConnectionEventsRequest) (*PublishChannelConnectionEventsResponse, error)
	// Publish events to a subscriber's channel.
	PublishEvents(context.Context, *PublishEventsRequest) (*PublishEventsResponse, error)
	// Publish events to a message bus.
	Publish(context.Context, *PublishRequest) (*PublishResponse, error)
}

PublisherServer is the server API for Publisher service. All implementations should embed UnimplementedPublisherServer for forward compatibility

type UnimplementedPublisherServer 

type UnimplementedPublisherServer struct {
}

UnimplementedPublisherServer should be embedded to have forward compatible implementations.

func (UnimplementedPublisherServer) Publish added in v1.15.0 

func (UnimplementedPublisherServer) Publish(context.Context, *PublishRequest) (*PublishResponse, error)

func (UnimplementedPublisherServer) PublishChannelConnectionEvents 

func (UnimplementedPublisherServer) PublishChannelConnectionEvents(context.Context, *PublishChannelConnectionEventsRequest) (*PublishChannelConnectionEventsResponse, error)

func (UnimplementedPublisherServer) PublishEvents 

func (UnimplementedPublisherServer) PublishEvents(context.Context, *PublishEventsRequest) (*PublishEventsResponse, error)

type UnsafePublisherServer added in v1.16.1 

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

UnsafePublisherServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PublisherServer 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.