...
ActiveGo 1.8Package pubsub
Overview ▹
Index ▹
func RegisterPublisherServer ¶
func RegisterPublisherServer(s *grpc.Server, srv PublisherServer)
func RegisterSubscriberServer ¶
func RegisterSubscriberServer(s *grpc.Server, srv SubscriberServer)
type AcknowledgeRequest ¶
Request for the Acknowledge method.
type AcknowledgeRequest struct {
// The subscription whose message is being acknowledged.
Subscription string `protobuf:"bytes,1,opt,name=subscription" json:"subscription,omitempty"`
// The acknowledgment ID for the messages being acknowledged that was returned
// by the Pub/Sub system in the Pull response. Must not be empty.
AckIds []string `protobuf:"bytes,2,rep,name=ack_ids,json=ackIds" json:"ack_ids,omitempty"`
}
func (*AcknowledgeRequest) Descriptor ¶
func (*AcknowledgeRequest) Descriptor() ([]byte, []int)
func (*AcknowledgeRequest) GetAckIds ¶
func (m *AcknowledgeRequest) GetAckIds() []string
func (*AcknowledgeRequest) GetSubscription ¶
func (m *AcknowledgeRequest) GetSubscription() string
func (*AcknowledgeRequest) ProtoMessage ¶
func (*AcknowledgeRequest) ProtoMessage()
func (*AcknowledgeRequest) Reset ¶
func (m *AcknowledgeRequest) Reset()
func (*AcknowledgeRequest) String ¶
func (m *AcknowledgeRequest) String() string
type DeleteSubscriptionRequest ¶
Request for the DeleteSubscription method.
type DeleteSubscriptionRequest struct {
// The subscription to delete.
Subscription string `protobuf:"bytes,1,opt,name=subscription" json:"subscription,omitempty"`
}
func (*DeleteSubscriptionRequest) Descriptor ¶
func (*DeleteSubscriptionRequest) Descriptor() ([]byte, []int)
func (*DeleteSubscriptionRequest) GetSubscription ¶
func (m *DeleteSubscriptionRequest) GetSubscription() string
func (*DeleteSubscriptionRequest) ProtoMessage ¶
func (*DeleteSubscriptionRequest) ProtoMessage()
func (*DeleteSubscriptionRequest) Reset ¶
func (m *DeleteSubscriptionRequest) Reset()
func (*DeleteSubscriptionRequest) String ¶
func (m *DeleteSubscriptionRequest) String() string
type DeleteTopicRequest ¶
Request for the DeleteTopic method.
type DeleteTopicRequest struct {
// Name of the topic to delete.
Topic string `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
}
func (*DeleteTopicRequest) Descriptor ¶
func (*DeleteTopicRequest) Descriptor() ([]byte, []int)
func (*DeleteTopicRequest) GetTopic ¶
func (m *DeleteTopicRequest) GetTopic() string
func (*DeleteTopicRequest) ProtoMessage ¶
func (*DeleteTopicRequest) ProtoMessage()
func (*DeleteTopicRequest) Reset ¶
func (m *DeleteTopicRequest) Reset()
func (*DeleteTopicRequest) String ¶
func (m *DeleteTopicRequest) String() string
type GetSubscriptionRequest ¶
Request for the GetSubscription method.
type GetSubscriptionRequest struct {
// The name of the subscription to get.
Subscription string `protobuf:"bytes,1,opt,name=subscription" json:"subscription,omitempty"`
}
func (*GetSubscriptionRequest) Descriptor ¶
func (*GetSubscriptionRequest) Descriptor() ([]byte, []int)
func (*GetSubscriptionRequest) GetSubscription ¶
func (m *GetSubscriptionRequest) GetSubscription() string
func (*GetSubscriptionRequest) ProtoMessage ¶
func (*GetSubscriptionRequest) ProtoMessage()
func (*GetSubscriptionRequest) Reset ¶
func (m *GetSubscriptionRequest) Reset()
func (*GetSubscriptionRequest) String ¶
func (m *GetSubscriptionRequest) String() string
type GetTopicRequest ¶
Request for the GetTopic method.
type GetTopicRequest struct {
// The name of the topic to get.
Topic string `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
}
func (*GetTopicRequest) Descriptor ¶
func (*GetTopicRequest) Descriptor() ([]byte, []int)
func (*GetTopicRequest) GetTopic ¶
func (m *GetTopicRequest) GetTopic() string
func (*GetTopicRequest) ProtoMessage ¶
func (*GetTopicRequest) ProtoMessage()
func (*GetTopicRequest) Reset ¶
func (m *GetTopicRequest) Reset()
func (*GetTopicRequest) String ¶
func (m *GetTopicRequest) String() string
type ListSubscriptionsRequest ¶
Request for the ListSubscriptions method.
type ListSubscriptionsRequest struct {
// The name of the cloud project that subscriptions belong to.
Project string `protobuf:"bytes,1,opt,name=project" json:"project,omitempty"`
// Maximum number of subscriptions to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// The value returned by the last ListSubscriptionsResponse; indicates that
// this is a continuation of a prior ListSubscriptions call, and that the
// system should return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListSubscriptionsRequest) Descriptor ¶
func (*ListSubscriptionsRequest) Descriptor() ([]byte, []int)
func (*ListSubscriptionsRequest) GetPageSize ¶
func (m *ListSubscriptionsRequest) GetPageSize() int32
func (*ListSubscriptionsRequest) GetPageToken ¶
func (m *ListSubscriptionsRequest) GetPageToken() string
func (*ListSubscriptionsRequest) GetProject ¶
func (m *ListSubscriptionsRequest) GetProject() string
func (*ListSubscriptionsRequest) ProtoMessage ¶
func (*ListSubscriptionsRequest) ProtoMessage()
func (*ListSubscriptionsRequest) Reset ¶
func (m *ListSubscriptionsRequest) Reset()
func (*ListSubscriptionsRequest) String ¶
func (m *ListSubscriptionsRequest) String() string
type ListSubscriptionsResponse ¶
Response for the ListSubscriptions method.
type ListSubscriptionsResponse struct {
// The subscriptions that match the request.
Subscriptions []*Subscription `protobuf:"bytes,1,rep,name=subscriptions" json:"subscriptions,omitempty"`
// If not empty, indicates that there may be more subscriptions that match
// the request; this value should be passed in a new ListSubscriptionsRequest
// to get more subscriptions.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListSubscriptionsResponse) Descriptor ¶
func (*ListSubscriptionsResponse) Descriptor() ([]byte, []int)
func (*ListSubscriptionsResponse) GetNextPageToken ¶
func (m *ListSubscriptionsResponse) GetNextPageToken() string
func (*ListSubscriptionsResponse) GetSubscriptions ¶
func (m *ListSubscriptionsResponse) GetSubscriptions() []*Subscription
func (*ListSubscriptionsResponse) ProtoMessage ¶
func (*ListSubscriptionsResponse) ProtoMessage()
func (*ListSubscriptionsResponse) Reset ¶
func (m *ListSubscriptionsResponse) Reset()
func (*ListSubscriptionsResponse) String ¶
func (m *ListSubscriptionsResponse) String() string
type ListTopicSubscriptionsRequest ¶
Request for the ListTopicSubscriptions method.
type ListTopicSubscriptionsRequest struct {
// The name of the topic that subscriptions are attached to.
Topic string `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
// Maximum number of subscription names to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// The value returned by the last ListTopicSubscriptionsResponse; indicates
// that this is a continuation of a prior ListTopicSubscriptions call, and
// that the system should return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListTopicSubscriptionsRequest) Descriptor ¶
func (*ListTopicSubscriptionsRequest) Descriptor() ([]byte, []int)
func (*ListTopicSubscriptionsRequest) GetPageSize ¶
func (m *ListTopicSubscriptionsRequest) GetPageSize() int32
func (*ListTopicSubscriptionsRequest) GetPageToken ¶
func (m *ListTopicSubscriptionsRequest) GetPageToken() string
func (*ListTopicSubscriptionsRequest) GetTopic ¶
func (m *ListTopicSubscriptionsRequest) GetTopic() string
func (*ListTopicSubscriptionsRequest) ProtoMessage ¶
func (*ListTopicSubscriptionsRequest) ProtoMessage()
func (*ListTopicSubscriptionsRequest) Reset ¶
func (m *ListTopicSubscriptionsRequest) Reset()
func (*ListTopicSubscriptionsRequest) String ¶
func (m *ListTopicSubscriptionsRequest) String() string
type ListTopicSubscriptionsResponse ¶
Response for the ListTopicSubscriptions method.
type ListTopicSubscriptionsResponse struct {
// The names of the subscriptions that match the request.
Subscriptions []string `protobuf:"bytes,1,rep,name=subscriptions" json:"subscriptions,omitempty"`
// If not empty, indicates that there may be more subscriptions that match
// the request; this value should be passed in a new
// ListTopicSubscriptionsRequest to get more subscriptions.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListTopicSubscriptionsResponse) Descriptor ¶
func (*ListTopicSubscriptionsResponse) Descriptor() ([]byte, []int)
func (*ListTopicSubscriptionsResponse) GetNextPageToken ¶
func (m *ListTopicSubscriptionsResponse) GetNextPageToken() string
func (*ListTopicSubscriptionsResponse) GetSubscriptions ¶
func (m *ListTopicSubscriptionsResponse) GetSubscriptions() []string
func (*ListTopicSubscriptionsResponse) ProtoMessage ¶
func (*ListTopicSubscriptionsResponse) ProtoMessage()
func (*ListTopicSubscriptionsResponse) Reset ¶
func (m *ListTopicSubscriptionsResponse) Reset()
func (*ListTopicSubscriptionsResponse) String ¶
func (m *ListTopicSubscriptionsResponse) String() string
type ListTopicsRequest ¶
Request for the ListTopics method.
type ListTopicsRequest struct {
// The name of the cloud project that topics belong to.
Project string `protobuf:"bytes,1,opt,name=project" json:"project,omitempty"`
// Maximum number of topics to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// The value returned by the last ListTopicsResponse; indicates that this is
// a continuation of a prior ListTopics call, and that the system should
// return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListTopicsRequest) Descriptor ¶
func (*ListTopicsRequest) Descriptor() ([]byte, []int)
func (*ListTopicsRequest) GetPageSize ¶
func (m *ListTopicsRequest) GetPageSize() int32
func (*ListTopicsRequest) GetPageToken ¶
func (m *ListTopicsRequest) GetPageToken() string
func (*ListTopicsRequest) GetProject ¶
func (m *ListTopicsRequest) GetProject() string
func (*ListTopicsRequest) ProtoMessage ¶
func (*ListTopicsRequest) ProtoMessage()
func (*ListTopicsRequest) Reset ¶
func (m *ListTopicsRequest) Reset()
func (*ListTopicsRequest) String ¶
func (m *ListTopicsRequest) String() string
type ListTopicsResponse ¶
Response for the ListTopics method.
type ListTopicsResponse struct {
// The resulting topics.
Topics []*Topic `protobuf:"bytes,1,rep,name=topics" json:"topics,omitempty"`
// If not empty, indicates that there may be more topics that match the
// request; this value should be passed in a new ListTopicsRequest.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListTopicsResponse) Descriptor ¶
func (*ListTopicsResponse) Descriptor() ([]byte, []int)
func (*ListTopicsResponse) GetNextPageToken ¶
func (m *ListTopicsResponse) GetNextPageToken() string
func (*ListTopicsResponse) GetTopics ¶
func (m *ListTopicsResponse) GetTopics() []*Topic
func (*ListTopicsResponse) ProtoMessage ¶
func (*ListTopicsResponse) ProtoMessage()
func (*ListTopicsResponse) Reset ¶
func (m *ListTopicsResponse) Reset()
func (*ListTopicsResponse) String ¶
func (m *ListTopicsResponse) String() string
type ModifyAckDeadlineRequest ¶
Request for the ModifyAckDeadline method.
type ModifyAckDeadlineRequest struct {
// The name of the subscription.
Subscription string `protobuf:"bytes,1,opt,name=subscription" json:"subscription,omitempty"`
// The acknowledgment ID.
AckId string `protobuf:"bytes,2,opt,name=ack_id,json=ackId" json:"ack_id,omitempty"`
// The new ack deadline with respect to the time this request was sent to the
// Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack
// deadline will expire 10 seconds after the ModifyAckDeadline call was made.
// Specifying zero may immediately make the message available for another pull
// request.
AckDeadlineSeconds int32 `protobuf:"varint,3,opt,name=ack_deadline_seconds,json=ackDeadlineSeconds" json:"ack_deadline_seconds,omitempty"`
}
func (*ModifyAckDeadlineRequest) Descriptor ¶
func (*ModifyAckDeadlineRequest) Descriptor() ([]byte, []int)
func (*ModifyAckDeadlineRequest) GetAckDeadlineSeconds ¶
func (m *ModifyAckDeadlineRequest) GetAckDeadlineSeconds() int32
func (*ModifyAckDeadlineRequest) GetAckId ¶
func (m *ModifyAckDeadlineRequest) GetAckId() string
func (*ModifyAckDeadlineRequest) GetSubscription ¶
func (m *ModifyAckDeadlineRequest) GetSubscription() string
func (*ModifyAckDeadlineRequest) ProtoMessage ¶
func (*ModifyAckDeadlineRequest) ProtoMessage()
func (*ModifyAckDeadlineRequest) Reset ¶
func (m *ModifyAckDeadlineRequest) Reset()
func (*ModifyAckDeadlineRequest) String ¶
func (m *ModifyAckDeadlineRequest) String() string
type ModifyPushConfigRequest ¶
Request for the ModifyPushConfig method.
type ModifyPushConfigRequest struct {
// The name of the subscription.
Subscription string `protobuf:"bytes,1,opt,name=subscription" json:"subscription,omitempty"`
// The push configuration for future deliveries.
//
// An empty pushConfig indicates that the Pub/Sub system should
// stop pushing messages from the given subscription and allow
// messages to be pulled and acknowledged - effectively pausing
// the subscription if Pull is not called.
PushConfig *PushConfig `protobuf:"bytes,2,opt,name=push_config,json=pushConfig" json:"push_config,omitempty"`
}
func (*ModifyPushConfigRequest) Descriptor ¶
func (*ModifyPushConfigRequest) Descriptor() ([]byte, []int)
func (*ModifyPushConfigRequest) GetPushConfig ¶
func (m *ModifyPushConfigRequest) GetPushConfig() *PushConfig
func (*ModifyPushConfigRequest) GetSubscription ¶
func (m *ModifyPushConfigRequest) GetSubscription() string
func (*ModifyPushConfigRequest) ProtoMessage ¶
func (*ModifyPushConfigRequest) ProtoMessage()
func (*ModifyPushConfigRequest) Reset ¶
func (m *ModifyPushConfigRequest) Reset()
func (*ModifyPushConfigRequest) String ¶
func (m *ModifyPushConfigRequest) String() string
type PublishRequest ¶
Request for the Publish method.
type PublishRequest struct {
// The messages in the request will be published on this topic.
Topic string `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
// The messages to publish.
Messages []*PubsubMessage `protobuf:"bytes,2,rep,name=messages" json:"messages,omitempty"`
}
func (*PublishRequest) Descriptor ¶
func (*PublishRequest) Descriptor() ([]byte, []int)
func (*PublishRequest) GetMessages ¶
func (m *PublishRequest) GetMessages() []*PubsubMessage
func (*PublishRequest) GetTopic ¶
func (m *PublishRequest) GetTopic() string
func (*PublishRequest) ProtoMessage ¶
func (*PublishRequest) ProtoMessage()
func (*PublishRequest) Reset ¶
func (m *PublishRequest) Reset()
func (*PublishRequest) String ¶
func (m *PublishRequest) String() string
type PublishResponse ¶
Response for the Publish method.
type PublishResponse struct {
// The server-assigned ID of each published message, in the same order as
// the messages in the request. IDs are guaranteed to be unique within
// the topic.
MessageIds []string `protobuf:"bytes,1,rep,name=message_ids,json=messageIds" json:"message_ids,omitempty"`
}
func (*PublishResponse) Descriptor ¶
func (*PublishResponse) Descriptor() ([]byte, []int)
func (*PublishResponse) GetMessageIds ¶
func (m *PublishResponse) GetMessageIds() []string
func (*PublishResponse) ProtoMessage ¶
func (*PublishResponse) ProtoMessage()
func (*PublishResponse) Reset ¶
func (m *PublishResponse) Reset()
func (*PublishResponse) String ¶
func (m *PublishResponse) String() string
type PublisherClient ¶
type PublisherClient interface {
// Creates the given topic with the given name.
CreateTopic(ctx context.Context, in *Topic, opts ...grpc.CallOption) (*Topic, error)
// Adds one or more messages to the topic. Returns NOT_FOUND if the topic does
// not exist.
Publish(ctx context.Context, in *PublishRequest, opts ...grpc.CallOption) (*PublishResponse, error)
// Gets the configuration of a topic.
GetTopic(ctx context.Context, in *GetTopicRequest, opts ...grpc.CallOption) (*Topic, error)
// Lists matching topics.
ListTopics(ctx context.Context, in *ListTopicsRequest, opts ...grpc.CallOption) (*ListTopicsResponse, error)
// Lists the name of the subscriptions for this topic.
ListTopicSubscriptions(ctx context.Context, in *ListTopicSubscriptionsRequest, opts ...grpc.CallOption) (*ListTopicSubscriptionsResponse, error)
// Deletes the topic with the given name. Returns NOT_FOUND if the topic does
// not exist. After a topic is deleted, a new topic may be created with the
// same name; this is an entirely new topic with none of the old
// configuration or subscriptions. Existing subscriptions to this topic are
// not deleted.
DeleteTopic(ctx context.Context, in *DeleteTopicRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
}
func NewPublisherClient ¶
func NewPublisherClient(cc *grpc.ClientConn) PublisherClient
type PublisherServer ¶
type PublisherServer interface {
// Creates the given topic with the given name.
CreateTopic(context.Context, *Topic) (*Topic, error)
// Adds one or more messages to the topic. Returns NOT_FOUND if the topic does
// not exist.
Publish(context.Context, *PublishRequest) (*PublishResponse, error)
// Gets the configuration of a topic.
GetTopic(context.Context, *GetTopicRequest) (*Topic, error)
// Lists matching topics.
ListTopics(context.Context, *ListTopicsRequest) (*ListTopicsResponse, error)
// Lists the name of the subscriptions for this topic.
ListTopicSubscriptions(context.Context, *ListTopicSubscriptionsRequest) (*ListTopicSubscriptionsResponse, error)
// Deletes the topic with the given name. Returns NOT_FOUND if the topic does
// not exist. After a topic is deleted, a new topic may be created with the
// same name; this is an entirely new topic with none of the old
// configuration or subscriptions. Existing subscriptions to this topic are
// not deleted.
DeleteTopic(context.Context, *DeleteTopicRequest) (*google_protobuf.Empty, error)
}
type PubsubMessage ¶
A message data and its attributes.
type PubsubMessage struct {
// The message payload. For JSON requests, the value of this field must be
// base64-encoded.
Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// Optional attributes for this message.
Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// ID of this message assigned by the server at publication time. Guaranteed
// to be unique within the topic. This value may be read by a subscriber
// that receives a PubsubMessage via a Pull call or a push delivery. It must
// not be populated by a publisher in a Publish call.
MessageId string `protobuf:"bytes,3,opt,name=message_id,json=messageId" json:"message_id,omitempty"`
}
func (*PubsubMessage) Descriptor ¶
func (*PubsubMessage) Descriptor() ([]byte, []int)
func (*PubsubMessage) GetAttributes ¶
func (m *PubsubMessage) GetAttributes() map[string]string
func (*PubsubMessage) GetData ¶
func (m *PubsubMessage) GetData() []byte
func (*PubsubMessage) GetMessageId ¶
func (m *PubsubMessage) GetMessageId() string
func (*PubsubMessage) ProtoMessage ¶
func (*PubsubMessage) ProtoMessage()
func (*PubsubMessage) Reset ¶
func (m *PubsubMessage) Reset()
func (*PubsubMessage) String ¶
func (m *PubsubMessage) String() string
type PullRequest ¶
Request for the Pull method.
type PullRequest struct {
// The subscription from which messages should be pulled.
Subscription string `protobuf:"bytes,1,opt,name=subscription" json:"subscription,omitempty"`
// If this is specified as true the system will respond immediately even if
// it is not able to return a message in the Pull response. Otherwise the
// system is allowed to wait until at least one message is available rather
// than returning no messages. The client may cancel the request if it does
// not wish to wait any longer for the response.
ReturnImmediately bool `protobuf:"varint,2,opt,name=return_immediately,json=returnImmediately" json:"return_immediately,omitempty"`
// The maximum number of messages returned for this request. The Pub/Sub
// system may return fewer than the number specified.
MaxMessages int32 `protobuf:"varint,3,opt,name=max_messages,json=maxMessages" json:"max_messages,omitempty"`
}
func (*PullRequest) Descriptor ¶
func (*PullRequest) Descriptor() ([]byte, []int)
func (*PullRequest) GetMaxMessages ¶
func (m *PullRequest) GetMaxMessages() int32
func (*PullRequest) GetReturnImmediately ¶
func (m *PullRequest) GetReturnImmediately() bool
func (*PullRequest) GetSubscription ¶
func (m *PullRequest) GetSubscription() string
func (*PullRequest) ProtoMessage ¶
func (*PullRequest) ProtoMessage()
func (*PullRequest) Reset ¶
func (m *PullRequest) Reset()
func (*PullRequest) String ¶
func (m *PullRequest) String() string
type PullResponse ¶
Response for the Pull method.
type PullResponse struct {
// Received Pub/Sub messages. The Pub/Sub system will return zero messages if
// there are no more available in the backlog. The Pub/Sub system may return
// fewer than the maxMessages requested even if there are more messages
// available in the backlog.
ReceivedMessages []*ReceivedMessage `protobuf:"bytes,1,rep,name=received_messages,json=receivedMessages" json:"received_messages,omitempty"`
}
func (*PullResponse) Descriptor ¶
func (*PullResponse) Descriptor() ([]byte, []int)
func (*PullResponse) GetReceivedMessages ¶
func (m *PullResponse) GetReceivedMessages() []*ReceivedMessage
func (*PullResponse) ProtoMessage ¶
func (*PullResponse) ProtoMessage()
func (*PullResponse) Reset ¶
func (m *PullResponse) Reset()
func (*PullResponse) String ¶
func (m *PullResponse) String() string
type PushConfig ¶
Configuration for a push delivery endpoint.
type PushConfig struct {
// A URL locating the endpoint to which messages should be pushed.
// For example, a Webhook endpoint might use "https://example.com/push".
PushEndpoint string `protobuf:"bytes,1,opt,name=push_endpoint,json=pushEndpoint" json:"push_endpoint,omitempty"`
// Endpoint configuration attributes.
//
// Every endpoint has a set of API supported attributes that can be used to
// control different aspects of the message delivery.
//
// The currently supported attribute is `x-goog-version`, which you can
// use to change the format of the push message. This attribute
// indicates the version of the data expected by the endpoint. This
// controls the shape of the envelope (i.e. its fields and metadata).
// The endpoint version is based on the version of the Pub/Sub
// API.
//
// If not present during the CreateSubscription call, it will default to
// the version of the API used to make such call. If not present during a
// ModifyPushConfig call, its value will not be changed. GetSubscription
// calls will always return a valid version, even if the subscription was
// created without this attribute.
//
// The possible values for this attribute are:
//
// * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
// * `v1beta2`: uses the push format defined in the v1beta2 Pub/Sub API.
//
Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
}
func (*PushConfig) Descriptor ¶
func (*PushConfig) Descriptor() ([]byte, []int)
func (*PushConfig) GetAttributes ¶
func (m *PushConfig) GetAttributes() map[string]string
func (*PushConfig) GetPushEndpoint ¶
func (m *PushConfig) GetPushEndpoint() string
func (*PushConfig) ProtoMessage ¶
func (*PushConfig) ProtoMessage()
func (*PushConfig) Reset ¶
func (m *PushConfig) Reset()
func (*PushConfig) String ¶
func (m *PushConfig) String() string
type ReceivedMessage ¶
A message and its corresponding acknowledgment ID.
type ReceivedMessage struct {
// This ID can be used to acknowledge the received message.
AckId string `protobuf:"bytes,1,opt,name=ack_id,json=ackId" json:"ack_id,omitempty"`
// The message.
Message *PubsubMessage `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
}
func (*ReceivedMessage) Descriptor ¶
func (*ReceivedMessage) Descriptor() ([]byte, []int)
func (*ReceivedMessage) GetAckId ¶
func (m *ReceivedMessage) GetAckId() string
func (*ReceivedMessage) GetMessage ¶
func (m *ReceivedMessage) GetMessage() *PubsubMessage
func (*ReceivedMessage) ProtoMessage ¶
func (*ReceivedMessage) ProtoMessage()
func (*ReceivedMessage) Reset ¶
func (m *ReceivedMessage) Reset()
func (*ReceivedMessage) String ¶
func (m *ReceivedMessage) String() string
type SubscriberClient ¶
type SubscriberClient interface {
// Creates a subscription to a given topic for a given subscriber.
// If the subscription already exists, returns ALREADY_EXISTS.
// If the corresponding topic doesn't exist, returns NOT_FOUND.
//
// If the name is not provided in the request, the server will assign a random
// name for this subscription on the same project as the topic.
CreateSubscription(ctx context.Context, in *Subscription, opts ...grpc.CallOption) (*Subscription, error)
// Gets the configuration details of a subscription.
GetSubscription(ctx context.Context, in *GetSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)
// Lists matching subscriptions.
ListSubscriptions(ctx context.Context, in *ListSubscriptionsRequest, opts ...grpc.CallOption) (*ListSubscriptionsResponse, error)
// Deletes an existing subscription. All pending messages in the subscription
// are immediately dropped. Calls to Pull after deletion will return
// NOT_FOUND. After a subscription is deleted, a new one may be created with
// the same name, but the new one has no association with the old
// subscription, or its topic unless the same topic is specified.
DeleteSubscription(ctx context.Context, in *DeleteSubscriptionRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
// Modifies the ack deadline for a specific message. This method is useful to
// indicate that more time is needed to process a message by the subscriber,
// or to make the message available for redelivery if the processing was
// interrupted.
ModifyAckDeadline(ctx context.Context, in *ModifyAckDeadlineRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
// Acknowledges the messages associated with the ack tokens in the
// AcknowledgeRequest. The Pub/Sub system can remove the relevant messages
// from the subscription.
//
// Acknowledging a message whose ack deadline has expired may succeed,
// but such a message may be redelivered later. Acknowledging a message more
// than once will not result in an error.
Acknowledge(ctx context.Context, in *AcknowledgeRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
// Pulls messages from the server. Returns an empty list if there are no
// messages available in the backlog. The server may return UNAVAILABLE if
// there are too many concurrent pull requests pending for the given
// subscription.
Pull(ctx context.Context, in *PullRequest, opts ...grpc.CallOption) (*PullResponse, error)
// Modifies the PushConfig for a specified subscription.
//
// This may be used to change a push subscription to a pull one (signified
// by an empty PushConfig) or vice versa, or change the endpoint URL and other
// attributes of a push subscription. Messages will accumulate for
// delivery continuously through the call regardless of changes to the
// PushConfig.
ModifyPushConfig(ctx context.Context, in *ModifyPushConfigRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
}
func NewSubscriberClient ¶
func NewSubscriberClient(cc *grpc.ClientConn) SubscriberClient
type SubscriberServer ¶
type SubscriberServer interface {
// Creates a subscription to a given topic for a given subscriber.
// If the subscription already exists, returns ALREADY_EXISTS.
// If the corresponding topic doesn't exist, returns NOT_FOUND.
//
// If the name is not provided in the request, the server will assign a random
// name for this subscription on the same project as the topic.
CreateSubscription(context.Context, *Subscription) (*Subscription, error)
// Gets the configuration details of a subscription.
GetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)
// Lists matching subscriptions.
ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)
// Deletes an existing subscription. All pending messages in the subscription
// are immediately dropped. Calls to Pull after deletion will return
// NOT_FOUND. After a subscription is deleted, a new one may be created with
// the same name, but the new one has no association with the old
// subscription, or its topic unless the same topic is specified.
DeleteSubscription(context.Context, *DeleteSubscriptionRequest) (*google_protobuf.Empty, error)
// Modifies the ack deadline for a specific message. This method is useful to
// indicate that more time is needed to process a message by the subscriber,
// or to make the message available for redelivery if the processing was
// interrupted.
ModifyAckDeadline(context.Context, *ModifyAckDeadlineRequest) (*google_protobuf.Empty, error)
// Acknowledges the messages associated with the ack tokens in the
// AcknowledgeRequest. The Pub/Sub system can remove the relevant messages
// from the subscription.
//
// Acknowledging a message whose ack deadline has expired may succeed,
// but such a message may be redelivered later. Acknowledging a message more
// than once will not result in an error.
Acknowledge(context.Context, *AcknowledgeRequest) (*google_protobuf.Empty, error)
// Pulls messages from the server. Returns an empty list if there are no
// messages available in the backlog. The server may return UNAVAILABLE if
// there are too many concurrent pull requests pending for the given
// subscription.
Pull(context.Context, *PullRequest) (*PullResponse, error)
// Modifies the PushConfig for a specified subscription.
//
// This may be used to change a push subscription to a pull one (signified
// by an empty PushConfig) or vice versa, or change the endpoint URL and other
// attributes of a push subscription. Messages will accumulate for
// delivery continuously through the call regardless of changes to the
// PushConfig.
ModifyPushConfig(context.Context, *ModifyPushConfigRequest) (*google_protobuf.Empty, error)
}
type Subscription ¶
A subscription resource.
type Subscription struct {
// Name of the subscription.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The name of the topic from which this subscription is receiving messages.
// This will be present if and only if the subscription has not been detached
// from its topic.
Topic string `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
// If push delivery is used with this subscription, this field is
// used to configure it. An empty pushConfig signifies that the subscriber
// will pull and ack messages using API methods.
PushConfig *PushConfig `protobuf:"bytes,4,opt,name=push_config,json=pushConfig" json:"push_config,omitempty"`
// This value is the maximum time after a subscriber receives a message
// before the subscriber should acknowledge the message. After message
// delivery but before the ack deadline expires and before the message is
// acknowledged, it is an outstanding message and will not be delivered
// again during that time (on a best-effort basis).
//
// For pull delivery this value
// is used as the initial value for the ack deadline. It may be overridden
// for a specific message by calling ModifyAckDeadline.
//
// For push delivery, this value is also used to set the request timeout for
// the call to the push endpoint.
//
// If the subscriber never acknowledges the message, the Pub/Sub
// system will eventually redeliver the message.
AckDeadlineSeconds int32 `protobuf:"varint,5,opt,name=ack_deadline_seconds,json=ackDeadlineSeconds" json:"ack_deadline_seconds,omitempty"`
}
func (*Subscription) Descriptor ¶
func (*Subscription) Descriptor() ([]byte, []int)
func (*Subscription) GetAckDeadlineSeconds ¶
func (m *Subscription) GetAckDeadlineSeconds() int32
func (*Subscription) GetName ¶
func (m *Subscription) GetName() string
func (*Subscription) GetPushConfig ¶
func (m *Subscription) GetPushConfig() *PushConfig
func (*Subscription) GetTopic ¶
func (m *Subscription) GetTopic() string
func (*Subscription) ProtoMessage ¶
func (*Subscription) ProtoMessage()
func (*Subscription) Reset ¶
func (m *Subscription) Reset()
func (*Subscription) String ¶
func (m *Subscription) String() string
type Topic ¶
A topic resource.
type Topic struct {
// Name of the topic.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*Topic) Descriptor ¶
func (*Topic) Descriptor() ([]byte, []int)
func (*Topic) GetName ¶
func (m *Topic) GetName() string
func (*Topic) ProtoMessage ¶
func (*Topic) ProtoMessage()
func (*Topic) Reset ¶
func (m *Topic) Reset()
func (*Topic) String ¶
func (m *Topic) String() string