Package com.github.udpa.udpa.type.v1

Class TypedStruct

  • All Implemented Interfaces:
    TypedStructOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TypedStruct
extends com.google.protobuf.GeneratedMessageV3
implements TypedStructOrBuilder
     A TypedStruct contains an arbitrary JSON serialized protocol buffer message with a URL that
 describes the type of the serialized message. This is very similar to google.protobuf.Any,
 instead of having protocol buffer binary, this employs google.protobuf.Struct as value.
 This message is intended to be embedded inside Any, so it shouldn't be directly referred
 from other UDPA messages.
 When packing an opaque extension config, packing the expected type into Any is preferred
 wherever possible for its efficiency. TypedStruct should be used only if a proto descriptor
 is not available, for example if:
 - A control plane sends opaque message that is originally from external source in human readable
   format such as JSON or YAML.
 - The control plane doesn't have the knowledge of the protocol buffer schema hence it cannot
   serialize the message in protocol buffer binary format.
 - The DPLB doesn't have have the knowledge of the protocol buffer schema its plugin or extension
   uses. This has to be indicated in the DPLB capability negotiation.
 When a DPLB receives a TypedStruct in Any, it should:
 - Check if the type_url of the TypedStruct matches the type the extension expects.
 - Convert value to the type described in type_url and perform validation.
 TODO(lizan): Figure out how TypeStruct should be used with DPLB extensions that doesn't link
 protobuf descriptor with DPLB itself, (e.g. gRPC LB Plugin, Envoy WASM extensions).
    Protobuf type udpa.type.v1.TypedStruct
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TypedStruct.Builder
      A TypedStruct contains an arbitrary JSON serialized protocol buffer message with a URL that describes the type of the serialized message.

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

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

      • 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 TYPE_URL_FIELD_NUMBER  
      static int VALUE_FIELD_NUMBER  

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

        alwaysUseFieldBuilders, unknownFields

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

        memoizedSize

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

        memoizedHashCode

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getTypeUrl

        public String getTypeUrl()
         A URL that uniquely identifies the type of the serialize protocol buffer message.
 This has same semantics and format described in google.protobuf.Any:
 https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/any.proto
        string type_url = 1;
        Specified by:
        getTypeUrl in interface TypedStructOrBuilder
        Returns:
        The typeUrl.

      • getTypeUrlBytes

        public com.google.protobuf.ByteString getTypeUrlBytes()
         A URL that uniquely identifies the type of the serialize protocol buffer message.
 This has same semantics and format described in google.protobuf.Any:
 https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/any.proto
        string type_url = 1;
        Specified by:
        getTypeUrlBytes in interface TypedStructOrBuilder
        Returns:
        The bytes for typeUrl.

      • hasValue

        public boolean hasValue()
         A JSON representation of the above specified type.
        .google.protobuf.Struct value = 2;
        Specified by:
        hasValue in interface TypedStructOrBuilder
        Returns:
        Whether the value field is set.

      • getValue

        public com.google.protobuf.Struct getValue()
         A JSON representation of the above specified type.
        .google.protobuf.Struct value = 2;
        Specified by:
        getValue in interface TypedStructOrBuilder
        Returns:
        The value.

      • getValueOrBuilder

        public com.google.protobuf.StructOrBuilder getValueOrBuilder()
         A JSON representation of the above specified type.
        .google.protobuf.Struct value = 2;
        Specified by:
        getValueOrBuilder in interface TypedStructOrBuilder

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(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 TypedStruct parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static TypedStruct getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<TypedStruct> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public TypedStruct getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder