resource.go

Documentation: k8s.io/api/core/v1

     1  /*
     2  Copyright 2017 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 v1
    18  
    19  import (
    20  	"k8s.io/apimachinery/pkg/api/resource"
    21  )
    22  
    23  // Returns string version of ResourceName.
    24  func (rn ResourceName) String() string {
    25  	return string(rn)
    26  }
    27  
    28  // Cpu returns the Cpu limit if specified.
    29  func (rl *ResourceList) Cpu() *resource.Quantity {
    30  	return rl.Name(ResourceCPU, resource.DecimalSI)
    31  }
    32  
    33  // Memory returns the Memory limit if specified.
    34  func (rl *ResourceList) Memory() *resource.Quantity {
    35  	return rl.Name(ResourceMemory, resource.BinarySI)
    36  }
    37  
    38  // Storage returns the Storage limit if specified.
    39  func (rl *ResourceList) Storage() *resource.Quantity {
    40  	return rl.Name(ResourceStorage, resource.BinarySI)
    41  }
    42  
    43  // Pods returns the list of pods
    44  func (rl *ResourceList) Pods() *resource.Quantity {
    45  	return rl.Name(ResourcePods, resource.DecimalSI)
    46  }
    47  
    48  // StorageEphemeral returns the list of ephemeral storage volumes, if any
    49  func (rl *ResourceList) StorageEphemeral() *resource.Quantity {
    50  	return rl.Name(ResourceEphemeralStorage, resource.BinarySI)
    51  }
    52  
    53  // Name returns the resource with name if specified, otherwise it returns a nil quantity with default format.
    54  func (rl *ResourceList) Name(name ResourceName, defaultFormat resource.Format) *resource.Quantity {
    55  	if val, ok := (*rl)[name]; ok {
    56  		return &val
    57  	}
    58  	return &resource.Quantity{Format: defaultFormat}
    59  }
    60
View as plain text