Skip to main content

Service

Service options apply to all Temporal resources defined within an individual protobuf service.

example.proto
syntax="proto3";

package example.v1;

import "temporal/v1/temporal.proto";

service Example {
  option (temporal.v1.service) = {
    task_queue: "example-v1"
  };
}

Options​

cli.aliases​

[]string

Adds additional aliases to the CLI command.

service Example {
  option (temporal.v1.cli) = {
    aliases: ["e"]
  };
}

cli.ignore​

bool

Prevents the generation of CLI command.

service Example {
  option (temporal.v1.cli) = {ignore: true};
}

cli.name​

string

Overrides the default CLI command name.

service Example {
  option (temporal.v1.cli) = {name: "start-example"};
}

cli.usage​

string

Overrides the default CLI command usage.

service Example {
  option (temporal.v1.cli) = {usage: "generate a friendly greeting"};
}

patches​

[]temporal.v1.Patch

Controls how a particular Patch is implemented in generated code, overriding any plugin-level configuration for all resources of the service.

service Example {
  option (temporal.v1.service) = {
    patches: [
      { version: PV_62, mode: PV_REMOVED },
      { version: PV_63, mode: PV_MARKER },
      { version: PV_64, mode: PV_ENABLED },
      { version: PV_65, mode: PV_DISABLED }
    ]
  };
}

task_queue​

string

Specifies the default Task Queue name.

service Example {
  option (temporal.v1.service) = {
    task_queue: 'example-v1'
  };
}