api

Documentation

Index

• Constants
• func MethodName(fullApiName string) string
• func ServiceName(fullApiName string) string
• type Access
• type MethodMetadata
  • func GetMethodMetadata(fullApiName string) MethodMetadata
• type Scope

Constants

const (
	WorkflowServicePrefix = "/temporal.api.workflowservice.v1.WorkflowService/"
	OperatorServicePrefix = "/temporal.api.operatorservice.v1.OperatorService/"
	HistoryServicePrefix  = "/temporal.server.api.historyservice.v1.HistoryService/"
	AdminServicePrefix    = "/temporal.server.api.adminservice.v1.AdminService/"
	// Technically not a gRPC service, but still using this format for metadata.
	NexusServicePrefix = "/temporal.api.nexusservice.v1.NexusService/"
)

Functions

func MethodName

func MethodName(fullApiName string) string

MethodName returns just the method name from a fully qualified name.

func ServiceName

func ServiceName(fullApiName string) string

Types

type Access

type Access int32

Describes what level of access is needed for a method. Note that this field is completely advisory. Any authorizer implementation may implement whatever logic it chooses, including ignoring this field. It is used by the "default" authorizer to check against roles in claims.

const (
	// Represents a missing Access value.
	AccessUnknown Access = iota
	// Method is read-only and should be accessible to readers.
	AccessReadOnly
	// Method is a normal write method.
	AccessWrite
	// Method is an administrative operation.
	AccessAdmin
)

type MethodMetadata

type MethodMetadata struct {
	// Describes the scope of a method (whole cluster or inividual namespace).
	Scope Scope
	// Describes what level of access is needed for a method (advisory).
	Access Access
}

func GetMethodMetadata

func GetMethodMetadata(fullApiName string) MethodMetadata

GetMethodMetadata gets metadata for a given API method in one of the services exported by frontend (WorkflowService, OperatorService, AdminService).

type Scope

type Scope int32

Describes the scope of a method (whole cluster or inividual namespace).

const (
	// Represents a missing Scope value.
	ScopeUnknown Scope = iota
	// Method affects a single namespace. The request message must contain a string field named "Namespace".
	ScopeNamespace
	// Method affects the whole cluster. The request message must _not_ contain any field named "Namespace".
	ScopeCluster
)