Help

interface Help

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Types

Link

interface Link

Describes a URL link.

Properties

links

abstract val links: List<Help.Link>

URL(s) pointing to additional information on handling the current error.

Functions

asInternal

fun Help.asInternal(): HelpInternal

copy

fun Help.copy(body: <Error class: unknown class>.() -> Unit = {}): Help

Copies the original message, including unknown fields.