Package io.fabric8.openshift.api.model

Class ClusterRoleBinding

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<ClusterRoleBindingBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ClusterRoleBinding
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ClusterRoleBindingBuilder>, io.fabric8.kubernetes.api.model.HasMetadata
    ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).


    Compatibility level 1: Stable within a major release for a minimum of 12 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

    • Constructor Summary

      Constructors 
      Constructor Description
      ClusterRoleBinding()
      No args constructor for use in serialization
      ClusterRoleBinding​(String apiVersion, List<String> groupNames, String kind, io.fabric8.kubernetes.api.model.ObjectMeta metadata, io.fabric8.kubernetes.api.model.ObjectReference roleRef, List<io.fabric8.kubernetes.api.model.ObjectReference> subjects, List<String> userNames)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ClusterRoleBindingBuilder edit()  
      Map<String,​Object> getAdditionalProperties()  
      String getApiVersion()
      APIVersion defines the versioned schema of this representation of an object.
      List<String> getGroupNames()
      groupNames holds all the groups directly bound to the role.
      String getKind()
      Kind is a string value representing the REST resource this object represents.
      io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
      ClusterRoleBinding references a ClusterRole, but not contain it.
      io.fabric8.kubernetes.api.model.ObjectReference getRoleRef()
      ClusterRoleBinding references a ClusterRole, but not contain it.
      List<io.fabric8.kubernetes.api.model.ObjectReference> getSubjects()
      subjects hold object references to authorize with this rule.
      List<String> getUserNames()
      userNames holds all the usernames directly bound to the role.
      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 setGroupNames​(List<String> groupNames)
      groupNames holds all the groups directly bound to the role.
      void setKind​(String kind)
      Kind is a string value representing the REST resource this object represents.
      void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
      ClusterRoleBinding references a ClusterRole, but not contain it.
      void setRoleRef​(io.fabric8.kubernetes.api.model.ObjectReference roleRef)
      ClusterRoleBinding references a ClusterRole, but not contain it.
      void setSubjects​(List<io.fabric8.kubernetes.api.model.ObjectReference> subjects)
      subjects hold object references to authorize with this rule.
      void setUserNames​(List<String> userNames)
      userNames holds all the usernames directly bound to the role.
      ClusterRoleBindingBuilder 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

      • ClusterRoleBinding

        public ClusterRoleBinding()
        No args constructor for use in serialization

      • ClusterRoleBinding

        public ClusterRoleBinding​(String apiVersion,
                          List<String> groupNames,
                          String kind,
                          io.fabric8.kubernetes.api.model.ObjectMeta metadata,
                          io.fabric8.kubernetes.api.model.ObjectReference roleRef,
                          List<io.fabric8.kubernetes.api.model.ObjectReference> subjects,
                          List<String> userNames)

    • 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

      • getGroupNames

        public List<String> getGroupNames()
        groupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

      • setGroupNames

        public void setGroupNames​(List<String> groupNames)
        groupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

      • 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

      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).


        Compatibility level 1: Stable within a major release for a minimum of 12 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)
        ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getRoleRef

        public io.fabric8.kubernetes.api.model.ObjectReference getRoleRef()
        ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

      • setRoleRef

        public void setRoleRef​(io.fabric8.kubernetes.api.model.ObjectReference roleRef)
        ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

      • getSubjects

        public List<io.fabric8.kubernetes.api.model.ObjectReference> getSubjects()
        subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.

      • setSubjects

        public void setSubjects​(List<io.fabric8.kubernetes.api.model.ObjectReference> subjects)
        subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.

      • getUserNames

        public List<String> getUserNames()
        userNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

      • setUserNames

        public void setUserNames​(List<String> userNames)
        userNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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