Package io.kubernetes.client.proto

Class V1.ObjectReference

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.kubernetes.client.proto.V1.ObjectReference
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, V1.ObjectReferenceOrBuilder, Serializable
Enclosing class:
V1
public static final class V1.ObjectReference extends com.google.protobuf.GeneratedMessageV3 implements V1.ObjectReferenceOrBuilder
 ObjectReference contains enough information to let you inspect or modify the referred object.
 ---
 New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
  1. Ignored fields.  It includes many fields which are not generally honored.  For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.
  2. Invalid usage help.  It is impossible to add specific help for individual usage.  In most embedded usages, there are particular
     restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted".
     Those cannot be well described when embedded.
  3. Inconsistent validation.  Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.
  4. The fields are both imprecise and overly precise.  Kind is not a precise mapping to a URL. This can produce ambiguity
     during interpretation and require a REST mapping.  In most cases, the dependency is on the group,resource tuple
     and the version of the actual struct is irrelevant.
  5. We cannot easily change it.  Because this type is embedded in many locations, updates to this type
     will affect numerous schemas.  Don't make new APIs embed an underspecified API type they do not control.
 Instead of using this type, create a locally provided and used type that is well-focused on your reference.
 For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .
 +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 +structType=atomic
Protobuf type k8s.io.api.core.v1.ObjectReference
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    V1.ObjectReference.Builder
    ObjectReference contains enough information to let you inspect or modify the referred object.

    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 final int
    APIVERSION_FIELD_NUMBER
     
    static final int
    FIELDPATH_FIELD_NUMBER
     
    static final int
    KIND_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    NAMESPACE_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<V1.ObjectReference>
    PARSER
    Deprecated.
    static final int
    RESOURCEVERSION_FIELD_NUMBER
     
    static final int
    UID_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 Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getApiVersion()
    API version of the referent.
    com.google.protobuf.ByteString
    getApiVersionBytes()
    API version of the referent.
    static V1.ObjectReference
    getDefaultInstance()
     
    V1.ObjectReference
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFieldPath()
    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
    com.google.protobuf.ByteString
    getFieldPathBytes()
    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
    String
    getKind()
    Kind of the referent.
    com.google.protobuf.ByteString
    getKindBytes()
    Kind of the referent.
    String
    getName()
    Name of the referent.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the referent.
    String
    getNamespace()
    Namespace of the referent.
    com.google.protobuf.ByteString
    getNamespaceBytes()
    Namespace of the referent.
    com.google.protobuf.Parser<V1.ObjectReference>
    getParserForType()
     
    String
    getResourceVersion()
    Specific resourceVersion to which this reference is made, if any.
    com.google.protobuf.ByteString
    getResourceVersionBytes()
    Specific resourceVersion to which this reference is made, if any.
    int
    getSerializedSize()
     
    String
    getUid()
    UID of the referent.
    com.google.protobuf.ByteString
    getUidBytes()
    UID of the referent.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    boolean
    hasApiVersion()
    API version of the referent.
    boolean
    hasFieldPath()
    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
    int
    hashCode()
     
    boolean
    hasKind()
    Kind of the referent.
    boolean
    hasName()
    Name of the referent.
    boolean
    hasNamespace()
    Namespace of the referent.
    boolean
    hasResourceVersion()
    Specific resourceVersion to which this reference is made, if any.
    boolean
    hasUid()
    UID of the referent.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static V1.ObjectReference.Builder
    newBuilder()
     
    static V1.ObjectReference.Builder
    newBuilder(V1.ObjectReference prototype)
     
    V1.ObjectReference.Builder
    newBuilderForType()
     
    protected V1.ObjectReference.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    static V1.ObjectReference
    parseDelimitedFrom(InputStream input)
     
    static V1.ObjectReference
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.ObjectReference
    parseFrom(byte[] data)
     
    static V1.ObjectReference
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.ObjectReference
    parseFrom(com.google.protobuf.ByteString data)
     
    static V1.ObjectReference
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.ObjectReference
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static V1.ObjectReference
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.ObjectReference
    parseFrom(InputStream input)
     
    static V1.ObjectReference
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.ObjectReference
    parseFrom(ByteBuffer data)
     
    static V1.ObjectReference
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<V1.ObjectReference>
    parser()
     
    V1.ObjectReference.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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, hasField, hasOneof

  • Field Details

  • Method Details

    • 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

    • hasKind

      public boolean hasKind()
       Kind of the referent.
 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
 +optional
      optional string kind = 1;
      Specified by:
      hasKind in interface V1.ObjectReferenceOrBuilder

    • getKind

      public String getKind()
       Kind of the referent.
 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
 +optional
      optional string kind = 1;
      Specified by:
      getKind in interface V1.ObjectReferenceOrBuilder

    • getKindBytes

      public com.google.protobuf.ByteString getKindBytes()
       Kind of the referent.
 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
 +optional
      optional string kind = 1;
      Specified by:
      getKindBytes in interface V1.ObjectReferenceOrBuilder

    • hasNamespace

      public boolean hasNamespace()
       Namespace of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
 +optional
      optional string namespace = 2;
      Specified by:
      hasNamespace in interface V1.ObjectReferenceOrBuilder

    • getNamespace

      public String getNamespace()
       Namespace of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
 +optional
      optional string namespace = 2;
      Specified by:
      getNamespace in interface V1.ObjectReferenceOrBuilder

    • getNamespaceBytes

      public com.google.protobuf.ByteString getNamespaceBytes()
       Namespace of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
 +optional
      optional string namespace = 2;
      Specified by:
      getNamespaceBytes in interface V1.ObjectReferenceOrBuilder

    • hasName

      public boolean hasName()
       Name of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 +optional
      optional string name = 3;
      Specified by:
      hasName in interface V1.ObjectReferenceOrBuilder

    • getName

      public String getName()
       Name of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 +optional
      optional string name = 3;
      Specified by:
      getName in interface V1.ObjectReferenceOrBuilder

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 +optional
      optional string name = 3;
      Specified by:
      getNameBytes in interface V1.ObjectReferenceOrBuilder

    • hasUid

      public boolean hasUid()
       UID of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 +optional
      optional string uid = 4;
      Specified by:
      hasUid in interface V1.ObjectReferenceOrBuilder

    • getUid

      public String getUid()
       UID of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 +optional
      optional string uid = 4;
      Specified by:
      getUid in interface V1.ObjectReferenceOrBuilder

    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       UID of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 +optional
      optional string uid = 4;
      Specified by:
      getUidBytes in interface V1.ObjectReferenceOrBuilder

    • hasApiVersion

      public boolean hasApiVersion()
       API version of the referent.
 +optional
      optional string apiVersion = 5;
      Specified by:
      hasApiVersion in interface V1.ObjectReferenceOrBuilder

    • getApiVersion

      public String getApiVersion()
       API version of the referent.
 +optional
      optional string apiVersion = 5;
      Specified by:
      getApiVersion in interface V1.ObjectReferenceOrBuilder

    • getApiVersionBytes

      public com.google.protobuf.ByteString getApiVersionBytes()
       API version of the referent.
 +optional
      optional string apiVersion = 5;
      Specified by:
      getApiVersionBytes in interface V1.ObjectReferenceOrBuilder

    • hasResourceVersion

      public boolean hasResourceVersion()
       Specific resourceVersion to which this reference is made, if any.
 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
 +optional
      optional string resourceVersion = 6;
      Specified by:
      hasResourceVersion in interface V1.ObjectReferenceOrBuilder

    • getResourceVersion

      public String getResourceVersion()
       Specific resourceVersion to which this reference is made, if any.
 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
 +optional
      optional string resourceVersion = 6;
      Specified by:
      getResourceVersion in interface V1.ObjectReferenceOrBuilder

    • getResourceVersionBytes

      public com.google.protobuf.ByteString getResourceVersionBytes()
       Specific resourceVersion to which this reference is made, if any.
 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
 +optional
      optional string resourceVersion = 6;
      Specified by:
      getResourceVersionBytes in interface V1.ObjectReferenceOrBuilder

    • hasFieldPath

      public boolean hasFieldPath()
       If referring to a piece of an object instead of an entire object, this string
 should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
 For example, if the object reference is to a container within a pod, this would take on a value like:
 "spec.containers{name}" (where "name" refers to the name of the container that triggered
 the event) or if no container name is specified "spec.containers[2]" (container with
 index 2 in this pod). This syntax is chosen only to have some well-defined way of
 referencing a part of an object.
 TODO: this design is not final and this field is subject to change in the future.
 +optional
      optional string fieldPath = 7;
      Specified by:
      hasFieldPath in interface V1.ObjectReferenceOrBuilder

    • getFieldPath

      public String getFieldPath()
       If referring to a piece of an object instead of an entire object, this string
 should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
 For example, if the object reference is to a container within a pod, this would take on a value like:
 "spec.containers{name}" (where "name" refers to the name of the container that triggered
 the event) or if no container name is specified "spec.containers[2]" (container with
 index 2 in this pod). This syntax is chosen only to have some well-defined way of
 referencing a part of an object.
 TODO: this design is not final and this field is subject to change in the future.
 +optional
      optional string fieldPath = 7;
      Specified by:
      getFieldPath in interface V1.ObjectReferenceOrBuilder

    • getFieldPathBytes

      public com.google.protobuf.ByteString getFieldPathBytes()
       If referring to a piece of an object instead of an entire object, this string
 should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
 For example, if the object reference is to a container within a pod, this would take on a value like:
 "spec.containers{name}" (where "name" refers to the name of the container that triggered
 the event) or if no container name is specified "spec.containers[2]" (container with
 index 2 in this pod). This syntax is chosen only to have some well-defined way of
 referencing a part of an object.
 TODO: this design is not final and this field is subject to change in the future.
 +optional
      optional string fieldPath = 7;
      Specified by:
      getFieldPathBytes in interface V1.ObjectReferenceOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static V1.ObjectReference parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static V1.ObjectReference parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static V1.ObjectReference.Builder newBuilder()

    • newBuilder

      public static V1.ObjectReference.Builder newBuilder(V1.ObjectReference prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static V1.ObjectReference getDefaultInstance()

    • parser

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

    • getParserForType

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