Package io.fabric8.openshift.api.model.machine.v1beta1

Class VSphereMachineProviderSpec

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<VSphereMachineProviderSpecBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, io.fabric8.kubernetes.api.model.Namespaced, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class VSphereMachineProviderSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<VSphereMachineProviderSpecBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.Namespaced
    VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        DNS_LABEL_END, DNS_LABEL_REGEXP, DNS_LABEL_START, FINALIZER_NAME_MATCHER, REQUIRES_NON_NULL_METADATA, REQUIRES_NON_NULL_NAME, REQUIRES_NON_NULL_NAMESPACE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      VSphereMachineProviderSpecBuilder edit()  
      Map<String,​Object> getAdditionalProperties()  
      String getApiVersion()
      APIVersion defines the versioned schema of this representation of an object.
      String getCloneMode()
      cloneMode specifies the type of clone operation.
      io.fabric8.kubernetes.api.model.LocalObjectReference getCredentialsSecret()
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      List<VSphereDisk> getDataDisks()
      dataDisks is a list of non OS disks to be created and attached to the VM.
      Integer getDiskGiB()
      diskGiB is the size of a virtual machine's disk, in GiB.
      String getKind()
      Kind is a string value representing the REST resource this object represents.
      Long getMemoryMiB()
      memoryMiB is the size of a virtual machine's memory, in MiB.
      io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      NetworkSpec getNetwork()
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      Integer getNumCoresPerSocket()
      NumCPUs is the number of cores among which to distribute CPUs in this virtual machine.
      Integer getNumCPUs()
      numCPUs is the number of virtual processors in a virtual machine.
      String getSnapshot()
      snapshot is the name of the snapshot from which the VM was cloned
      List<String> getTagIDs()
      tagIDs is an optional set of tags to add to an instance.
      String getTemplate()
      template is the name, inventory path, or instance UUID of the template used to clone new machines.
      io.fabric8.kubernetes.api.model.LocalObjectReference getUserDataSecret()
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      Workspace getWorkspace()
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      void setAdditionalProperties​(Map<String,​Object> additionalProperties)  
      void setAdditionalProperty​(String name, Object value)  
      void setApiVersion​(String apiVersion)
      APIVersion defines the versioned schema of this representation of an object.
      void setCloneMode​(String cloneMode)
      cloneMode specifies the type of clone operation.
      void setCredentialsSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference credentialsSecret)
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      void setDataDisks​(List<VSphereDisk> dataDisks)
      dataDisks is a list of non OS disks to be created and attached to the VM.
      void setDiskGiB​(Integer diskGiB)
      diskGiB is the size of a virtual machine's disk, in GiB.
      void setKind​(String kind)
      Kind is a string value representing the REST resource this object represents.
      void setMemoryMiB​(Long memoryMiB)
      memoryMiB is the size of a virtual machine's memory, in MiB.
      void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      void setNetwork​(NetworkSpec network)
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      void setNumCoresPerSocket​(Integer numCoresPerSocket)
      NumCPUs is the number of cores among which to distribute CPUs in this virtual machine.
      void setNumCPUs​(Integer numCPUs)
      numCPUs is the number of virtual processors in a virtual machine.
      void setSnapshot​(String snapshot)
      snapshot is the name of the snapshot from which the VM was cloned
      void setTagIDs​(List<String> tagIDs)
      tagIDs is an optional set of tags to add to an instance.
      void setTemplate​(String template)
      template is the name, inventory path, or instance UUID of the template used to clone new machines.
      void setUserDataSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference userDataSecret)
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      void setWorkspace​(Workspace workspace)
      VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine.
      VSphereMachineProviderSpecBuilder toBuilder()  

      • Methods inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        addFinalizer, addOwnerReference, addOwnerReference, getFinalizers, getFullResourceName, getOwnerReferenceFor, getOwnerReferenceFor, getPlural, getSingular, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, initNameAndNamespaceFrom, isFinalizerValid, isMarkedForDeletion, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference

    • Constructor Detail

      • VSphereMachineProviderSpec

        public VSphereMachineProviderSpec()
        No args constructor for use in serialization

      • VSphereMachineProviderSpec

        public VSphereMachineProviderSpec​(String apiVersion,
                                  String cloneMode,
                                  io.fabric8.kubernetes.api.model.LocalObjectReference credentialsSecret,
                                  List<VSphereDisk> dataDisks,
                                  Integer diskGiB,
                                  String kind,
                                  Long memoryMiB,
                                  io.fabric8.kubernetes.api.model.ObjectMeta metadata,
                                  NetworkSpec network,
                                  Integer numCPUs,
                                  Integer numCoresPerSocket,
                                  String snapshot,
                                  List<String> tagIDs,
                                  String template,
                                  io.fabric8.kubernetes.api.model.LocalObjectReference userDataSecret,
                                  Workspace workspace)

    • Method Detail

      • getApiVersion

        public String getApiVersion()
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getCloneMode

        public String getCloneMode()
        cloneMode specifies the type of clone operation. The LinkedClone mode is only support for templates that have at least one snapshot. If the template has no snapshots, then CloneMode defaults to FullClone. When LinkedClone mode is enabled the DiskGiB field is ignored as it is not possible to expand disks of linked clones. Defaults to FullClone. When using LinkedClone, if no snapshots exist for the source template, falls back to FullClone.

      • setCloneMode

        public void setCloneMode​(String cloneMode)
        cloneMode specifies the type of clone operation. The LinkedClone mode is only support for templates that have at least one snapshot. If the template has no snapshots, then CloneMode defaults to FullClone. When LinkedClone mode is enabled the DiskGiB field is ignored as it is not possible to expand disks of linked clones. Defaults to FullClone. When using LinkedClone, if no snapshots exist for the source template, falls back to FullClone.

      • getCredentialsSecret

        public io.fabric8.kubernetes.api.model.LocalObjectReference getCredentialsSecret()
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setCredentialsSecret

        public void setCredentialsSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference credentialsSecret)
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getDataDisks

        public List<VSphereDisk> getDataDisks()
        dataDisks is a list of non OS disks to be created and attached to the VM. The max number of disk allowed to be attached is currently 29. The max number of disks for any controller is 30, but VM template will always have OS disk so that will leave 29 disks on any controller type.

      • setDataDisks

        public void setDataDisks​(List<VSphereDisk> dataDisks)
        dataDisks is a list of non OS disks to be created and attached to the VM. The max number of disk allowed to be attached is currently 29. The max number of disks for any controller is 30, but VM template will always have OS disk so that will leave 29 disks on any controller type.

      • getDiskGiB

        public Integer getDiskGiB()
        diskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned. This parameter will be ignored if 'LinkedClone' CloneMode is set.

      • setDiskGiB

        public void setDiskGiB​(Integer diskGiB)
        diskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned. This parameter will be ignored if 'LinkedClone' CloneMode is set.

      • getKind

        public String getKind()
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        Specified by:
        getKind in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setKind

        public void setKind​(String kind)
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      • getMemoryMiB

        public Long getMemoryMiB()
        memoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.

      • setMemoryMiB

        public void setMemoryMiB​(Long memoryMiB)
        memoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.

      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
        Specified by:
        getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setMetadata

        public void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getNetwork

        public NetworkSpec getNetwork()
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setNetwork

        public void setNetwork​(NetworkSpec network)
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getNumCPUs

        public Integer getNumCPUs()
        numCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.

      • setNumCPUs

        public void setNumCPUs​(Integer numCPUs)
        numCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.

      • getNumCoresPerSocket

        public Integer getNumCoresPerSocket()
        NumCPUs is the number of cores among which to distribute CPUs in this virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.

      • setNumCoresPerSocket

        public void setNumCoresPerSocket​(Integer numCoresPerSocket)
        NumCPUs is the number of cores among which to distribute CPUs in this virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.

      • getSnapshot

        public String getSnapshot()
        snapshot is the name of the snapshot from which the VM was cloned

      • setSnapshot

        public void setSnapshot​(String snapshot)
        snapshot is the name of the snapshot from which the VM was cloned

      • getTagIDs

        public List<String> getTagIDs()
        tagIDs is an optional set of tags to add to an instance. Specified tagIDs must use URN-notation instead of display names. A maximum of 10 tag IDs may be specified.

      • setTagIDs

        public void setTagIDs​(List<String> tagIDs)
        tagIDs is an optional set of tags to add to an instance. Specified tagIDs must use URN-notation instead of display names. A maximum of 10 tag IDs may be specified.

      • getTemplate

        public String getTemplate()
        template is the name, inventory path, or instance UUID of the template used to clone new machines.

      • setTemplate

        public void setTemplate​(String template)
        template is the name, inventory path, or instance UUID of the template used to clone new machines.

      • getUserDataSecret

        public io.fabric8.kubernetes.api.model.LocalObjectReference getUserDataSecret()
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setUserDataSecret

        public void setUserDataSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference userDataSecret)
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getWorkspace

        public Workspace getWorkspace()
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setWorkspace

        public void setWorkspace​(Workspace workspace)
        VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)