Package flyteidl.core

Class Security.Secret

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Security.SecretOrBuilder, Serializable
    Enclosing class:
    Security
    public static final class Security.Secret
extends com.google.protobuf.GeneratedMessageV3
implements Security.SecretOrBuilder
     Secret encapsulates information about the secret a task needs to proceed. An environment variable
 FLYTE_SECRETS_ENV_PREFIX will be passed to indicate the prefix of the environment variables that will be present if
 secrets are passed through environment variables.
 FLYTE_SECRETS_DEFAULT_DIR will be passed to indicate the prefix of the path where secrets will be mounted if secrets
 are passed through file mounts.
    Protobuf type flyteidl.core.Secret
    See Also:
    Serialized Form

    • Field Detail

      • group_

        private volatile Object group_

      • GROUP_VERSION_FIELD_NUMBER

        public static final int GROUP_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • groupVersion_

        private volatile Object groupVersion_

      • key_

        private volatile Object key_

      • MOUNT_REQUIREMENT_FIELD_NUMBER

        public static final int MOUNT_REQUIREMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • mountRequirement_

        private int mountRequirement_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • PARSER

        private static final com.google.protobuf.Parser<Security.Secret> PARSER

    • Constructor Detail

      • Secret

        private Secret​(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

      • Secret

        private Secret()

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getGroup

        public String getGroup()
         The name of the secret group where to find the key referenced below. For K8s secrets, this should be the name of
 the v1/secret object. For Confidant, this should be the Credential name. For Vault, this should be the secret name.
 For AWS Secret Manager, this should be the name of the secret.
 +required
        string group = 1;
        Specified by:
        getGroup in interface Security.SecretOrBuilder
        Returns:
        The group.

      • getGroupBytes

        public com.google.protobuf.ByteString getGroupBytes()
         The name of the secret group where to find the key referenced below. For K8s secrets, this should be the name of
 the v1/secret object. For Confidant, this should be the Credential name. For Vault, this should be the secret name.
 For AWS Secret Manager, this should be the name of the secret.
 +required
        string group = 1;
        Specified by:
        getGroupBytes in interface Security.SecretOrBuilder
        Returns:
        The bytes for group.

      • getGroupVersion

        public String getGroupVersion()
         The group version to fetch. This is not supported in all secret management systems. It'll be ignored for the ones
 that do not support it.
 +optional
        string group_version = 2;
        Specified by:
        getGroupVersion in interface Security.SecretOrBuilder
        Returns:
        The groupVersion.

      • getGroupVersionBytes

        public com.google.protobuf.ByteString getGroupVersionBytes()
         The group version to fetch. This is not supported in all secret management systems. It'll be ignored for the ones
 that do not support it.
 +optional
        string group_version = 2;
        Specified by:
        getGroupVersionBytes in interface Security.SecretOrBuilder
        Returns:
        The bytes for groupVersion.

      • getKey

        public String getKey()
         The name of the secret to mount. This has to match an existing secret in the system. It's up to the implementation
 of the secret management system to require case sensitivity. For K8s secrets, Confidant and Vault, this should
 match one of the keys inside the secret. For AWS Secret Manager, it's ignored.
 +optional
        string key = 3;
        Specified by:
        getKey in interface Security.SecretOrBuilder
        Returns:
        The key.

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         The name of the secret to mount. This has to match an existing secret in the system. It's up to the implementation
 of the secret management system to require case sensitivity. For K8s secrets, Confidant and Vault, this should
 match one of the keys inside the secret. For AWS Secret Manager, it's ignored.
 +optional
        string key = 3;
        Specified by:
        getKeyBytes in interface Security.SecretOrBuilder
        Returns:
        The bytes for key.

      • getMountRequirementValue

        public int getMountRequirementValue()
         mount_requirement is optional. Indicates where the secret has to be mounted. If provided, the execution will fail
 if the underlying key management system cannot satisfy that requirement. If not provided, the default location
 will depend on the key management system.
 +optional
        .flyteidl.core.Secret.MountType mount_requirement = 4;
        Specified by:
        getMountRequirementValue in interface Security.SecretOrBuilder
        Returns:
        The enum numeric value on the wire for mountRequirement.

      • getMountRequirement

        public Security.Secret.MountType getMountRequirement()
         mount_requirement is optional. Indicates where the secret has to be mounted. If provided, the execution will fail
 if the underlying key management system cannot satisfy that requirement. If not provided, the default location
 will depend on the key management system.
 +optional
        .flyteidl.core.Secret.MountType mount_requirement = 4;
        Specified by:
        getMountRequirement in interface Security.SecretOrBuilder
        Returns:
        The mountRequirement.

      • 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 Security.Secret parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Security.Secret parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

        public static com.google.protobuf.Parser<Security.Secret> parser()

      • getParserForType

        public com.google.protobuf.Parser<Security.Secret> 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 Security.Secret getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder