publisher.proto

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
// SPDX-License-Identifier: MIT

// Publisher Callback Service definition
//
// The prototype definitions for a Publisher utilizing the Pub Sub Service.

syntax = "proto3";
package publisher;

// The service that a publisher implements to provide necessary functionality
// for communication from the Pub Sub Service.
service PublisherCallback {
    // Method used by the Pub Sub Service to provide the publisher with topic
    // information so the publisher can make informed choices with topic
    // management.
    rpc ManageTopicCallback (ManageTopicRequest) returns (ManageTopicResponse);
}

// Representation of a request that provides context for a publisher to manage
// a specified topic.
message ManageTopicRequest {
    // The name of the dynamically generated topic.
    string topic = 1;

    // Context informing publisher of actions to take on a topic.
    string action = 2;
}

// Empty object indicating a successfull call of `ManageTopicCallback`.
message ManageTopicResponse { }