Package dev.sigstore.proto.rekor.v1

Class Checkpoint

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CheckpointOrBuilder, java.io.Serializable
    public final class Checkpoint
extends com.google.protobuf.GeneratedMessage
implements CheckpointOrBuilder
     The checkpoint MUST contain an origin string as a unique log identifier,
 the tree size, and the root hash. It MAY also be followed by optional data,
 and clients MUST NOT assume optional data. The checkpoint MUST also contain
 a signature over the root hash (tree head). The checkpoint MAY contain additional
 signatures, but the first SHOULD be the signature from the log. Checkpoint contents
 are concatenated with newlines into a single string.
 The checkpoint format is described in
 https://github.com/transparency-dev/formats/blob/main/log/README.md
 and https://github.com/C2SP/C2SP/blob/main/tlog-checkpoint.md.
 An example implementation can be found in https://github.com/sigstore/rekor/blob/main/pkg/util/signed_note.go
    Protobuf type dev.sigstore.rekor.v1.Checkpoint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Checkpoint.Builder
      The checkpoint MUST contain an origin string as a unique log identifier, the tree size, and the root hash.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ENVELOPE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static Checkpoint getDefaultInstance()  
      Checkpoint getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getEnvelope()
      string envelope = 1 [(.google.api.field_behavior) = REQUIRED];
      com.google.protobuf.ByteString getEnvelopeBytes()
      string envelope = 1 [(.google.api.field_behavior) = REQUIRED];
      com.google.protobuf.Parser<Checkpoint> getParserForType()  
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Checkpoint.Builder newBuilder()  
      static Checkpoint.Builder newBuilder​(Checkpoint prototype)  
      Checkpoint.Builder newBuilderForType()  
      protected Checkpoint.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static Checkpoint parseDelimitedFrom​(java.io.InputStream input)  
      static Checkpoint parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Checkpoint parseFrom​(byte[] data)  
      static Checkpoint parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Checkpoint parseFrom​(com.google.protobuf.ByteString data)  
      static Checkpoint parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Checkpoint parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Checkpoint parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Checkpoint parseFrom​(java.io.InputStream input)  
      static Checkpoint parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Checkpoint parseFrom​(java.nio.ByteBuffer data)  
      static Checkpoint parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Checkpoint> parser()  
      Checkpoint.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Field Detail

    • 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

      • getEnvelope

        public java.lang.String getEnvelope()
        string envelope = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEnvelope in interface CheckpointOrBuilder
        Returns:
        The envelope.

      • getEnvelopeBytes

        public com.google.protobuf.ByteString getEnvelopeBytes()
        string envelope = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEnvelopeBytes in interface CheckpointOrBuilder
        Returns:
        The bytes for envelope.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.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 Checkpoint parseFrom​(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Checkpoint parseFrom​(java.nio.ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Checkpoint parseFrom​(java.io.InputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Checkpoint parseFrom​(java.io.InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Checkpoint parseDelimitedFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Checkpoint parseDelimitedFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Checkpoint parseFrom​(com.google.protobuf.CodedInputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Checkpoint parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Checkpoint.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static Checkpoint getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Checkpoint> parser()

      • getParserForType

        public com.google.protobuf.Parser<Checkpoint> 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.GeneratedMessage

      • getDefaultInstanceForType

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