Packages

sealed trait Server extends AnyRef

The configuration of the Develocity server that will receive build scans.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Server
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def accessKey: Option[String]

    The access key for authenticating with the Develocity server.

    The access key for authenticating with the Develocity server.

    Only the value of the explicitly configured access key is returned but not the value of an access key configured via the 

    DEVELOCITY_ACCESS_KEY
    environment variable or access key file entry.

    An access key configured this way will take precedence over the 

    DEVELOCITY_ACCESS_KEY
    environment variable or access key file entry associated with the server.

    DEVELOCITY_ACCESS_KEY or access key file entry.

    An access key configured this way will take precedence over the 

    DEVELOCITY_ACCESS_KEY
    environment variable or access key file entry associated with the server.

    returns

    the configured Develocity server access key, if available; otherwise, 

    None

  2. abstract def allowUntrusted: Boolean

    Specifies whether it is acceptable to communicate with a Develocity server using an untrusted SSL certificate.

    Specifies whether it is acceptable to communicate with a Develocity server using an untrusted SSL certificate.

    The default (public) build scan server uses SSL certificates that are trusted by default by standard modern Java environments. If you are using a different build scan server via Develocity, it may use an untrusted certificate. This may be due to the use of an internally provisioned or self-signed certificate.

    In such a scenario, you can either configure the build JVM environment to trust the certificate, or call this method with 

    true
    to disable verification of the server's identity. Alternatively, you may disable SSL completely for Develocity installation but this is not recommended.

    Allowing communication with untrusted servers keeps data encrypted during transmission, but makes it easy for a man-in-the-middle to impersonate the intended server and capture data.

    This value has no effect if a server is specified using the HTTP protocol (i.e. has SSL disabled).

    true Alternatively, you may disable SSL completely for Develocity installation but this is not recommended.

    Allowing communication with untrusted servers keeps data encrypted during transmission, but makes it easy for a man-in-the-middle to impersonate the intended server and capture data.

    This value has no effect if a server is specified using the HTTP protocol (i.e. has SSL disabled).

  3. abstract def edgeDiscovery: Boolean

    Returns whether to enable communication with Develocity server to automatically discover and select a Develocity Edge.

    Returns whether to enable communication with Develocity server to automatically discover and select a Develocity Edge.

    returns

    true if discovery and automatic selection of a Develocity Edge is enabled, or false by default

    Since

    1.3

  4. abstract def url: Option[URL]

    The URL of the Develocity server.

  5. abstract def withAccessKey(accessKey: String): Server

    Create a copy of this configuration with an updated access key.

    Create a copy of this configuration with an updated access key.

    accessKey

    The new access key.

    returns

    A copy of this configuration with an updated access key.

    Since

    1.1.2

    See also

    accessKey

  6. abstract def withAccessKey(accessKey: Option[String]): Server

    Create a copy of this configuration with an updated access key.

    Create a copy of this configuration with an updated access key.

    accessKey

    The new access key.

    returns

    A copy of this configuration with an updated access key.

    See also

    accessKey

  7. abstract def withAllowUntrusted(allowUntrusted: Boolean): Server

    Create a copy of this configuration with an updated behavior regarding untrusted SSL certificates.

    Create a copy of this configuration with an updated behavior regarding untrusted SSL certificates.

    allowUntrusted

    Whether to accept communications with a Develocity server using an untrusted SSL certificate.

    returns

    A copy of this configuration with an updated behavior regarding untrusted SSL certificates.

    See also

    allowUntrusted

  8. abstract def withEdgeDiscovery(edgeDiscovery: Boolean): Server

    Create a copy of this configuration with an updated Edge discovery configuration.

    Create a copy of this configuration with an updated Edge discovery configuration.

    This configuration parameter specifies whether to enable discovery and automatic selection of a Develocity Edge.

    The Develocity server (specified by withUrl) will be contacted to discover available Edges. An Edge is selected based on the user's Location settings in Develocity and is used by the sbt plugin for remote build caching. In case the user has no Location preference set, the Develocity server will be used as the remote build cache target.

    • The specified Develocity server version supports Develocity Edge, which was introduced in Develocity 2024.3.
    • Access key authentication to Develocity is configured for the build withAccessKey).

    A build cache address configured via RemoteBuildCache.server is always used, overriding the result of Edge discovery.

    edgeDiscovery

    Whether to use Develocity Edge discovery.

    returns

    A copy of this configuration with an updated behavior regarding Develocity Edge discovery.

    Since

    1.3

    See also

    edgeDiscovery

  9. abstract def withUrl(url: URL): Server

    Create a copy of this configuration with an updated URL.

    Create a copy of this configuration with an updated URL.

    url

    The new URL to connect to.

    returns

    A copy of this configuration with an updated URL.

    Since

    1.1.2

    See also

    url

  10. abstract def withUrl(url: Option[URL]): Server

    Create a copy of this configuration with an updated URL.

    Create a copy of this configuration with an updated URL.

    url

    The new URL to connect to.

    returns

    A copy of this configuration with an updated URL.

    See also

    url

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped