Package flyteidl.core

Class Security.Secret.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Security.SecretOrBuilder, Cloneable
    Enclosing class:
    Security.Secret
    public static final class Security.Secret.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>
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

    • Field Detail

      • bitField0_

        private int bitField0_

      • group_

        private Object group_

      • groupVersion_

        private Object groupVersion_

      • mountRequirement_

        private int mountRequirement_

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

    • Method Detail

      • 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.Builder<Security.Secret.Builder>

      • clear

        public Security.Secret.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • getDefaultInstanceForType

        public Security.Secret getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public Security.Secret.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • setField

        public Security.Secret.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • clearField

        public Security.Secret.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • clearOneof

        public Security.Secret.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • setRepeatedField

        public Security.Secret.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • addRepeatedField

        public Security.Secret.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • mergeFrom

        public Security.Secret.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Security.Secret.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • mergeFrom

        public Security.Secret.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Security.Secret.Builder>
        Throws:
        IOException

      • 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.

      • setGroup

        public Security.Secret.Builder setGroup​(String value)
         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;
        Parameters:
        value - The group to set.
        Returns:
        This builder for chaining.

      • clearGroup

        public Security.Secret.Builder clearGroup()
         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;
        Returns:
        This builder for chaining.

      • setGroupBytes

        public Security.Secret.Builder setGroupBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for group to set.
        Returns:
        This builder for chaining.

      • 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.

      • setGroupVersion

        public Security.Secret.Builder setGroupVersion​(String value)
         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;
        Parameters:
        value - The groupVersion to set.
        Returns:
        This builder for chaining.

      • clearGroupVersion

        public Security.Secret.Builder clearGroupVersion()
         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;
        Returns:
        This builder for chaining.

      • setGroupVersionBytes

        public Security.Secret.Builder setGroupVersionBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for groupVersion to set.
        Returns:
        This builder for chaining.

      • 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.

      • setKey

        public Security.Secret.Builder setKey​(String value)
         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;
        Parameters:
        value - The key to set.
        Returns:
        This builder for chaining.

      • clearKey

        public Security.Secret.Builder clearKey()
         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;
        Returns:
        This builder for chaining.

      • setKeyBytes

        public Security.Secret.Builder setKeyBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for key to set.
        Returns:
        This builder for chaining.

      • 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.

      • setMountRequirementValue

        public Security.Secret.Builder setMountRequirementValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for mountRequirement to set.
        Returns:
        This builder for chaining.

      • 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.

      • setMountRequirement

        public Security.Secret.Builder setMountRequirement​(Security.Secret.MountType value)
         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;
        Parameters:
        value - The mountRequirement to set.
        Returns:
        This builder for chaining.

      • clearMountRequirement

        public Security.Secret.Builder clearMountRequirement()
         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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Security.Secret.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>

      • mergeUnknownFields

        public final Security.Secret.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Security.Secret.Builder>