Send feedback
ResourceReference
Stay organized with collections
Save and categorize content based on your preferences.
Defines a proto annotation that describes a string field that refers to an API resource.
JSON representation
{
"type" : string ,
"childType" : string
}
Fields
type
string
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: "*"
}];
}
childType
string
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) = {
childType: "logging.googleapis.com/LogEntry"
};
}
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-06-15 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?