Package com.google.api

Class ResourceReference

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<ResourceReference,ResourceReference.Builder>
com.google.api.ResourceReference
All Implemented Interfaces:
ResourceReferenceOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
public final class ResourceReference extends com.google.protobuf.GeneratedMessageLite<ResourceReference,ResourceReference.Builder> implements ResourceReferenceOrBuilder
 Defines a proto annotation that describes a string field that refers to
 an API resource.
Protobuf type google.api.ResourceReference

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ResourceReference.Builder
    Defines a proto annotation that describes a string field that refers to an API resource.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CHILD_TYPE_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    String
    getChildType()
    The resource type of a child collection that the annotated field references.
    com.google.protobuf.ByteString
    getChildTypeBytes()
    The resource type of a child collection that the annotated field references.
    static ResourceReference
    getDefaultInstance()
     
    String
    getType()
    The resource type that the annotated field references.
    com.google.protobuf.ByteString
    getTypeBytes()
    The resource type that the annotated field references.
    static ResourceReference.Builder
    newBuilder()
     
    static ResourceReference.Builder
    newBuilder(ResourceReference prototype)
     
    static ResourceReference
    parseDelimitedFrom(InputStream input)
     
    static ResourceReference
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResourceReference
    parseFrom(byte[] data)
     
    static ResourceReference
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResourceReference
    parseFrom(com.google.protobuf.ByteString data)
     
    static ResourceReference
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResourceReference
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ResourceReference
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResourceReference
    parseFrom(InputStream input)
     
    static ResourceReference
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResourceReference
    parseFrom(ByteBuffer data)
     
    static ResourceReference
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ResourceReference>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • getType

      public String 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 [json_name = "type"];
      Specified by:
      getType in interface ResourceReferenceOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.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 [json_name = "type"];
      Specified by:
      getTypeBytes in interface ResourceReferenceOrBuilder
      Returns:
      The bytes for type.

    • 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 [json_name = "childType"];
      Specified by:
      getChildType in interface ResourceReferenceOrBuilder
      Returns:
      The childType.

    • getChildTypeBytes

      public com.google.protobuf.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 [json_name = "childType"];
      Specified by:
      getChildTypeBytes in interface ResourceReferenceOrBuilder
      Returns:
      The bytes for childType.

    • parseFrom

      public static ResourceReference parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceReference parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceReference parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceReference parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceReference parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceReference parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceReference parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResourceReference parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResourceReference parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResourceReference parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResourceReference parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResourceReference parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static ResourceReference.Builder newBuilder()

    • newBuilder

      public static ResourceReference.Builder newBuilder(ResourceReference prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<ResourceReference,ResourceReference.Builder>

    • getDefaultInstance

      public static ResourceReference getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ResourceReference> parser()