// Copyright 2025 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Code generated by protoc-gen-go. DO NOT EDIT. // versions: // protoc-gen-go v1.36.10 // protoc (unknown) // source: google/api/resource.proto package annotations import ( protoreflect "google.golang.org/protobuf/reflect/protoreflect" protoimpl "google.golang.org/protobuf/runtime/protoimpl" descriptorpb "google.golang.org/protobuf/types/descriptorpb" reflect "reflect" sync "sync" unsafe "unsafe" ) const ( // Verify that this generated code is sufficiently up-to-date. _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) // Verify that runtime/protoimpl is sufficiently up-to-date. _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) // A description of the historical or future-looking state of the // resource pattern. type ResourceDescriptor_History int32 const ( // The "unset" value. ResourceDescriptor_HISTORY_UNSPECIFIED ResourceDescriptor_History = 0 // The resource originally had one pattern and launched as such, and // additional patterns were added later. ResourceDescriptor_ORIGINALLY_SINGLE_PATTERN ResourceDescriptor_History = 1 // The resource has one pattern, but the API owner expects to add more // later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents // that from being necessary once there are multiple patterns.) ResourceDescriptor_FUTURE_MULTI_PATTERN ResourceDescriptor_History = 2 ) // Enum value maps for ResourceDescriptor_History. var ( ResourceDescriptor_History_name = map[int32]string{ 0: "HISTORY_UNSPECIFIED", 1: "ORIGINALLY_SINGLE_PATTERN", 2: "FUTURE_MULTI_PATTERN", } ResourceDescriptor_History_value = map[string]int32{ "HISTORY_UNSPECIFIED": 0, "ORIGINALLY_SINGLE_PATTERN": 1, "FUTURE_MULTI_PATTERN": 2, } ) func (x ResourceDescriptor_History) Enum() *ResourceDescriptor_History { p := new(ResourceDescriptor_History) *p = x return p } func (x ResourceDescriptor_History) String() string { return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x)) } func (ResourceDescriptor_History) Descriptor() protoreflect.EnumDescriptor { return file_google_api_resource_proto_enumTypes[0].Descriptor() } func (ResourceDescriptor_History) Type() protoreflect.EnumType { return &file_google_api_resource_proto_enumTypes[0] } func (x ResourceDescriptor_History) Number() protoreflect.EnumNumber { return protoreflect.EnumNumber(x) } // Deprecated: Use ResourceDescriptor_History.Descriptor instead. func (ResourceDescriptor_History) EnumDescriptor() ([]byte, []int) { return file_google_api_resource_proto_rawDescGZIP(), []int{0, 0} } // A flag representing a specific style that a resource claims to conform to. type ResourceDescriptor_Style int32 const ( // The unspecified value. Do not use. ResourceDescriptor_STYLE_UNSPECIFIED ResourceDescriptor_Style = 0 // This resource is intended to be "declarative-friendly". // // Declarative-friendly resources must be more strictly consistent, and // setting this to true communicates to tools that this resource should // adhere to declarative-friendly expectations. // // Note: This is used by the API linter (linter.aip.dev) to enable // additional checks. ResourceDescriptor_DECLARATIVE_FRIENDLY ResourceDescriptor_Style = 1 ) // Enum value maps for ResourceDescriptor_Style. var ( ResourceDescriptor_Style_name = map[int32]string{ 0: "STYLE_UNSPECIFIED", 1: "DECLARATIVE_FRIENDLY", } ResourceDescriptor_Style_value = map[string]int32{ "STYLE_UNSPECIFIED": 0, "DECLARATIVE_FRIENDLY": 1, } ) func (x ResourceDescriptor_Style) Enum() *ResourceDescriptor_Style { p := new(ResourceDescriptor_Style) *p = x return p } func (x ResourceDescriptor_Style) String() string { return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x)) } func (ResourceDescriptor_Style) Descriptor() protoreflect.EnumDescriptor { return file_google_api_resource_proto_enumTypes[1].Descriptor() } func (ResourceDescriptor_Style) Type() protoreflect.EnumType { return &file_google_api_resource_proto_enumTypes[1] } func (x ResourceDescriptor_Style) Number() protoreflect.EnumNumber { return protoreflect.EnumNumber(x) } // Deprecated: Use ResourceDescriptor_Style.Descriptor instead. func (ResourceDescriptor_Style) EnumDescriptor() ([]byte, []int) { return file_google_api_resource_proto_rawDescGZIP(), []int{0, 1} } // 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}" type ResourceDescriptor struct { state protoimpl.MessageState `protogen:"open.v1"` // 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. Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // 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. Pattern []string `protobuf:"bytes,2,rep,name=pattern,proto3" json:"pattern,omitempty"` // Optional. The field on the resource that designates the resource name // field. If omitted, this is assumed to be "name". NameField string `protobuf:"bytes,3,opt,name=name_field,json=nameField,proto3" json:"name_field,omitempty"` // 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 // }; // } History ResourceDescriptor_History `protobuf:"varint,4,opt,name=history,proto3,enum=google.api.ResourceDescriptor_History" json:"history,omitempty"` // 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'. One exception // to this is for Nested Collections that have stuttering names, as defined // in [AIP-122](https://google.aip.dev/122#nested-collections), where the // collection ID in the resource name pattern does not necessarily directly // match the `plural` value. // // 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 Plural string `protobuf:"bytes,5,opt,name=plural,proto3" json:"plural,omitempty"` // 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. Singular string `protobuf:"bytes,6,opt,name=singular,proto3" json:"singular,omitempty"` // 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. Style []ResourceDescriptor_Style `protobuf:"varint,10,rep,packed,name=style,proto3,enum=google.api.ResourceDescriptor_Style" json:"style,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache } func (x *ResourceDescriptor) Reset() { *x = ResourceDescriptor{} mi := &file_google_api_resource_proto_msgTypes[0] ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) ms.StoreMessageInfo(mi) } func (x *ResourceDescriptor) String() string { return protoimpl.X.MessageStringOf(x) } func (*ResourceDescriptor) ProtoMessage() {} func (x *ResourceDescriptor) ProtoReflect() protoreflect.Message { mi := &file_google_api_resource_proto_msgTypes[0] if x != nil { ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) if ms.LoadMessageInfo() == nil { ms.StoreMessageInfo(mi) } return ms } return mi.MessageOf(x) } // Deprecated: Use ResourceDescriptor.ProtoReflect.Descriptor instead. func (*ResourceDescriptor) Descriptor() ([]byte, []int) { return file_google_api_resource_proto_rawDescGZIP(), []int{0} } func (x *ResourceDescriptor) GetType() string { if x != nil { return x.Type } return "" } func (x *ResourceDescriptor) GetPattern() []string { if x != nil { return x.Pattern } return nil } func (x *ResourceDescriptor) GetNameField() string { if x != nil { return x.NameField } return "" } func (x *ResourceDescriptor) GetHistory() ResourceDescriptor_History { if x != nil { return x.History } return ResourceDescriptor_HISTORY_UNSPECIFIED } func (x *ResourceDescriptor) GetPlural() string { if x != nil { return x.Plural } return "" } func (x *ResourceDescriptor) GetSingular() string { if x != nil { return x.Singular } return "" } func (x *ResourceDescriptor) GetStyle() []ResourceDescriptor_Style { if x != nil { return x.Style } return nil } // Defines a proto annotation that describes a string field that refers to // an API resource. type ResourceReference struct { state protoimpl.MessageState `protogen:"open.v1"` // The resource type that the annotated field references. // // Example: // // message Subscription { // string topic = 2 [(google.api.resource_reference) = { // type: "pubsub.googleapis.com/Topic" // }]; // } // // Occasionally, a field may reference an arbitrary resource. In this case, // APIs use the special value * in their resource reference. // // Example: // // message GetIamPolicyRequest { // string resource = 2 [(google.api.resource_reference) = { // type: "*" // }]; // } Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // The resource type of a child collection that the annotated field // references. This is useful for annotating the `parent` field that // doesn't have a fixed resource type. // // Example: // // message ListLogEntriesRequest { // string parent = 1 [(google.api.resource_reference) = { // child_type: "logging.googleapis.com/LogEntry" // }; // } ChildType string `protobuf:"bytes,2,opt,name=child_type,json=childType,proto3" json:"child_type,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache } func (x *ResourceReference) Reset() { *x = ResourceReference{} mi := &file_google_api_resource_proto_msgTypes[1] ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) ms.StoreMessageInfo(mi) } func (x *ResourceReference) String() string { return protoimpl.X.MessageStringOf(x) } func (*ResourceReference) ProtoMessage() {} func (x *ResourceReference) ProtoReflect() protoreflect.Message { mi := &file_google_api_resource_proto_msgTypes[1] if x != nil { ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) if ms.LoadMessageInfo() == nil { ms.StoreMessageInfo(mi) } return ms } return mi.MessageOf(x) } // Deprecated: Use ResourceReference.ProtoReflect.Descriptor instead. func (*ResourceReference) Descriptor() ([]byte, []int) { return file_google_api_resource_proto_rawDescGZIP(), []int{1} } func (x *ResourceReference) GetType() string { if x != nil { return x.Type } return "" } func (x *ResourceReference) GetChildType() string { if x != nil { return x.ChildType } return "" } var file_google_api_resource_proto_extTypes = []protoimpl.ExtensionInfo{ { ExtendedType: (*descriptorpb.FieldOptions)(nil), ExtensionType: (*ResourceReference)(nil), Field: 1055, Name: "google.api.resource_reference", Tag: "bytes,1055,opt,name=resource_reference", Filename: "google/api/resource.proto", }, { ExtendedType: (*descriptorpb.FileOptions)(nil), ExtensionType: ([]*ResourceDescriptor)(nil), Field: 1053, Name: "google.api.resource_definition", Tag: "bytes,1053,rep,name=resource_definition", Filename: "google/api/resource.proto", }, { ExtendedType: (*descriptorpb.MessageOptions)(nil), ExtensionType: (*ResourceDescriptor)(nil), Field: 1053, Name: "google.api.resource", Tag: "bytes,1053,opt,name=resource", Filename: "google/api/resource.proto", }, } // Extension fields to descriptorpb.FieldOptions. var ( // An annotation that describes a resource reference, see // [ResourceReference][]. // // optional google.api.ResourceReference resource_reference = 1055; E_ResourceReference = &file_google_api_resource_proto_extTypes[0] ) // Extension fields to descriptorpb.FileOptions. var ( // An annotation that describes a resource definition without a corresponding // message; see [ResourceDescriptor][]. // // repeated google.api.ResourceDescriptor resource_definition = 1053; E_ResourceDefinition = &file_google_api_resource_proto_extTypes[1] ) // Extension fields to descriptorpb.MessageOptions. var ( // An annotation that describes a resource definition, see // [ResourceDescriptor][]. // // optional google.api.ResourceDescriptor resource = 1053; E_Resource = &file_google_api_resource_proto_extTypes[2] ) var File_google_api_resource_proto protoreflect.FileDescriptor const file_google_api_resource_proto_rawDesc = "" + "\n" + "\x19google/api/resource.proto\x12\n" + "google.api\x1a google/protobuf/descriptor.proto\"\xaa\x03\n" + "\x12ResourceDescriptor\x12\x12\n" + "\x04type\x18\x01 \x01(\tR\x04type\x12\x18\n" + "\apattern\x18\x02 \x03(\tR\apattern\x12\x1d\n" + "\n" + "name_field\x18\x03 \x01(\tR\tnameField\x12@\n" + "\ahistory\x18\x04 \x01(\x0e2&.google.api.ResourceDescriptor.HistoryR\ahistory\x12\x16\n" + "\x06plural\x18\x05 \x01(\tR\x06plural\x12\x1a\n" + "\bsingular\x18\x06 \x01(\tR\bsingular\x12:\n" + "\x05style\x18\n" + " \x03(\x0e2$.google.api.ResourceDescriptor.StyleR\x05style\"[\n" + "\aHistory\x12\x17\n" + "\x13HISTORY_UNSPECIFIED\x10\x00\x12\x1d\n" + "\x19ORIGINALLY_SINGLE_PATTERN\x10\x01\x12\x18\n" + "\x14FUTURE_MULTI_PATTERN\x10\x02\"8\n" + "\x05Style\x12\x15\n" + "\x11STYLE_UNSPECIFIED\x10\x00\x12\x18\n" + "\x14DECLARATIVE_FRIENDLY\x10\x01\"F\n" + "\x11ResourceReference\x12\x12\n" + "\x04type\x18\x01 \x01(\tR\x04type\x12\x1d\n" + "\n" + "child_type\x18\x02 \x01(\tR\tchildType:l\n" + "\x12resource_reference\x12\x1d.google.protobuf.FieldOptions\x18\x9f\b \x01(\v2\x1d.google.api.ResourceReferenceR\x11resourceReference:n\n" + "\x13resource_definition\x12\x1c.google.protobuf.FileOptions\x18\x9d\b \x03(\v2\x1e.google.api.ResourceDescriptorR\x12resourceDefinition:\\\n" + "\bresource\x12\x1f.google.protobuf.MessageOptions\x18\x9d\b \x01(\v2\x1e.google.api.ResourceDescriptorR\bresourceB\xab\x01\n" + "\x0ecom.google.apiB\rResourceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/api/annotations;annotations\xa2\x02\x03GAX\xaa\x02\n" + "Google.Api\xca\x02\n" + "Google\\Api\xe2\x02\x16Google\\Api\\GPBMetadata\xea\x02\vGoogle::Apib\x06proto3" var ( file_google_api_resource_proto_rawDescOnce sync.Once file_google_api_resource_proto_rawDescData []byte ) func file_google_api_resource_proto_rawDescGZIP() []byte { file_google_api_resource_proto_rawDescOnce.Do(func() { file_google_api_resource_proto_rawDescData = protoimpl.X.CompressGZIP(unsafe.Slice(unsafe.StringData(file_google_api_resource_proto_rawDesc), len(file_google_api_resource_proto_rawDesc))) }) return file_google_api_resource_proto_rawDescData } var file_google_api_resource_proto_enumTypes = make([]protoimpl.EnumInfo, 2) var file_google_api_resource_proto_msgTypes = make([]protoimpl.MessageInfo, 2) var file_google_api_resource_proto_goTypes = []any{ (ResourceDescriptor_History)(0), // 0: google.api.ResourceDescriptor.History (ResourceDescriptor_Style)(0), // 1: google.api.ResourceDescriptor.Style (*ResourceDescriptor)(nil), // 2: google.api.ResourceDescriptor (*ResourceReference)(nil), // 3: google.api.ResourceReference (*descriptorpb.FieldOptions)(nil), // 4: google.protobuf.FieldOptions (*descriptorpb.FileOptions)(nil), // 5: google.protobuf.FileOptions (*descriptorpb.MessageOptions)(nil), // 6: google.protobuf.MessageOptions } var file_google_api_resource_proto_depIdxs = []int32{ 0, // 0: google.api.ResourceDescriptor.history:type_name -> google.api.ResourceDescriptor.History 1, // 1: google.api.ResourceDescriptor.style:type_name -> google.api.ResourceDescriptor.Style 4, // 2: google.api.resource_reference:extendee -> google.protobuf.FieldOptions 5, // 3: google.api.resource_definition:extendee -> google.protobuf.FileOptions 6, // 4: google.api.resource:extendee -> google.protobuf.MessageOptions 3, // 5: google.api.resource_reference:type_name -> google.api.ResourceReference 2, // 6: google.api.resource_definition:type_name -> google.api.ResourceDescriptor 2, // 7: google.api.resource:type_name -> google.api.ResourceDescriptor 8, // [8:8] is the sub-list for method output_type 8, // [8:8] is the sub-list for method input_type 5, // [5:8] is the sub-list for extension type_name 2, // [2:5] is the sub-list for extension extendee 0, // [0:2] is the sub-list for field type_name } func init() { file_google_api_resource_proto_init() } func file_google_api_resource_proto_init() { if File_google_api_resource_proto != nil { return } type x struct{} out := protoimpl.TypeBuilder{ File: protoimpl.DescBuilder{ GoPackagePath: reflect.TypeOf(x{}).PkgPath(), RawDescriptor: unsafe.Slice(unsafe.StringData(file_google_api_resource_proto_rawDesc), len(file_google_api_resource_proto_rawDesc)), NumEnums: 2, NumMessages: 2, NumExtensions: 3, NumServices: 0, }, GoTypes: file_google_api_resource_proto_goTypes, DependencyIndexes: file_google_api_resource_proto_depIdxs, EnumInfos: file_google_api_resource_proto_enumTypes, MessageInfos: file_google_api_resource_proto_msgTypes, ExtensionInfos: file_google_api_resource_proto_extTypes, }.Build() File_google_api_resource_proto = out.File file_google_api_resource_proto_goTypes = nil file_google_api_resource_proto_depIdxs = nil }