Package k8s.io.apimachinery.pkg.runtime

Class Generated.RawExtension

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Generated.RawExtensionOrBuilder
    Enclosing class:
    Generated
    public static final class Generated.RawExtension
extends com.google.protobuf.GeneratedMessageV3
implements Generated.RawExtensionOrBuilder
     RawExtension is used to hold extensions in external versions.

 To use this, make a field which has RawExtension as its type in your external, versioned
 struct, and Object in your internal struct. You also need to register your
 various plugin types.

 // Internal package:

        type MyAPIObject struct {
                runtime.TypeMeta `json:",inline"`
                MyPlugin runtime.Object `json:"myPlugin"`
        }

        type PluginA struct {
                AOption string `json:"aOption"`
        }

 // External package:

        type MyAPIObject struct {
                runtime.TypeMeta `json:",inline"`
                MyPlugin runtime.RawExtension `json:"myPlugin"`
        }

        type PluginA struct {
                AOption string `json:"aOption"`
        }

 // On the wire, the JSON will look something like this:

        {
                "kind":"MyAPIObject",
                "apiVersion":"v1",
                "myPlugin": {
                        "kind":"PluginA",
                        "aOption":"foo",
                },
        }

 So what happens? Decode first uses json or yaml to unmarshal the serialized data into
 your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked.
 The next step is to copy (using pkg/conversion) into the internal struct. The runtime
 package's DefaultScheme has conversion functions installed which will unpack the
 JSON stored in RawExtension, turning it into the correct object type, and storing it
 in the Object. (TODO: In the case where the object is of an unknown type, a
 runtime.Unknown object will be created and stored.)

 +k8s:deepcopy-gen=true
 +protobuf=true
 +k8s:openapi-gen=true
    Protobuf type k8s.io.apimachinery.pkg.runtime.RawExtension
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Generated.RawExtension.Builder
      RawExtension is used to hold extensions in external versions.

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static com.google.protobuf.Parser<Generated.RawExtension> PARSER
      Deprecated.
      static int RAW_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

      • 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

      • hasRaw

        public boolean hasRaw()
         Raw is the underlying serialization of this object.

 TODO: Determine how to detect ContentType and ContentEncoding of 'Raw' data.
        optional bytes raw = 1;
        Specified by:
        hasRaw in interface Generated.RawExtensionOrBuilder
        Returns:
        Whether the raw field is set.

      • getRaw

        public com.google.protobuf.ByteString getRaw()
         Raw is the underlying serialization of this object.

 TODO: Determine how to detect ContentType and ContentEncoding of 'Raw' data.
        optional bytes raw = 1;
        Specified by:
        getRaw in interface Generated.RawExtensionOrBuilder
        Returns:
        The raw.

      • 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 Generated.RawExtension parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<Generated.RawExtension> 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 Generated.RawExtension getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder