Documentation
    Preparing search index...

    Variable INFRA_CONVENTIONSConst Constant

    INFRA_CONVENTIONS: {
        infra: {
            jobManagement: {
                jobId: "mapcolonies.infra.job_management.job_id";
                jobType: "mapcolonies.infra.job_management.job_type";
                serviceUrl: "mapcolonies.infra.job_management.service_url";
                taskId: "mapcolonies.infra.job_management.task_id";
                taskType: "mapcolonies.infra.job_management.task_type";
            };
            jobnik: {
                job: {
                    name: "mapcolonies.infra.jobnik.job.name";
                    priority: "mapcolonies.infra.jobnik.job.priority";
                    status: "mapcolonies.infra.jobnik.job.status";
                };
                stage: {
                    id: "mapcolonies.infra.jobnik.stage.id";
                    status: "mapcolonies.infra.jobnik.stage.status";
                };
                task: {
                    attempts: "mapcolonies.infra.jobnik.task.attempts";
                    status: "mapcolonies.infra.jobnik.task.status";
                };
            };
        };
    } = ...

    name of the domain in use

    Type Declaration

    • Readonlyinfra: {
          jobManagement: {
              jobId: "mapcolonies.infra.job_management.job_id";
              jobType: "mapcolonies.infra.job_management.job_type";
              serviceUrl: "mapcolonies.infra.job_management.service_url";
              taskId: "mapcolonies.infra.job_management.task_id";
              taskType: "mapcolonies.infra.job_management.task_type";
          };
          jobnik: {
              job: {
                  name: "mapcolonies.infra.jobnik.job.name";
                  priority: "mapcolonies.infra.jobnik.job.priority";
                  status: "mapcolonies.infra.jobnik.job.status";
              };
              stage: {
                  id: "mapcolonies.infra.jobnik.stage.id";
                  status: "mapcolonies.infra.jobnik.stage.status";
              };
              task: {
                  attempts: "mapcolonies.infra.jobnik.task.attempts";
                  status: "mapcolonies.infra.jobnik.task.status";
              };
          };
      }
      • ReadonlyjobManagement: {
            jobId: "mapcolonies.infra.job_management.job_id";
            jobType: "mapcolonies.infra.job_management.job_type";
            serviceUrl: "mapcolonies.infra.job_management.service_url";
            taskId: "mapcolonies.infra.job_management.task_id";
            taskType: "mapcolonies.infra.job_management.task_type";
        }
        • Readonly ConstantjobId: "mapcolonies.infra.job_management.job_id"

          Type of task as stored on db (uuid)

        • Readonly ConstantjobType: "mapcolonies.infra.job_management.job_type"

          Type of job as stored on db (uuid)

        • Readonly ConstantserviceUrl: "mapcolonies.infra.job_management.service_url"

          API url of job management service

        • Readonly ConstanttaskId: "mapcolonies.infra.job_management.task_id"

          Type of task as stored on db (uuid)

        • Readonly ConstanttaskType: "mapcolonies.infra.job_management.task_type"

          Type of task as stored on db (uuid)

      • Readonlyjobnik: {
            job: {
                name: "mapcolonies.infra.jobnik.job.name";
                priority: "mapcolonies.infra.jobnik.job.priority";
                status: "mapcolonies.infra.jobnik.job.status";
            };
            stage: {
                id: "mapcolonies.infra.jobnik.stage.id";
                status: "mapcolonies.infra.jobnik.stage.status";
            };
            task: {
                attempts: "mapcolonies.infra.jobnik.task.attempts";
                status: "mapcolonies.infra.jobnik.task.status";
            };
        }
        • Readonlyjob: {
              name: "mapcolonies.infra.jobnik.job.name";
              priority: "mapcolonies.infra.jobnik.job.priority";
              status: "mapcolonies.infra.jobnik.job.status";
          }
          • Readonly Constantname: "mapcolonies.infra.jobnik.job.name"

            The human-readable name of the job

          • Readonly Constantpriority: "mapcolonies.infra.jobnik.job.priority"

            The priority of the job (e.g., HIGH)

          • Readonly Constantstatus: "mapcolonies.infra.jobnik.job.status"

            The status being set (e.g., COMPLETED). For update_status spans

        • Readonlystage: {
              id: "mapcolonies.infra.jobnik.stage.id";
              status: "mapcolonies.infra.jobnik.stage.status";
          }
          • Readonly Constantid: "mapcolonies.infra.jobnik.stage.id"

            The UUID of the stage.

          • Readonly Constantstatus: "mapcolonies.infra.jobnik.stage.status"

            The status being set (e.g., COMPLETED). For update_status spans

        • Readonlytask: {
              attempts: "mapcolonies.infra.jobnik.task.attempts";
              status: "mapcolonies.infra.jobnik.task.status";
          }
          • Readonly Constantattempts: "mapcolonies.infra.jobnik.task.attempts"

            The number of times this task has been attempted. This is used to track retries in the job management system.

          • Readonly Constantstatus: "mapcolonies.infra.jobnik.task.status"

            The status being set (e.g., COMPLETED). For update_status spans