Class CertificateProviderPluginInstance

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CertificateProviderPluginInstanceOrBuilder, Serializable

    public final class CertificateProviderPluginInstance
    extends com.google.protobuf.GeneratedMessageV3
    implements CertificateProviderPluginInstanceOrBuilder
     Indicates a certificate to be obtained from a named CertificateProvider plugin instance.
     The plugin instances are defined in the client's bootstrap file.
     The plugin allows certificates to be fetched/refreshed over the network asynchronously with
     respect to the TLS handshake.
     [#not-implemented-hide:]
     
    Protobuf type envoy.extensions.transport_sockets.tls.v3.CertificateProviderPluginInstance
    See Also:
    Serialized Form
    • Field Detail

      • INSTANCE_NAME_FIELD_NUMBER

        public static final int INSTANCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CERTIFICATE_NAME_FIELD_NUMBER

        public static final int CERTIFICATE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
    • 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
      • getInstanceName

        public String getInstanceName()
         Provider instance name. If not present, defaults to "default".
         Instance names should generally be defined not in terms of the underlying provider
         implementation (e.g., "file_watcher") but rather in terms of the function of the
         certificates (e.g., "foo_deployment_identity").
         
        string instance_name = 1;
        Specified by:
        getInstanceName in interface CertificateProviderPluginInstanceOrBuilder
        Returns:
        The instanceName.
      • getInstanceNameBytes

        public com.google.protobuf.ByteString getInstanceNameBytes()
         Provider instance name. If not present, defaults to "default".
         Instance names should generally be defined not in terms of the underlying provider
         implementation (e.g., "file_watcher") but rather in terms of the function of the
         certificates (e.g., "foo_deployment_identity").
         
        string instance_name = 1;
        Specified by:
        getInstanceNameBytes in interface CertificateProviderPluginInstanceOrBuilder
        Returns:
        The bytes for instanceName.
      • getCertificateName

        public String getCertificateName()
         Opaque name used to specify certificate instances or types. For example, "ROOTCA" to specify
         a root-certificate (validation context) or "example.com" to specify a certificate for a
         particular domain. Not all provider instances will actually use this field, so the value
         defaults to the empty string.
         
        string certificate_name = 2;
        Specified by:
        getCertificateName in interface CertificateProviderPluginInstanceOrBuilder
        Returns:
        The certificateName.
      • getCertificateNameBytes

        public com.google.protobuf.ByteString getCertificateNameBytes()
         Opaque name used to specify certificate instances or types. For example, "ROOTCA" to specify
         a root-certificate (validation context) or "example.com" to specify a certificate for a
         particular domain. Not all provider instances will actually use this field, so the value
         defaults to the empty string.
         
        string certificate_name = 2;
        Specified by:
        getCertificateNameBytes in interface CertificateProviderPluginInstanceOrBuilder
        Returns:
        The bytes for certificateName.
      • 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 CertificateProviderPluginInstance parseFrom​(ByteBuffer data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

        public CertificateProviderPluginInstance.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public CertificateProviderPluginInstance.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected CertificateProviderPluginInstance.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

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