Package dev.sigstore.proto.trustroot.v1

Class TransparencyLogInstance.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransparencyLogInstanceOrBuilder, java.lang.Cloneable
    Enclosing class:
    TransparencyLogInstance
    public static final class TransparencyLogInstance.Builder
extends com.google.protobuf.GeneratedMessage.Builder<TransparencyLogInstance.Builder>
implements TransparencyLogInstanceOrBuilder
     TransparencyLogInstance describes the immutable parameters from a
 transparency log.
 See https://www.rfc-editor.org/rfc/rfc9162.html#name-log-parameters
 for more details.
 The included parameters are the minimal set required to identify a log,
 and verify an inclusion proof/promise.
    Protobuf type dev.sigstore.trustroot.v1.TransparencyLogInstance

    • 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<TransparencyLogInstance.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<TransparencyLogInstance.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public TransparencyLogInstance.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<TransparencyLogInstance.Builder>
        Throws:
        java.io.IOException

      • getBaseUrl

        public java.lang.String getBaseUrl()
         The base URL at which can be used to URLs for the client.
        string base_url = 1;
        Specified by:
        getBaseUrl in interface TransparencyLogInstanceOrBuilder
        Returns:
        The baseUrl.

      • getBaseUrlBytes

        public com.google.protobuf.ByteString getBaseUrlBytes()
         The base URL at which can be used to URLs for the client.
        string base_url = 1;
        Specified by:
        getBaseUrlBytes in interface TransparencyLogInstanceOrBuilder
        Returns:
        The bytes for baseUrl.

      • setBaseUrl

        public TransparencyLogInstance.Builder setBaseUrl​(java.lang.String value)
         The base URL at which can be used to URLs for the client.
        string base_url = 1;
        Parameters:
        value - The baseUrl to set.
        Returns:
        This builder for chaining.

      • clearBaseUrl

        public TransparencyLogInstance.Builder clearBaseUrl()
         The base URL at which can be used to URLs for the client.
        string base_url = 1;
        Returns:
        This builder for chaining.

      • setBaseUrlBytes

        public TransparencyLogInstance.Builder setBaseUrlBytes​(com.google.protobuf.ByteString value)
         The base URL at which can be used to URLs for the client.
        string base_url = 1;
        Parameters:
        value - The bytes for baseUrl to set.
        Returns:
        This builder for chaining.

      • getHashAlgorithmValue

        public int getHashAlgorithmValue()
         The hash algorithm used for the Merkle Tree.
        .dev.sigstore.common.v1.HashAlgorithm hash_algorithm = 2;
        Specified by:
        getHashAlgorithmValue in interface TransparencyLogInstanceOrBuilder
        Returns:
        The enum numeric value on the wire for hashAlgorithm.

      • setHashAlgorithmValue

        public TransparencyLogInstance.Builder setHashAlgorithmValue​(int value)
         The hash algorithm used for the Merkle Tree.
        .dev.sigstore.common.v1.HashAlgorithm hash_algorithm = 2;
        Parameters:
        value - The enum numeric value on the wire for hashAlgorithm to set.
        Returns:
        This builder for chaining.

      • setHashAlgorithm

        public TransparencyLogInstance.Builder setHashAlgorithm​(HashAlgorithm value)
         The hash algorithm used for the Merkle Tree.
        .dev.sigstore.common.v1.HashAlgorithm hash_algorithm = 2;
        Parameters:
        value - The hashAlgorithm to set.
        Returns:
        This builder for chaining.

      • clearHashAlgorithm

        public TransparencyLogInstance.Builder clearHashAlgorithm()
         The hash algorithm used for the Merkle Tree.
        .dev.sigstore.common.v1.HashAlgorithm hash_algorithm = 2;
        Returns:
        This builder for chaining.

      • hasPublicKey

        public boolean hasPublicKey()
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;
        Specified by:
        hasPublicKey in interface TransparencyLogInstanceOrBuilder
        Returns:
        Whether the publicKey field is set.

      • getPublicKey

        public PublicKey getPublicKey()
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;
        Specified by:
        getPublicKey in interface TransparencyLogInstanceOrBuilder
        Returns:
        The publicKey.

      • setPublicKey

        public TransparencyLogInstance.Builder setPublicKey​(PublicKey value)
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;

      • setPublicKey

        public TransparencyLogInstance.Builder setPublicKey​(PublicKey.Builder builderForValue)
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;

      • mergePublicKey

        public TransparencyLogInstance.Builder mergePublicKey​(PublicKey value)
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;

      • clearPublicKey

        public TransparencyLogInstance.Builder clearPublicKey()
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;

      • getPublicKeyBuilder

        public PublicKey.Builder getPublicKeyBuilder()
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;

      • hasLogId

        public boolean hasLogId()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;
        Specified by:
        hasLogId in interface TransparencyLogInstanceOrBuilder
        Returns:
        Whether the logId field is set.

      • getLogId

        public LogId getLogId()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;
        Specified by:
        getLogId in interface TransparencyLogInstanceOrBuilder
        Returns:
        The logId.

      • setLogId

        public TransparencyLogInstance.Builder setLogId​(LogId value)
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;

      • setLogId

        public TransparencyLogInstance.Builder setLogId​(LogId.Builder builderForValue)
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;

      • mergeLogId

        public TransparencyLogInstance.Builder mergeLogId​(LogId value)
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;

      • clearLogId

        public TransparencyLogInstance.Builder clearLogId()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;

      • getLogIdBuilder

        public LogId.Builder getLogIdBuilder()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;

      • getLogIdOrBuilder

        public LogIdOrBuilder getLogIdOrBuilder()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;
        Specified by:
        getLogIdOrBuilder in interface TransparencyLogInstanceOrBuilder

      • hasCheckpointKeyId

        public boolean hasCheckpointKeyId()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;
        Specified by:
        hasCheckpointKeyId in interface TransparencyLogInstanceOrBuilder
        Returns:
        Whether the checkpointKeyId field is set.

      • getCheckpointKeyId

        public LogId getCheckpointKeyId()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;
        Specified by:
        getCheckpointKeyId in interface TransparencyLogInstanceOrBuilder
        Returns:
        The checkpointKeyId.

      • setCheckpointKeyId

        public TransparencyLogInstance.Builder setCheckpointKeyId​(LogId value)
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;

      • setCheckpointKeyId

        public TransparencyLogInstance.Builder setCheckpointKeyId​(LogId.Builder builderForValue)
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;

      • mergeCheckpointKeyId

        public TransparencyLogInstance.Builder mergeCheckpointKeyId​(LogId value)
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;

      • clearCheckpointKeyId

        public TransparencyLogInstance.Builder clearCheckpointKeyId()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;

      • getCheckpointKeyIdBuilder

        public LogId.Builder getCheckpointKeyIdBuilder()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;

      • getCheckpointKeyIdOrBuilder

        public LogIdOrBuilder getCheckpointKeyIdOrBuilder()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;
        Specified by:
        getCheckpointKeyIdOrBuilder in interface TransparencyLogInstanceOrBuilder