pulumi-google-native-kotlin/com.pulumi.googlenative.servicemanagement.v1.kotlin.inputs/DocumentationRuleArgs

DocumentationRuleArgs

data class DocumentationRuleArgs(val deprecationDescription: Output<String>? = null, val description: Output<String>? = null, val disableReplacementWords: Output<String>? = null, val selector: Output<String>? = null) : ConvertibleToJava<DocumentationRuleArgs>

A documentation rule provides information about individual API elements.

Constructors

fun DocumentationRuleArgs(deprecationDescription: Output<String>? = null, description: Output<String>? = null, disableReplacementWords: Output<String>? = null, selector: Output<String>? = null)

Functions

toJava

open override fun toJava(): DocumentationRuleArgs

Properties

deprecationDescription

val deprecationDescription: Output<String>? = null

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description

val description: Output<String>? = null

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

disableReplacementWords

val disableReplacementWords: Output<String>? = null

String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.

selector

val selector: Output<String>? = null

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo..bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "" is used.