github.com/minio/mc@v0.0.0-20240503112107-b471de8d1882/cmd/batch-describe.go (about)

     1  // Copyright (c) 2015-2022 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package cmd
    19  
    20  import (
    21  	"context"
    22  	"fmt"
    23  
    24  	"github.com/minio/cli"
    25  	"github.com/minio/mc/pkg/probe"
    26  )
    27  
    28  var batchDescribeCmd = cli.Command{
    29  	Name:         "describe",
    30  	Usage:        "describe job definition for a job",
    31  	Action:       mainBatchDescribe,
    32  	OnUsageError: onUsageError,
    33  	Before:       setGlobalsFromContext,
    34  	Flags:        globalFlags,
    35  	CustomHelpTemplate: `NAME:
    36    {{.HelpName}} - {{.Usage}}
    37  
    38  USAGE:
    39    {{.HelpName}} TARGET JOBID
    40  
    41  FLAGS:
    42    {{range .VisibleFlags}}{{.}}
    43    {{end}}
    44  EXAMPLES:
    45    1. Describe current batch job definition:
    46       {{.Prompt}} {{.HelpName}} myminio KwSysDpxcBU9FNhGkn2dCf
    47  `,
    48  }
    49  
    50  // checkBatchDescribeSyntax - validate all the passed arguments
    51  func checkBatchDescribeSyntax(ctx *cli.Context) {
    52  	if len(ctx.Args()) != 2 {
    53  		showCommandHelpAndExit(ctx, 1) // last argument is exit code
    54  	}
    55  }
    56  
    57  // mainBatchDescribe is the handle for "mc batch create" command.
    58  func mainBatchDescribe(ctx *cli.Context) error {
    59  	checkBatchDescribeSyntax(ctx)
    60  
    61  	// Get the alias parameter from cli
    62  	args := ctx.Args()
    63  	aliasedURL := args.Get(0)
    64  	jobID := args.Get(1)
    65  
    66  	// Start a new MinIO Admin Client
    67  	adminClient, err := newAdminClient(aliasedURL)
    68  	fatalIf(err, "Unable to initialize admin connection.")
    69  
    70  	ctxt, cancel := context.WithCancel(globalContext)
    71  	defer cancel()
    72  
    73  	job, e := adminClient.DescribeBatchJob(ctxt, jobID)
    74  	fatalIf(probe.NewError(e), "Unable to fetch the job definition")
    75  
    76  	fmt.Println(job)
    77  	return nil
    78  }