Function NewUnblockCmd

pkg/cmd/crawler/unblock/unblock.go:31–81

NewUnblockCmd creates and returns a command to unblock a crawler.

(f *cmdutil.Factory, runF func(*UnblockOptions) error)

// NewUnblockCmd creates and returns a command to unblock a crawler.
func NewUnblockCmd(f *cmdutil.Factory, runF func(*UnblockOptions) error) *cobra.Command {
	opts := &UnblockOptions{
		IO:            f.IOStreams,
		Config:        f.Config,
		CrawlerClient: f.CrawlerClient,
		PrintFlags:    cmdutil.NewPrintFlags().WithDefaultOutput("json"),
	}

	var confirm bool

	cmd := &cobra.Command{
		Use:               "unblock <crawler_id>",
		Args:              cobra.ExactArgs(1),
		ValidArgsFunction: cmdutil.CrawlerIDs(opts.CrawlerClient),
		Short:             "Unblock a crawler",
		Long: heredoc.Doc(`
			Unblock a crawler by cancelling the specific task that is currently blocking it.
		`),
		Example: heredoc.Doc(`
			# Unblock the crawler with the ID "my-crawler"
			$ algolia crawler unblock my-crawler
		`),
		RunE: func(cmd *cobra.Command, args []string) error {
			opts.ID = args[0]
			if err := cmdutil.ValidateNoControlChars("crawler_id", opts.ID); err != nil {
				return err
			}
			if runF != nil {
				return runF(opts)
			}

			if !confirm && !opts.DryRun {
				if !opts.IO.CanPrompt() {
					return cmdutil.FlagErrorf(
						"--confirm required when non-interactive shell is detected",
					)
				}
				opts.DoConfirm = true
			}

			return runUnblockCmd(opts)
		},
	}

	cmd.Flags().
		BoolVarP(&confirm, "confirm", "y", false, "Skip the unblock crawler confirmation prompt")
	cmd.Flags().BoolVar(&opts.DryRun, "dry-run", false, "Validate and preview the unblock request without sending it")
	opts.PrintFlags.AddFlags(cmd)

	return cmd
}

// runUnblockCmd executes the unblock command.
func runUnblockCmd(opts *UnblockOptions) error {