sigs.k8s.io/cluster-api@v1.7.1/controllers/external/types.go (about)

     1  /*
     2  Copyright 2020 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package external
    18  
    19  import (
    20  	"time"
    21  
    22  	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
    23  )
    24  
    25  // ReconcileOutput is a return type of the external reconciliation
    26  // of referenced objects.
    27  type ReconcileOutput struct {
    28  	// RequeueAfter if greater than 0, tells the Controller to requeue the reconcile key after the Duration.
    29  	// Implies that Requeue is true, there is no need to set Requeue to true at the same time as RequeueAfter.
    30  	//
    31  	// TODO(vincepri): Remove this field here and try to return a better struct that embeds ctrl.Result,
    32  	// we can't do that today because the field would conflict with the current `Result` field,
    33  	// which should probably be renamed to `Object` or something similar.
    34  	RequeueAfter time.Duration
    35  	// Details of the referenced external object.
    36  	// +optional
    37  	Result *unstructured.Unstructured
    38  	// Indicates if the external object is paused.
    39  	// +optional
    40  	Paused bool
    41  }