sealed trait BuildScan extends AnyRef
The configuration for Build Scan publication.
- Alphabetic
- By Inheritance
- BuildScan
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
backgroundUpload: Boolean
Specifies whether to upload the build scan in background after the build has finished.
Specifies whether to upload the build scan in background after the build has finished.
Defaults to
true
.This allows the build to finish sooner, but can be problematic in build environments that terminate as soon as the build is finished as the upload may be terminated before it completes. Background uploading should be disabled for such environments.
This setting can also be set by the
develocity.scan.uploadInBackground
system property, which, if set, takes precedence over any value set by this method and the default.develocity.scan.uploadInBackground which, if set, takes precedence over any value set by this method and the default.
true
This allows the build to finish sooner, but can be problematic in build environments that terminate as soon as the build is finished as the upload may be terminated before it completes. Background uploading should be disabled for such environments.
This setting can also be set by the
develocity.scan.uploadInBackground
system property, which, if set, takes precedence over any value set by this method and the default.develocity.scan.uploadInBackground which, if set, takes precedence over any value set by this method and the default.
-
abstract
def
capture: Capture
Specifies what data will be captured as part of the build scan.
-
abstract
def
links: Map[String, URL]
The named links for the current build.
-
abstract
def
obfuscation: Obfuscation
Functions for obfuscating certain identifying information within build scans.
-
abstract
def
publishing: Publishing
Specifies when the build scan should be published.
Specifies when the build scan should be published.
Defaults to always publishing the build scan (
Publishing.onlyIf(_ => true)
).Publishing.onlyIf(_ => true)
-
abstract
def
tags: Set[String]
The tags for the current build.
-
abstract
def
termsOfUse: Option[(URL, Boolean)]
The location of the Gradle Terms of Use and whether they were agreed to.
-
abstract
def
values: Map[String, String]
The named values for the current build.
-
abstract
def
withBackgroundUpload(backgroundUpload: Boolean): BuildScan
Create a copy of this configuration with a new configuration for background upload.
Create a copy of this configuration with a new configuration for background upload.
- backgroundUpload
Whether the build scan should be uploaded in background.
- returns
A copy of this configuration with a new configuration for background upload.
- See also
-
abstract
def
withCapture(capture: Capture): BuildScan
Creates a copy of this configuration with new capture configuration.
Creates a copy of this configuration with new capture configuration.
- capture
The new capture configuration.
- returns
A copy of this configuration with new capture configuration.
- See also
-
abstract
def
withLink(link: String, url: URL): BuildScan
Create a copy of this configuration with the new link added.
Create a copy of this configuration with the new link added.
- link
The name of the link.
- url
The URL of the link.
- returns
A copy of this configuration with the new link added.
- Since
1.1.2
- See also
-
abstract
def
withLinks(links: Map[String, URL]): BuildScan
Create a copy of this configuration with new links.
Create a copy of this configuration with new links.
- links
The new links for the build scan.
- returns
A copy of this configuration with new links.
- See also
-
abstract
def
withObfuscation(obfuscation: Obfuscation): BuildScan
Create a copy of this configuration with new functions for obfuscating certain identifying information.
Create a copy of this configuration with new functions for obfuscating certain identifying information.
- obfuscation
The new obfuscation functions.
- returns
A copy of this configuration with new functions for obfuscating certain identifying information.
- See also
-
abstract
def
withPublishing(publishing: Publishing): BuildScan
Create a copy of this configuration with the new publishing configuration.
Create a copy of this configuration with the new publishing configuration.
- publishing
The new publishing configuration
- returns
A copy of this configuration with the new publishing configuration.
-
abstract
def
withTag(tag: String): BuildScan
Create a copy of this configuration with the new tag added.
Create a copy of this configuration with the new tag added.
- tag
The new tag to add to the build scan.
- returns
A copy of this configuration with the new tag added.
- Since
1.1.2
- See also
-
abstract
def
withTags(tags: Set[String]): BuildScan
Create a copy of this configuration with new tags.
Create a copy of this configuration with new tags.
- tags
The new tags for the build scan.
- returns
A copy of this configuration with new tags.
- See also
-
abstract
def
withTermsOfUse(termsOfUse: (URL, Boolean)): BuildScan
Create a copy of this configuration with new terms of use location and agreement.
Create a copy of this configuration with new terms of use location and agreement.
- termsOfUse
The new terms of use location and agreement.
- returns
A copy of this configuration with new terms of use location and agreement.
- Since
1.1.2
- See also
-
abstract
def
withTermsOfUse(termsOfUse: Option[(URL, Boolean)]): BuildScan
Create a copy of this configuration with new terms of use location and agreement.
Create a copy of this configuration with new terms of use location and agreement.
- termsOfUse
The new terms of use location and agreement.
- returns
A copy of this configuration with new terms of use location and agreement.
- See also
-
abstract
def
withValue(key: String, value: String): BuildScan
Create a copy of this configuration with the new value added.
Create a copy of this configuration with the new value added.
- key
The key of the new value.
- value
The new value.
- returns
A copy of this configuration with the new value added.
- Since
1.1.2
- See also
-
abstract
def
withValues(values: Map[String, String]): BuildScan
Create a copy of this configuration with new values attached to the build scan.
Create a copy of this configuration with new values attached to the build scan.
- values
The new values to attach to the build scan.
- returns
A copy of this configuration with new values attached to the build scan.
- See also
-
abstract
def
link(link: String, url: URL): BuildScan
Create a copy of this configuration with the new link added.
Create a copy of this configuration with the new link added.
- link
The name of the link.
- url
The URL of the link.
- returns
A copy of this configuration with the new link added.
- Annotations
- @deprecated
- Deprecated
(Since version 1.1.2) Please use withLink instead
- See also
-
abstract
def
tag(tag: String): BuildScan
Create a copy of this configuration with the new tag added.
Create a copy of this configuration with the new tag added.
- tag
The new tag to add to the build scan.
- returns
A copy of this configuration with the new tag added.
- Annotations
- @deprecated
- Deprecated
(Since version 1.1.2) Please use withTag instead
- See also
-
abstract
def
value(key: String, value: String): BuildScan
Create a copy of this configuration with the new value added.
Create a copy of this configuration with the new value added.
- key
The key of the new value.
- value
The new value.
- returns
A copy of this configuration with the new value added.
- Annotations
- @deprecated
- Deprecated
(Since version 1.1.2) Please use withValue instead
- See also
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()