Package flyteidl.core

Interface Security.SecretOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Security.Secret, Security.Secret.Builder
    Enclosing class:
    Security
    public static interface Security.SecretOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getGroup()
      The name of the secret group where to find the key referenced below.
      com.google.protobuf.ByteString getGroupBytes()
      The name of the secret group where to find the key referenced below.
      String getGroupVersion()
      The group version to fetch.
      com.google.protobuf.ByteString getGroupVersionBytes()
      The group version to fetch.
      String getKey()
      The name of the secret to mount.
      com.google.protobuf.ByteString getKeyBytes()
      The name of the secret to mount.
      Security.Secret.MountType getMountRequirement()
      mount_requirement is optional.
      int getMountRequirementValue()
      mount_requirement is optional.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getGroup

        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;
        Returns:
        The group.

      • getGroupBytes

        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;
        Returns:
        The bytes for group.

      • getGroupVersion

        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;
        Returns:
        The groupVersion.

      • getGroupVersionBytes

        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;
        Returns:
        The bytes for groupVersion.

      • getKey

        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;
        Returns:
        The key.

      • getKeyBytes

        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;
        Returns:
        The bytes for key.

      • getMountRequirementValue

        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;
        Returns:
        The enum numeric value on the wire for mountRequirement.

      • getMountRequirement

        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;
        Returns:
        The mountRequirement.