Package io.envoyproxy.envoy.extensions.transport_sockets.tls.v3

Class PrivateKeyProvider.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PrivateKeyProviderOrBuilder, java.lang.Cloneable
    Enclosing class:
    PrivateKeyProvider
    public static final class PrivateKeyProvider.Builder
extends com.google.protobuf.GeneratedMessage.Builder<PrivateKeyProvider.Builder>
implements PrivateKeyProviderOrBuilder
     BoringSSL private key method configuration. The private key methods are used for external
 (potentially asynchronous) signing and decryption operations. Some use cases for private key
 methods would be TPM support and TLS acceleration.
    Protobuf type envoy.extensions.transport_sockets.tls.v3.PrivateKeyProvider

    • Field Detail

      • configTypeCase_

        private int configTypeCase_

      • configType_

        private java.lang.Object configType_

      • bitField0_

        private int bitField0_

      • providerName_

        private java.lang.Object providerName_

      • typedConfigBuilder_

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,​com.google.protobuf.Any.Builder,​com.google.protobuf.AnyOrBuilder> typedConfigBuilder_

      • fallback_

        private boolean fallback_

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

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

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PrivateKeyProvider.Builder>

      • clear

        public PrivateKeyProvider.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.GeneratedMessage.Builder<PrivateKeyProvider.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.GeneratedMessage.Builder<PrivateKeyProvider.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • mergeFrom

        public PrivateKeyProvider.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<PrivateKeyProvider.Builder>

      • isInitialized

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

      • mergeFrom

        public PrivateKeyProvider.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.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<PrivateKeyProvider.Builder>
        Throws:
        java.io.IOException

      • getProviderName

        public java.lang.String getProviderName()
         Private key method provider name. The name must match a
 supported private key method provider type.
        string provider_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getProviderName in interface PrivateKeyProviderOrBuilder
        Returns:
        The providerName.

      • getProviderNameBytes

        public com.google.protobuf.ByteString getProviderNameBytes()
         Private key method provider name. The name must match a
 supported private key method provider type.
        string provider_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getProviderNameBytes in interface PrivateKeyProviderOrBuilder
        Returns:
        The bytes for providerName.

      • setProviderName

        public PrivateKeyProvider.Builder setProviderName​(java.lang.String value)
         Private key method provider name. The name must match a
 supported private key method provider type.
        string provider_name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The providerName to set.
        Returns:
        This builder for chaining.

      • clearProviderName

        public PrivateKeyProvider.Builder clearProviderName()
         Private key method provider name. The name must match a
 supported private key method provider type.
        string provider_name = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setProviderNameBytes

        public PrivateKeyProvider.Builder setProviderNameBytes​(com.google.protobuf.ByteString value)
         Private key method provider name. The name must match a
 supported private key method provider type.
        string provider_name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for providerName to set.
        Returns:
        This builder for chaining.

      • hasTypedConfig

        public boolean hasTypedConfig()
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
        Specified by:
        hasTypedConfig in interface PrivateKeyProviderOrBuilder
        Returns:
        Whether the typedConfig field is set.

      • getTypedConfig

        public com.google.protobuf.Any getTypedConfig()
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getTypedConfig in interface PrivateKeyProviderOrBuilder
        Returns:
        The typedConfig.

      • setTypedConfig

        public PrivateKeyProvider.Builder setTypedConfig​(com.google.protobuf.Any value)
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

      • setTypedConfig

        public PrivateKeyProvider.Builder setTypedConfig​(com.google.protobuf.Any.Builder builderForValue)
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

      • mergeTypedConfig

        public PrivateKeyProvider.Builder mergeTypedConfig​(com.google.protobuf.Any value)
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

      • clearTypedConfig

        public PrivateKeyProvider.Builder clearTypedConfig()
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

      • getTypedConfigBuilder

        public com.google.protobuf.Any.Builder getTypedConfigBuilder()
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

      • getTypedConfigOrBuilder

        public com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder()
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getTypedConfigOrBuilder in interface PrivateKeyProviderOrBuilder

      • getTypedConfigFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,​com.google.protobuf.Any.Builder,​com.google.protobuf.AnyOrBuilder> getTypedConfigFieldBuilder()
        .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

      • getFallback

        public boolean getFallback()
         If the private key provider isn't available (eg. the required hardware capability doesn't existed),
 Envoy will fallback to the BoringSSL default implementation when the ``fallback`` is true.
 The default value is ``false``.
        bool fallback = 4;
        Specified by:
        getFallback in interface PrivateKeyProviderOrBuilder
        Returns:
        The fallback.

      • setFallback

        public PrivateKeyProvider.Builder setFallback​(boolean value)
         If the private key provider isn't available (eg. the required hardware capability doesn't existed),
 Envoy will fallback to the BoringSSL default implementation when the ``fallback`` is true.
 The default value is ``false``.
        bool fallback = 4;
        Parameters:
        value - The fallback to set.
        Returns:
        This builder for chaining.

      • clearFallback

        public PrivateKeyProvider.Builder clearFallback()
         If the private key provider isn't available (eg. the required hardware capability doesn't existed),
 Envoy will fallback to the BoringSSL default implementation when the ``fallback`` is true.
 The default value is ``false``.
        bool fallback = 4;
        Returns:
        This builder for chaining.