Package k8s.io.api.core.v1

Class Generated.SecurityContext

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Generated.SecurityContextOrBuilder
    Enclosing class:
    Generated
    public static final class Generated.SecurityContext
extends com.google.protobuf.GeneratedMessageV3
implements Generated.SecurityContextOrBuilder
     SecurityContext holds security configuration that will be applied to a container.
 Some fields are present in both SecurityContext and PodSecurityContext.  When both
 are set, the values in SecurityContext take precedence.
    Protobuf type k8s.io.api.core.v1.SecurityContext
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasCapabilities

        public boolean hasCapabilities()
         The capabilities to add/drop when running containers.
 Defaults to the default set of capabilities granted by the container runtime.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.Capabilities capabilities = 1;
        Specified by:
        hasCapabilities in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the capabilities field is set.

      • getCapabilities

        public Generated.Capabilities getCapabilities()
         The capabilities to add/drop when running containers.
 Defaults to the default set of capabilities granted by the container runtime.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.Capabilities capabilities = 1;
        Specified by:
        getCapabilities in interface Generated.SecurityContextOrBuilder
        Returns:
        The capabilities.

      • getCapabilitiesOrBuilder

        public Generated.CapabilitiesOrBuilder getCapabilitiesOrBuilder()
         The capabilities to add/drop when running containers.
 Defaults to the default set of capabilities granted by the container runtime.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.Capabilities capabilities = 1;
        Specified by:
        getCapabilitiesOrBuilder in interface Generated.SecurityContextOrBuilder

      • hasPrivileged

        public boolean hasPrivileged()
         Run container in privileged mode.
 Processes in privileged containers are essentially equivalent to root on the host.
 Defaults to false.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional bool privileged = 2;
        Specified by:
        hasPrivileged in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the privileged field is set.

      • getPrivileged

        public boolean getPrivileged()
         Run container in privileged mode.
 Processes in privileged containers are essentially equivalent to root on the host.
 Defaults to false.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional bool privileged = 2;
        Specified by:
        getPrivileged in interface Generated.SecurityContextOrBuilder
        Returns:
        The privileged.

      • hasSeLinuxOptions

        public boolean hasSeLinuxOptions()
         The SELinux context to be applied to the container.
 If unspecified, the container runtime will allocate a random SELinux context for each
 container.  May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.SELinuxOptions seLinuxOptions = 3;
        Specified by:
        hasSeLinuxOptions in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the seLinuxOptions field is set.

      • getSeLinuxOptions

        public Generated.SELinuxOptions getSeLinuxOptions()
         The SELinux context to be applied to the container.
 If unspecified, the container runtime will allocate a random SELinux context for each
 container.  May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.SELinuxOptions seLinuxOptions = 3;
        Specified by:
        getSeLinuxOptions in interface Generated.SecurityContextOrBuilder
        Returns:
        The seLinuxOptions.

      • getSeLinuxOptionsOrBuilder

        public Generated.SELinuxOptionsOrBuilder getSeLinuxOptionsOrBuilder()
         The SELinux context to be applied to the container.
 If unspecified, the container runtime will allocate a random SELinux context for each
 container.  May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.SELinuxOptions seLinuxOptions = 3;
        Specified by:
        getSeLinuxOptionsOrBuilder in interface Generated.SecurityContextOrBuilder

      • hasWindowsOptions

        public boolean hasWindowsOptions()
         The Windows specific settings applied to all containers.
 If unspecified, the options from the PodSecurityContext will be used.
 If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is linux.
 +optional
        optional .k8s.io.api.core.v1.WindowsSecurityContextOptions windowsOptions = 10;
        Specified by:
        hasWindowsOptions in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the windowsOptions field is set.

      • getWindowsOptions

        public Generated.WindowsSecurityContextOptions getWindowsOptions()
         The Windows specific settings applied to all containers.
 If unspecified, the options from the PodSecurityContext will be used.
 If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is linux.
 +optional
        optional .k8s.io.api.core.v1.WindowsSecurityContextOptions windowsOptions = 10;
        Specified by:
        getWindowsOptions in interface Generated.SecurityContextOrBuilder
        Returns:
        The windowsOptions.

      • getWindowsOptionsOrBuilder

        public Generated.WindowsSecurityContextOptionsOrBuilder getWindowsOptionsOrBuilder()
         The Windows specific settings applied to all containers.
 If unspecified, the options from the PodSecurityContext will be used.
 If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is linux.
 +optional
        optional .k8s.io.api.core.v1.WindowsSecurityContextOptions windowsOptions = 10;
        Specified by:
        getWindowsOptionsOrBuilder in interface Generated.SecurityContextOrBuilder

      • hasRunAsUser

        public boolean hasRunAsUser()
         The UID to run the entrypoint of the container process.
 Defaults to user specified in image metadata if unspecified.
 May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional int64 runAsUser = 4;
        Specified by:
        hasRunAsUser in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the runAsUser field is set.

      • getRunAsUser

        public long getRunAsUser()
         The UID to run the entrypoint of the container process.
 Defaults to user specified in image metadata if unspecified.
 May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional int64 runAsUser = 4;
        Specified by:
        getRunAsUser in interface Generated.SecurityContextOrBuilder
        Returns:
        The runAsUser.

      • hasRunAsGroup

        public boolean hasRunAsGroup()
         The GID to run the entrypoint of the container process.
 Uses runtime default if unset.
 May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional int64 runAsGroup = 8;
        Specified by:
        hasRunAsGroup in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the runAsGroup field is set.

      • getRunAsGroup

        public long getRunAsGroup()
         The GID to run the entrypoint of the container process.
 Uses runtime default if unset.
 May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional int64 runAsGroup = 8;
        Specified by:
        getRunAsGroup in interface Generated.SecurityContextOrBuilder
        Returns:
        The runAsGroup.

      • hasRunAsNonRoot

        public boolean hasRunAsNonRoot()
         Indicates that the container must run as a non-root user.
 If true, the Kubelet will validate the image at runtime to ensure that it
 does not run as UID 0 (root) and fail to start the container if it does.
 If unset or false, no such validation will be performed.
 May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 +optional
        optional bool runAsNonRoot = 5;
        Specified by:
        hasRunAsNonRoot in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the runAsNonRoot field is set.

      • getRunAsNonRoot

        public boolean getRunAsNonRoot()
         Indicates that the container must run as a non-root user.
 If true, the Kubelet will validate the image at runtime to ensure that it
 does not run as UID 0 (root) and fail to start the container if it does.
 If unset or false, no such validation will be performed.
 May also be set in PodSecurityContext.  If set in both SecurityContext and
 PodSecurityContext, the value specified in SecurityContext takes precedence.
 +optional
        optional bool runAsNonRoot = 5;
        Specified by:
        getRunAsNonRoot in interface Generated.SecurityContextOrBuilder
        Returns:
        The runAsNonRoot.

      • hasReadOnlyRootFilesystem

        public boolean hasReadOnlyRootFilesystem()
         Whether this container has a read-only root filesystem.
 Default is false.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional bool readOnlyRootFilesystem = 6;
        Specified by:
        hasReadOnlyRootFilesystem in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the readOnlyRootFilesystem field is set.

      • getReadOnlyRootFilesystem

        public boolean getReadOnlyRootFilesystem()
         Whether this container has a read-only root filesystem.
 Default is false.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional bool readOnlyRootFilesystem = 6;
        Specified by:
        getReadOnlyRootFilesystem in interface Generated.SecurityContextOrBuilder
        Returns:
        The readOnlyRootFilesystem.

      • hasAllowPrivilegeEscalation

        public boolean hasAllowPrivilegeEscalation()
         AllowPrivilegeEscalation controls whether a process can gain more
 privileges than its parent process. This bool directly controls if
 the no_new_privs flag will be set on the container process.
 AllowPrivilegeEscalation is true always when the container is:
 1) run as Privileged
 2) has CAP_SYS_ADMIN
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional bool allowPrivilegeEscalation = 7;
        Specified by:
        hasAllowPrivilegeEscalation in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the allowPrivilegeEscalation field is set.

      • getAllowPrivilegeEscalation

        public boolean getAllowPrivilegeEscalation()
         AllowPrivilegeEscalation controls whether a process can gain more
 privileges than its parent process. This bool directly controls if
 the no_new_privs flag will be set on the container process.
 AllowPrivilegeEscalation is true always when the container is:
 1) run as Privileged
 2) has CAP_SYS_ADMIN
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional bool allowPrivilegeEscalation = 7;
        Specified by:
        getAllowPrivilegeEscalation in interface Generated.SecurityContextOrBuilder
        Returns:
        The allowPrivilegeEscalation.

      • hasProcMount

        public boolean hasProcMount()
         procMount denotes the type of proc mount to use for the containers.
 The default value is Default which uses the container runtime defaults for
 readonly paths and masked paths.
 This requires the ProcMountType feature flag to be enabled.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional string procMount = 9;
        Specified by:
        hasProcMount in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the procMount field is set.

      • getProcMount

        public String getProcMount()
         procMount denotes the type of proc mount to use for the containers.
 The default value is Default which uses the container runtime defaults for
 readonly paths and masked paths.
 This requires the ProcMountType feature flag to be enabled.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional string procMount = 9;
        Specified by:
        getProcMount in interface Generated.SecurityContextOrBuilder
        Returns:
        The procMount.

      • getProcMountBytes

        public com.google.protobuf.ByteString getProcMountBytes()
         procMount denotes the type of proc mount to use for the containers.
 The default value is Default which uses the container runtime defaults for
 readonly paths and masked paths.
 This requires the ProcMountType feature flag to be enabled.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional string procMount = 9;
        Specified by:
        getProcMountBytes in interface Generated.SecurityContextOrBuilder
        Returns:
        The bytes for procMount.

      • hasSeccompProfile

        public boolean hasSeccompProfile()
         The seccomp options to use by this container. If seccomp options are
 provided at both the pod & container level, the container options
 override the pod options.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.SeccompProfile seccompProfile = 11;
        Specified by:
        hasSeccompProfile in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the seccompProfile field is set.

      • getSeccompProfile

        public Generated.SeccompProfile getSeccompProfile()
         The seccomp options to use by this container. If seccomp options are
 provided at both the pod & container level, the container options
 override the pod options.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.SeccompProfile seccompProfile = 11;
        Specified by:
        getSeccompProfile in interface Generated.SecurityContextOrBuilder
        Returns:
        The seccompProfile.

      • getSeccompProfileOrBuilder

        public Generated.SeccompProfileOrBuilder getSeccompProfileOrBuilder()
         The seccomp options to use by this container. If seccomp options are
 provided at both the pod & container level, the container options
 override the pod options.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.SeccompProfile seccompProfile = 11;
        Specified by:
        getSeccompProfileOrBuilder in interface Generated.SecurityContextOrBuilder

      • hasAppArmorProfile

        public boolean hasAppArmorProfile()
         appArmorProfile is the AppArmor options to use by this container. If set, this profile
 overrides the pod's appArmorProfile.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.AppArmorProfile appArmorProfile = 12;
        Specified by:
        hasAppArmorProfile in interface Generated.SecurityContextOrBuilder
        Returns:
        Whether the appArmorProfile field is set.

      • getAppArmorProfile

        public Generated.AppArmorProfile getAppArmorProfile()
         appArmorProfile is the AppArmor options to use by this container. If set, this profile
 overrides the pod's appArmorProfile.
 Note that this field cannot be set when spec.os.name is windows.
 +optional
        optional .k8s.io.api.core.v1.AppArmorProfile appArmorProfile = 12;
        Specified by:
        getAppArmorProfile in interface Generated.SecurityContextOrBuilder
        Returns:
        The appArmorProfile.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Generated.SecurityContext parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.SecurityContext parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.SecurityContext parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.SecurityContext parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.SecurityContext parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.SecurityContext parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public Generated.SecurityContext.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Generated.SecurityContext.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Generated.SecurityContext.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Generated.SecurityContext> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Generated.SecurityContext getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder