Domain Types

type DomainInfo struct {
    Name        string
    Status      *DomainStatus
    Description string
    OwnerEmail  string
    Data        map[string]string
    UUID        string
}

type DomainConfiguration struct {
    WorkflowExecutionRetentionPeriodInDays int32
    EmitMetric                             bool
    BadBinaries                            *BadBinaries
    HistoryArchivalStatus                  *ArchivalStatus
    HistoryArchivalURI                     string
    VisibilityArchivalStatus               *ArchivalStatus
    VisibilityArchivalURI                  string
    IsolationGroups                        *IsolationGroupConfiguration
    AsyncWorkflowConfig                    *AsyncWorkflowConfiguration
}

type DomainReplicationConfiguration struct {
    ActiveClusterName string
    Clusters          []*ClusterReplicationConfiguration
}

type ClusterReplicationConfiguration struct {
    ClusterName string
}

{
  "activeClusterName": "us-east-1",
  "clusters": [
    {"clusterName": "us-east-1"},
    {"clusterName": "us-west-2"},
    {"clusterName": "eu-west-1"}
  ]
}

type DomainStatus int32

const (
    DomainStatusRegistered DomainStatus = iota
    DomainStatusDeprecated
    DomainStatusDeleted
)

type RegisterDomainRequest struct {
    Name                                   string
    Description                            string
    OwnerEmail                             string
    WorkflowExecutionRetentionPeriodInDays int32
    EmitMetric                             *bool
    Clusters                               []*ClusterReplicationConfiguration
    ActiveClusterName                      string
    Data                                   map[string]string
    SecurityToken                          string
    IsGlobalDomain                         bool
    HistoryArchivalStatus                  *ArchivalStatus
    HistoryArchivalURI                     string
    VisibilityArchivalStatus               *ArchivalStatus
    VisibilityArchivalURI                  string
}

{
  "name": "production-orders",
  "description": "Production order processing workflows",
  "ownerEmail": "[email protected]",
  "workflowExecutionRetentionPeriodInDays": 7,
  "emitMetric": true,
  "historyArchivalStatus": "ENABLED",
  "historyArchivalURI": "s3://cadence-archives/production-orders/history"
}

type DescribeDomainRequest struct {
    Name *string
    UUID *string
}

type DescribeDomainResponse struct {
    DomainInfo               *DomainInfo
    Configuration            *DomainConfiguration
    ReplicationConfiguration *DomainReplicationConfiguration
    FailoverVersion          int64
    IsGlobalDomain           bool
}

type UpdateDomainRequest struct {
    Name                                   string
    Description                            *string
    OwnerEmail                             *string
    Data                                   map[string]string
    WorkflowExecutionRetentionPeriodInDays *int32
    EmitMetric                             *bool
    BadBinaries                            *BadBinaries
    HistoryArchivalStatus                  *ArchivalStatus
    HistoryArchivalURI                     *string
    VisibilityArchivalStatus               *ArchivalStatus
    VisibilityArchivalURI                  *string
    ActiveClusterName                      *string
    Clusters                               []*ClusterReplicationConfiguration
    SecurityToken                          string
    DeleteBadBinary                        *string
    FailoverTimeoutInSeconds               *int32
}

type UpdateDomainResponse struct {
    DomainInfo               *DomainInfo
    Configuration            *DomainConfiguration
    ReplicationConfiguration *DomainReplicationConfiguration
    FailoverVersion          int64
    IsGlobalDomain           bool
}

type DeprecateDomainRequest struct {
    Name          string
    SecurityToken string
}

type DeleteDomainRequest struct {
    Name string
}

type ListDomainsRequest struct {
    PageSize      int32
    NextPageToken []byte
}

type ListDomainsResponse struct {
    Domains       []*DescribeDomainResponse
    NextPageToken []byte
}

type FailoverDomainRequest struct {
    Name                     string
    ActiveClusterName        string
    FailoverTimeoutInSeconds *int32
}

type FailoverDomainResponse struct {
    DomainInfo               *DomainInfo
    Configuration            *DomainConfiguration
    ReplicationConfiguration *DomainReplicationConfiguration
    FailoverVersion          int64
    IsGlobalDomain           bool
}

type ListFailoverHistoryRequest struct {
    Domain string
}

type ListFailoverHistoryResponse struct {
    History []*FailoverEvent
}

type FailoverEvent struct {
    FailoverVersion    int64
    Timestamp          *int64
    SourceCluster      string
    TargetCluster      string
    FailoverType       string
}

type BadBinaries struct {
    Binaries map[string]*BadBinaryInfo
}

type BadBinaryInfo struct {
    Reason          string
    Operator        string
    CreatedTimeNano *int64
}

{
  "binaries": {
    "abc123def456": {
      "reason": "Causes data corruption in OrderWorkflow",
      "operator": "[email protected]",
      "createdTimeNano": 1704124800000000000
    }
  }
}

type ArchivalStatus int32

const (
    ArchivalStatusDisabled ArchivalStatus = iota
    ArchivalStatusEnabled
)

type IsolationGroupConfiguration struct {
    IsolationGroups []*IsolationGroupPartition
}

type IsolationGroupPartition struct {
    Name  string
    State *IsolationGroupState
}

type AsyncWorkflowConfiguration struct {
    Enabled                bool
    PredefinedQueueName    string
    QueueType              string
    QueueConfig            *DataBlob
}

type DomainAlreadyExistsError struct {
    Message string
}

type DomainNotActiveError struct {
    Message        string
    DomainName     string
    CurrentCluster string
    ActiveCluster  string
}

type EntityNotExistsError struct {
    Message        string
    CurrentCluster string
    ActiveCluster  string
}