com.google.api.PageKt.kt Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/documentation.proto
// Generated files should ignore deprecation warnings
@file:Suppress("DEPRECATION")
package com.google.api;
@kotlin.jvm.JvmName("-initializepage")
public inline fun page(block: com.google.api.PageKt.Dsl.() -> kotlin.Unit): com.google.api.Page =
com.google.api.PageKt.Dsl._create(com.google.api.Page.newBuilder()).apply { block() }._build()
/**
* ```
* Represents a documentation page. A page can contain subpages to represent
* nested documentation set structure.
* ```
*
* Protobuf type `google.api.Page`
*/
public object PageKt {
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
@com.google.protobuf.kotlin.ProtoDslMarker
public class Dsl private constructor(
private val _builder: com.google.api.Page.Builder
) {
public companion object {
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _create(builder: com.google.api.Page.Builder): Dsl = Dsl(builder)
}
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _build(): com.google.api.Page = _builder.build()
/**
* ```
* The name of the page. It will be used as an identity of the page to
* generate URI of the page, text of the link to this page in navigation,
* etc. The full page name (start from the root page name to this page
* concatenated with `.`) can be used as reference to the page in your
* documentation. For example:
* pages:
* - name: Tutorial
* content: (== include tutorial.md ==)
* subpages:
* - name: Java
* content: (== include tutorial_java.md ==)
*
* You can reference `Java` page using Markdown reference link syntax:
* `[Java][Tutorial.Java]`.
* ```
*
* `string name = 1;`
*/
public var name: kotlin.String
@JvmName("getName")
get() = _builder.getName()
@JvmName("setName")
set(value) {
_builder.setName(value)
}
/**
* ```
* The name of the page. It will be used as an identity of the page to
* generate URI of the page, text of the link to this page in navigation,
* etc. The full page name (start from the root page name to this page
* concatenated with `.`) can be used as reference to the page in your
* documentation. For example:
* pages:
* - name: Tutorial
* content: (== include tutorial.md ==)
* subpages:
* - name: Java
* content: (== include tutorial_java.md ==)
*
* You can reference `Java` page using Markdown reference link syntax:
* `[Java][Tutorial.Java]`.
* ```
*
* `string name = 1;`
*/
public fun clearName() {
_builder.clearName()
}
/**
* ```
* The Markdown content of the page. You can use (== include {path} ==)
* to include content from a Markdown file.
* ```
*
* `string content = 2;`
*/
public var content: kotlin.String
@JvmName("getContent")
get() = _builder.getContent()
@JvmName("setContent")
set(value) {
_builder.setContent(value)
}
/**
* ```
* The Markdown content of the page. You can use (== include {path} ==)
* to include content from a Markdown file.
* ```
*
* `string content = 2;`
*/
public fun clearContent() {
_builder.clearContent()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class SubpagesProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
* ```
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
* ```
*
* `repeated .google.api.Page subpages = 3;`
*/
public val subpages: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getSubpagesList()
)
/**
* ```
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
* ```
*
* `repeated .google.api.Page subpages = 3;`
* @param value The subpages to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addSubpages")
public fun com.google.protobuf.kotlin.DslList.add(value: com.google.api.Page) {
_builder.addSubpages(value)
}
/**
* ```
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
* ```
*
* `repeated .google.api.Page subpages = 3;`
* @param value The subpages to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignSubpages")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: com.google.api.Page) {
add(value)
}
/**
* ```
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
* ```
*
* `repeated .google.api.Page subpages = 3;`
* @param values The subpages to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllSubpages")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllSubpages(values)
}
/**
* ```
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
* ```
*
* `repeated .google.api.Page subpages = 3;`
* @param values The subpages to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllSubpages")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
* ```
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
* ```
*
* `repeated .google.api.Page subpages = 3;`
* @param index The index to set the value at.
* @param value The subpages to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setSubpages")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: com.google.api.Page) {
_builder.setSubpages(index, value)
}
/**
* ```
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
* ```
*
* `repeated .google.api.Page subpages = 3;`
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearSubpages")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearSubpages()
}
}
}
@kotlin.jvm.JvmSynthetic
public inline fun com.google.api.Page.copy(block: `com.google.api`.PageKt.Dsl.() -> kotlin.Unit): com.google.api.Page =
`com.google.api`.PageKt.Dsl._create(this.toBuilder()).apply { block() }._build()