Send feedback
  
   
 
  
    
      Class ResourceReference (2.26.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 2.26.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  ResourceReference   extends   GeneratedMessageV3   implements   ResourceReferenceOrBuilder  
   
   Defines a proto annotation that describes a string field that refers to
 an API resource.
 Protobuf type google.api.ResourceReference
 
  
  
  
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  CHILD_TYPE_FIELD_NUMBER 
  
    
public   static   final   int   CHILD_TYPE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  TYPE_FIELD_NUMBER 
  
    
public   static   final   int   TYPE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   ResourceReference   getDefaultInstance ()  
   
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   ResourceReference . Builder   newBuilder ()  
   
  
   
  newBuilder(ResourceReference prototype) 
  
    
public   static   ResourceReference . Builder   newBuilder ( ResourceReference   prototype )  
   
  
  
   
  
  
    
public   static   ResourceReference   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   ResourceReference   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   ResourceReference   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ResourceReference   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   ResourceReference   parseFrom ( ByteString   data )  
   
  
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ResourceReference   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   ResourceReference   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   ResourceReference   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   ResourceReference   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   ResourceReference   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   ResourceReference   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ResourceReference   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parser() 
  
    
public   static   Parser<ResourceReference>   parser ()  
   
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getChildType() 
  
    
public   String   getChildType ()  
   
   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"
   };
 }
 string child_type = 2;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The childType.
 
       
     
  
   
  getChildTypeBytes() 
  
    
public   ByteString   getChildTypeBytes ()  
   
   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"
   };
 }
 string child_type = 2;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for childType.
 
       
     
  
   
  getDefaultInstanceForType() 
  
    
public   ResourceReference   getDefaultInstanceForType ()  
   
  
   
  getParserForType() 
  
    
public   Parser<ResourceReference>   getParserForType ()  
   
  
  Overrides 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  getType() 
  
   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: "*"
   }];
 }
 string type = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The type.
 
       
     
  
   
  getTypeBytes() 
  
    
public   ByteString   getTypeBytes ()  
   
   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: "*"
   }];
 }
 string type = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for type.
 
       
     
  
   
  hashCode() 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   ResourceReference . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   ResourceReference . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   ResourceReference . Builder   toBuilder ()  
   
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    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 2025-10-30 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]