@@ -39,8 +39,8 @@ const (
3939 // DefaultHostPort is the host:port which is used if not passed with options.
4040 DefaultHostPort = internal .LocalHostPort
4141
42- // DefaultDomainName is the domain name which is used if not passed with options.
43- DefaultDomainName = internal .DefaultDomainName
42+ // DefaultNamespace is the namespace name which is used if not passed with options.
43+ DefaultNamespace = internal .DefaultNamespace
4444
4545 // QueryTypeStackTrace is the build in query type for Client.QueryWorkflow() call. Use this query type to get the call
4646 // stack of the workflow. The result will be a string encoded in the encoded.Value.
9292 // or
9393 // ExecuteWorkflow(ctx, options, workflowExecuteFn, arg1, arg2, arg3)
9494 // The errors it can return:
95- // - EntityNotExistsError, if domain does not exists
95+ // - EntityNotExistsError, if namespace does not exists
9696 // - BadRequestError
9797 // - InternalServiceError
9898 //
@@ -144,7 +144,7 @@ type (
144144 // Note: options.WorkflowIDReusePolicy is default to WorkflowIDReusePolicyAllowDuplicate in this API;
145145 // while in StartWorkflow/ExecuteWorkflow APIs it is default to WorkflowIdReusePolicyAllowDuplicateFailedOnly.
146146 // The errors it can return:
147- // - EntityNotExistsError, if domain does not exist
147+ // - EntityNotExistsError, if namespace does not exist
148148 // - BadRequestError
149149 // - InternalServiceError
150150 SignalWithStartWorkflow (ctx context.Context , workflowID string , signalName string , signalArg interface {},
@@ -214,12 +214,12 @@ type (
214214 // completed event will be reported; if err is CanceledError, activity task cancelled event will be reported; otherwise,
215215 // activity task failed event will be reported.
216216 // An activity implementation should use activityID provided in ActivityOption to use for completion.
217- // domain name, workflowID, activityID are required, runID is optional.
217+ // namespace name, workflowID, activityID are required, runID is optional.
218218 // The errors it can return:
219219 // - ErrorWithDetails
220220 // - TimeoutError
221221 // - CanceledError
222- CompleteActivityByID (ctx context.Context , domain , workflowID , runID , activityID string , result interface {}, err error ) error
222+ CompleteActivityByID (ctx context.Context , namespace , workflowID , runID , activityID string , result interface {}, err error ) error
223223
224224 // RecordActivityHeartbeat records heartbeat for an activity.
225225 // taskToken - is the value of the binary "TaskToken" field of the "ActivityInfo" struct retrieved inside the activity.
@@ -234,7 +234,7 @@ type (
234234 // The errors it can return:
235235 // - EntityNotExistsError
236236 // - InternalServiceError
237- RecordActivityHeartbeatByID (ctx context.Context , domain , workflowID , runID , activityID string , details ... interface {}) error
237+ RecordActivityHeartbeatByID (ctx context.Context , namespace , workflowID , runID , activityID string , details ... interface {}) error
238238
239239 // ListClosedWorkflow gets closed workflow executions based on request filters.
240240 // Retrieved workflow executions are sorted by start time in descending order.
@@ -270,9 +270,9 @@ type (
270270 ListWorkflow (ctx context.Context , request * workflowservice.ListWorkflowExecutionsRequest ) (* workflowservice.ListWorkflowExecutionsResponse , error )
271271
272272 // ListArchivedWorkflow gets archived workflow executions based on query. This API will return BadRequest if Temporal
273- // cluster or target domain is not configured for visibility archival or read is not enabled. The query is basically the SQL WHERE clause.
273+ // cluster or target namespace is not configured for visibility archival or read is not enabled. The query is basically the SQL WHERE clause.
274274 // However, different visibility archivers have different limitations on the query. Please check the documentation of the visibility archiver used
275- // by your domain to see what kind of queries are accept and whether retrieved workflow executions are ordered or not.
275+ // by your namespace to see what kind of queries are accept and whether retrieved workflow executions are ordered or not.
276276 // The errors it can return:
277277 // - BadRequestError
278278 // - InternalServiceError
@@ -352,32 +352,32 @@ type (
352352 CloseConnection () error
353353 }
354354
355- // DomainClient is the client for managing operations on the domain .
356- // CLI, tools, ... can use this layer to manager operations on domain .
357- DomainClient interface {
358- // Register a domain with temporal server
355+ // NamespaceClient is the client for managing operations on the namespace .
356+ // CLI, tools, ... can use this layer to manager operations on namespace .
357+ NamespaceClient interface {
358+ // Register a namespace with temporal server
359359 // The errors it can throw:
360- // - DomainAlreadyExistsError
360+ // - NamespaceAlreadyExistsError
361361 // - BadRequestError
362362 // - InternalServiceError
363- Register (ctx context.Context , request * workflowservice.RegisterDomainRequest ) error
363+ Register (ctx context.Context , request * workflowservice.RegisterNamespaceRequest ) error
364364
365- // Describe a domain . The domain has 3 part of information
366- // DomainInfo - Which has Name, Status, Description, Owner Email
367- // DomainConfiguration - Configuration like Workflow Execution Retention Period In Days, Whether to emit metrics.
365+ // Describe a namespace . The namespace has 3 part of information
366+ // NamespaceInfo - Which has Name, Status, Description, Owner Email
367+ // NamespaceConfiguration - Configuration like Workflow Execution Retention Period In Days, Whether to emit metrics.
368368 // ReplicationConfiguration - replication config like clusters and active cluster name
369369 // The errors it can throw:
370370 // - EntityNotExistsError
371371 // - BadRequestError
372372 // - InternalServiceError
373- Describe (ctx context.Context , name string ) (* workflowservice.DescribeDomainResponse , error )
373+ Describe (ctx context.Context , name string ) (* workflowservice.DescribeNamespaceResponse , error )
374374
375- // Update a domain .
375+ // Update a namespace .
376376 // The errors it can throw:
377377 // - EntityNotExistsError
378378 // - BadRequestError
379379 // - InternalServiceError
380- Update (ctx context.Context , request * workflowservice.UpdateDomainRequest ) error
380+ Update (ctx context.Context , request * workflowservice.UpdateNamespaceRequest ) error
381381
382382 // CloseConnection closes underlying gRPC connection.
383383 CloseConnection () error
@@ -412,16 +412,16 @@ func NewClient(options Options) (Client, error) {
412412 return internal .NewClient (options )
413413}
414414
415- // NewDomainClient creates an instance of a domain client, to manage lifecycle of domains .
416- func NewDomainClient (options Options ) (DomainClient , error ) {
417- return internal .NewDomainClient (options )
415+ // NewNamespaceClient creates an instance of a namespace client, to manage lifecycle of namespaces .
416+ func NewNamespaceClient (options Options ) (NamespaceClient , error ) {
417+ return internal .NewNamespaceClient (options )
418418}
419419
420420// make sure if new methods are added to internal.Client they are also added to public Client.
421421var _ Client = internal .Client (nil )
422422var _ internal.Client = Client (nil )
423- var _ DomainClient = internal .DomainClient (nil )
424- var _ internal.DomainClient = DomainClient (nil )
423+ var _ NamespaceClient = internal .NamespaceClient (nil )
424+ var _ internal.NamespaceClient = NamespaceClient (nil )
425425
426426// NewValue creates a new encoded.Value which can be used to decode binary data returned by Temporal. For example:
427427// User had Activity.RecordHeartbeat(ctx, "my-heartbeat") and then got response from calling Client.DescribeWorkflowExecution.
0 commit comments