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

Class PrivateKeyProvider.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<PrivateKeyProvider.Builder>
com.google.protobuf.GeneratedMessage.Builder<PrivateKeyProvider.Builder>
io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.PrivateKeyProvider.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PrivateKeyProviderOrBuilder, 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 Details

    • configTypeCase_

      private int configTypeCase_

    • configType_

      private Object configType_

    • bitField0_

      private int bitField0_

    • providerName_

      private 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 Details

    • Builder

      private Builder()

    • Builder

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

  • Method Details

    • 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

    • buildPartial0

      private void buildPartial0(PrivateKeyProvider result)

    • buildPartialOneofs

      private void buildPartialOneofs(PrivateKeyProvider result)

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

    • mergeFrom

      public PrivateKeyProvider.Builder mergeFrom(PrivateKeyProvider other)

    • 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 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:
      IOException

    • getConfigTypeCase

      public PrivateKeyProvider.ConfigTypeCase getConfigTypeCase()
      Specified by:
      getConfigTypeCase in interface PrivateKeyProviderOrBuilder

    • clearConfigType

      public PrivateKeyProvider.Builder clearConfigType()

    • getProviderName

      public 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(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.