Package com.google.api

Class FieldInfo

  • All Implemented Interfaces:
    FieldInfoOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class FieldInfo
extends com.google.protobuf.GeneratedMessageV3
implements FieldInfoOrBuilder
     Rich semantic information of an API field beyond basic typing.
    Protobuf type google.api.FieldInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FieldInfo.Builder
      Rich semantic information of an API field beyond basic typing.
      static class  FieldInfo.Format
      The standard format of a field value.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FORMAT_FIELD_NUMBER  
      static int REFERENCED_TYPES_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static FieldInfo getDefaultInstance()  
      FieldInfo getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      FieldInfo.Format getFormat()
      The standard format of a field value.
      int getFormatValue()
      The standard format of a field value.
      com.google.protobuf.Parser<FieldInfo> getParserForType()  
      TypeReference getReferencedTypes​(int index)
      The type(s) that the annotated, generic field may represent.
      int getReferencedTypesCount()
      The type(s) that the annotated, generic field may represent.
      java.util.List<TypeReference> getReferencedTypesList()
      The type(s) that the annotated, generic field may represent.
      TypeReferenceOrBuilder getReferencedTypesOrBuilder​(int index)
      The type(s) that the annotated, generic field may represent.
      java.util.List<? extends TypeReferenceOrBuilder> getReferencedTypesOrBuilderList()
      The type(s) that the annotated, generic field may represent.
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static FieldInfo.Builder newBuilder()  
      static FieldInfo.Builder newBuilder​(FieldInfo prototype)  
      FieldInfo.Builder newBuilderForType()  
      protected FieldInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static FieldInfo parseDelimitedFrom​(java.io.InputStream input)  
      static FieldInfo parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FieldInfo parseFrom​(byte[] data)  
      static FieldInfo parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FieldInfo parseFrom​(com.google.protobuf.ByteString data)  
      static FieldInfo parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FieldInfo parseFrom​(com.google.protobuf.CodedInputStream input)  
      static FieldInfo parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FieldInfo parseFrom​(java.io.InputStream input)  
      static FieldInfo parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FieldInfo parseFrom​(java.nio.ByteBuffer data)  
      static FieldInfo parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<FieldInfo> parser()  
      FieldInfo.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType

      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • REFERENCED_TYPES_FIELD_NUMBER

        public static final int REFERENCED_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getFormatValue

        public int getFormatValue()
         The standard format of a field value. This does not explicitly configure
 any API consumer, just documents the API's format for the field it is
 applied to.
        .google.api.FieldInfo.Format format = 1;
        Specified by:
        getFormatValue in interface FieldInfoOrBuilder
        Returns:
        The enum numeric value on the wire for format.

      • getFormat

        public FieldInfo.Format getFormat()
         The standard format of a field value. This does not explicitly configure
 any API consumer, just documents the API's format for the field it is
 applied to.
        .google.api.FieldInfo.Format format = 1;
        Specified by:
        getFormat in interface FieldInfoOrBuilder
        Returns:
        The format.

      • getReferencedTypesList

        public java.util.List<TypeReference> getReferencedTypesList()
         The type(s) that the annotated, generic field may represent.

 Currently, this must only be used on fields of type `google.protobuf.Any`.
 Supporting other generic types may be considered in the future.
        repeated .google.api.TypeReference referenced_types = 2;
        Specified by:
        getReferencedTypesList in interface FieldInfoOrBuilder

      • getReferencedTypesOrBuilderList

        public java.util.List<? extends TypeReferenceOrBuilder> getReferencedTypesOrBuilderList()
         The type(s) that the annotated, generic field may represent.

 Currently, this must only be used on fields of type `google.protobuf.Any`.
 Supporting other generic types may be considered in the future.
        repeated .google.api.TypeReference referenced_types = 2;
        Specified by:
        getReferencedTypesOrBuilderList in interface FieldInfoOrBuilder

      • getReferencedTypesCount

        public int getReferencedTypesCount()
         The type(s) that the annotated, generic field may represent.

 Currently, this must only be used on fields of type `google.protobuf.Any`.
 Supporting other generic types may be considered in the future.
        repeated .google.api.TypeReference referenced_types = 2;
        Specified by:
        getReferencedTypesCount in interface FieldInfoOrBuilder

      • getReferencedTypes

        public TypeReference getReferencedTypes​(int index)
         The type(s) that the annotated, generic field may represent.

 Currently, this must only be used on fields of type `google.protobuf.Any`.
 Supporting other generic types may be considered in the future.
        repeated .google.api.TypeReference referenced_types = 2;
        Specified by:
        getReferencedTypes in interface FieldInfoOrBuilder

      • getReferencedTypesOrBuilder

        public TypeReferenceOrBuilder getReferencedTypesOrBuilder​(int index)
         The type(s) that the annotated, generic field may represent.

 Currently, this must only be used on fields of type `google.protobuf.Any`.
 Supporting other generic types may be considered in the future.
        repeated .google.api.TypeReference referenced_types = 2;
        Specified by:
        getReferencedTypesOrBuilder in interface FieldInfoOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static FieldInfo parseFrom​(java.nio.ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FieldInfo parseFrom​(java.nio.ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static FieldInfo parseFrom​(java.io.InputStream input)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FieldInfo parseFrom​(java.io.InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static FieldInfo parseDelimitedFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static FieldInfo parseDelimitedFrom​(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FieldInfo parseFrom​(com.google.protobuf.CodedInputStream input)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FieldInfo parseFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public FieldInfo.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public FieldInfo.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected FieldInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static FieldInfo getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<FieldInfo> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

        public FieldInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder