protokt.com.google.api.resource.kt Maven / Gradle / Ivy
// Generated by protokt version 0.9.0. Do not modify.
// Source: google/api/resource.proto
package com.google.api
import com.toasttab.protokt.rt.KtDeserializer
import com.toasttab.protokt.rt.KtEnum
import com.toasttab.protokt.rt.KtEnumDeserializer
import com.toasttab.protokt.rt.KtGeneratedMessage
import com.toasttab.protokt.rt.KtMessage
import com.toasttab.protokt.rt.KtMessageDeserializer
import com.toasttab.protokt.rt.KtMessageSerializer
import com.toasttab.protokt.rt.Tag
import com.toasttab.protokt.rt.UInt32
import com.toasttab.protokt.rt.UnknownFieldSet
import com.toasttab.protokt.rt.copyList
import com.toasttab.protokt.rt.finishList
import com.toasttab.protokt.rt.sizeof
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.MutableList
/**
* A simple descriptor of a resource type.
*
* ResourceDescriptor annotates a resource message (either by means of a protobuf annotation or use
* in the service config), and associates the resource's schema, the resource type, and the pattern of
* the resource name.
*
* Example:
*
* message Topic { // Indicates this message defines a resource schema. // Declares
* the resource type in the format of {service}/{kind}. // For Kubernetes resources, the format
* is {api group}/{kind}. option (google.api.resource) = { type:
* "pubsub.googleapis.com/Topic" pattern: "projects/{project}/topics/{topic}" }; }
*
* The ResourceDescriptor Yaml config will look like:
*
* resources: - type: "pubsub.googleapis.com/Topic" pattern:
* "projects/{project}/topics/{topic}"
*
* Sometimes, resources have multiple patterns, typically because they can live under multiple
* parents.
*
* Example:
*
* message LogEntry { option (google.api.resource) = { type:
* "logging.googleapis.com/LogEntry" pattern: "projects/{project}/logs/{log}" pattern:
* "folders/{folder}/logs/{log}" pattern: "organizations/{organization}/logs/{log}"
* pattern: "billingAccounts/{billing_account}/logs/{log}" }; }
*
* The ResourceDescriptor Yaml config will look like:
*
* resources: - type: 'logging.googleapis.com/LogEntry' pattern:
* "projects/{project}/logs/{log}" pattern: "folders/{folder}/logs/{log}" pattern:
* "organizations/{organization}/logs/{log}" pattern:
* "billingAccounts/{billing_account}/logs/{log}"
*/
@KtGeneratedMessage("google.api.ResourceDescriptor")
class ResourceDescriptor private constructor(
/**
* The resource type. It must be in the format of {service_name}/{resource_type_kind}. The
* `resource_type_kind` must be singular and must not include version numbers.
*
* Example: `storage.googleapis.com/Bucket`
*
* The value of the resource_type_kind must follow the regular expression
* /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and should use PascalCase
* (UpperCamelCase). The maximum number of characters allowed for the `resource_type_kind` is 100.
*/
val type: String,
/**
* Optional. The relative resource name pattern associated with this resource type. The DNS
* prefix of the full resource name shouldn't be specified here.
*
* The path pattern must follow the syntax, which aligns with HTTP binding syntax:
*
* Template = Segment { "/" Segment } ; Segment = LITERAL | Variable ; Variable =
* "{" LITERAL "}" ;
*
* Examples:
*
* - "projects/{project}/topics/{topic}" -
* "projects/{project}/knowledgeBases/{knowledge_base}"
*
* The components in braces correspond to the IDs for each resource in the hierarchy. It is
* expected that, if multiple patterns are provided, the same component name (e.g. "project")
* refers to IDs of the same type of resource.
*/
val pattern: List,
/**
* Optional. The field on the resource that designates the resource name field. If omitted, this
* is assumed to be "name".
*/
val nameField: String,
/**
* Optional. The historical or future-looking state of the resource pattern.
*
* Example:
*
* // The InspectTemplate message originally only supported resource // names with
* organization, and project was added later. message InspectTemplate { option
* (google.api.resource) = { type: "dlp.googleapis.com/InspectTemplate" pattern:
* "organizations/{organization}/inspectTemplates/{inspect_template}" pattern:
* "projects/{project}/inspectTemplates/{inspect_template}" history:
* ORIGINALLY_SINGLE_PATTERN }; }
*/
val history: History,
/**
* The plural name used in the resource name and permission names, such as 'projects' for the
* resource name of 'projects/{project}' and the permission name of
* 'cloudresourcemanager.googleapis.com/projects.get'. It is the same concept of the `plural` field
* in k8s CRD spec
* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
*
*
* Note: The plural form is required even for singleton resources. See https://aip.dev/156
*/
val plural: String,
/**
* The same concept of the `singular` field in k8s CRD spec
* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
* Such as "project" for the `resourcemanager.googleapis.com/Project` type.
*/
val singular: String,
/**
* Style flag(s) for this resource. These indicate that a resource is expected to conform to a
* given style. See the specific style flags for additional information.
*/
val style: List