EnterpriseSearchPlanInfo

edit

`EnterpriseSearchPlanInfo`

edit

Information about the Enterprise Search Server plan.

Properties

edit

attempt_end_time (string as date-time): If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
attempt_start_time (string as date-time): When this plan attempt (ie to apply the plan to the Enterprise Search) started (ISO format in UTC)
error (ClusterPlanAttemptError): Information about an error during a plan attempt.
healthy (boolean, required): Either the plan ended successfully, or is not yet completed (and no errors have occurred)
plan (EnterpriseSearchPlan): The plan for the Enterprise Search cluster.
plan_attempt_id (string): A UUID for each plan attempt
plan_attempt_log (array[ClusterPlanStepInfo], required)
plan_attempt_name (string): A human readable name for each plan attempt, only populated when retrieving plan histories
plan_end_time (string as date-time): If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
source (ChangeSourceInfo): Information describing the source that facilitated the plans current state
warnings (array[ClusterPlanWarning], required)

Example

edit

{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "error" : {
      "details" : {
         "some_property" : "string"
      },
      "failure_type" : "string",
      "message" : "string",
      "timestamp" : "2019-01-01T00:00:00Z"
   },
   "healthy" : true,
   "plan" : {
      "cluster_topology" : [
         {
            "allocator_filter" : {},
            "enterprise_search" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "secret_session_key" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "instance_configuration_id" : "string",
            "instance_configuration_version" : 0,
            "memory_per_node" : {},
            "node_configuration" : "string",
            "node_count_per_zone" : {},
            "node_type" : {
               "appserver" : true,
               "connector" : true,
               "worker" : true
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "enterprise_search" : {
         "docker_image" : "string",
         "system_settings" : {
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "secret_session_key" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "move_allocators" : [
               {
                  "allocator_down" : true,
                  "from" : "string",
                  "to" : [
                     "string"
                  ]
               }
            ],
            "move_instances" : [
               {
                  "from" : "string",
                  "instance_down" : true,
                  "to" : [
                     "string"
                  ]
               }
            ],
            "override_failsafe" : true,
            "preferred_allocator_tags" : {
               "some_property" : "string"
            },
            "preferred_allocators" : [
               "string"
            ],
            "reallocate_instances" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "plan_attempt_id" : "string",
   "plan_attempt_log" : [
      {
         "completed" : "2019-01-01T00:00:00Z",
         "duration_in_millis" : 0,
         "info_log" : [
            {
               "delta_in_millis" : 0,
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "internal_details" : {
                  "some_property" : "string"
               },
               "message" : "string",
               "stage" : "string",
               "timestamp" : "2019-01-01T00:00:00Z"
            }
         ],
         "stage" : "string",
         "started" : "2019-01-01T00:00:00Z",
         "status" : "string",
         "step_id" : "string"
      }
   ],
   "plan_attempt_name" : "string",
   "plan_end_time" : "2019-01-01T00:00:00Z",
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   },
   "warnings" : [
      {
         "code" : "string",
         "message" : "string",
         "step_id" : "string"
      }
   ]
}

« EnterpriseSearchPlanControlConfiguration EnterpriseSearchPlansInfo »