github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdcv2/metadata/errors.go (about)

     1  // Copyright 2023 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package metadata
    15  
    16  import "fmt"
    17  
    18  // ScheduleError is for role state transformation.
    19  type ScheduleError struct {
    20  	Msg string
    21  }
    22  
    23  // Error implements error interface.
    24  func (e ScheduleError) Error() string {
    25  	return e.Msg
    26  }
    27  
    28  // NewScheduleError creates an error.
    29  func NewScheduleError(msg string) ScheduleError {
    30  	return ScheduleError{Msg: msg}
    31  }
    32  
    33  // NewBadScheduleError creates a schedule error with detail information.
    34  func NewBadScheduleError(origin ScheduledChangefeed, target ScheduledChangefeed) ScheduleError {
    35  	msg := fmt.Sprintf("bad schedule for %d: A.%s->B.%s",
    36  		origin.ChangefeedUUID, origin.OwnerState.String(), target.OwnerState.String())
    37  	return NewScheduleError(msg)
    38  }