Package k8s.io.api.core.v1

Class Generated.ObjectReference.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Generated.ObjectReferenceOrBuilder
    Enclosing class:
    Generated.ObjectReference
    public static final class Generated.ObjectReference.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Generated.ObjectReference.Builder>
implements Generated.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

    • Method Detail

      • 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.Builder<Generated.ObjectReference.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Generated.ObjectReference.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • setRepeatedField

        public Generated.ObjectReference.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Generated.ObjectReference.Builder>

      • isInitialized

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

      • mergeFrom

        public Generated.ObjectReference.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Generated.ObjectReference.Builder>
        Throws:
        IOException

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        Whether the kind field is set.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The kind.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The bytes for kind.

      • setKind

        public Generated.ObjectReference.Builder setKind​(String value)
         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;
        Parameters:
        value - The kind to set.
        Returns:
        This builder for chaining.

      • clearKind

        public Generated.ObjectReference.Builder clearKind()
         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;
        Returns:
        This builder for chaining.

      • setKindBytes

        public Generated.ObjectReference.Builder setKindBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for kind to set.
        Returns:
        This builder for chaining.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        Whether the namespace field is set.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The namespace.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The bytes for namespace.

      • setNamespace

        public Generated.ObjectReference.Builder setNamespace​(String value)
         Namespace of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
 +optional
        optional string namespace = 2;
        Parameters:
        value - The namespace to set.
        Returns:
        This builder for chaining.

      • clearNamespace

        public Generated.ObjectReference.Builder clearNamespace()
         Namespace of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
 +optional
        optional string namespace = 2;
        Returns:
        This builder for chaining.

      • setNamespaceBytes

        public Generated.ObjectReference.Builder setNamespaceBytes​(com.google.protobuf.ByteString value)
         Namespace of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
 +optional
        optional string namespace = 2;
        Parameters:
        value - The bytes for namespace to set.
        Returns:
        This builder for chaining.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        Whether the name field is set.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The name.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Generated.ObjectReference.Builder setName​(String value)
         Name of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 +optional
        optional string name = 3;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Generated.ObjectReference.Builder clearName()
         Name of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 +optional
        optional string name = 3;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Generated.ObjectReference.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Name of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 +optional
        optional string name = 3;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        Whether the uid field is set.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The uid.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The bytes for uid.

      • setUid

        public Generated.ObjectReference.Builder setUid​(String value)
         UID of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 +optional
        optional string uid = 4;
        Parameters:
        value - The uid to set.
        Returns:
        This builder for chaining.

      • clearUid

        public Generated.ObjectReference.Builder clearUid()
         UID of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 +optional
        optional string uid = 4;
        Returns:
        This builder for chaining.

      • setUidBytes

        public Generated.ObjectReference.Builder setUidBytes​(com.google.protobuf.ByteString value)
         UID of the referent.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 +optional
        optional string uid = 4;
        Parameters:
        value - The bytes for uid to set.
        Returns:
        This builder for chaining.

      • hasApiVersion

        public boolean hasApiVersion()
         API version of the referent.
 +optional
        optional string apiVersion = 5;
        Specified by:
        hasApiVersion in interface Generated.ObjectReferenceOrBuilder
        Returns:
        Whether the apiVersion field is set.

      • getApiVersionBytes

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

      • setApiVersion

        public Generated.ObjectReference.Builder setApiVersion​(String value)
         API version of the referent.
 +optional
        optional string apiVersion = 5;
        Parameters:
        value - The apiVersion to set.
        Returns:
        This builder for chaining.

      • clearApiVersion

        public Generated.ObjectReference.Builder clearApiVersion()
         API version of the referent.
 +optional
        optional string apiVersion = 5;
        Returns:
        This builder for chaining.

      • setApiVersionBytes

        public Generated.ObjectReference.Builder setApiVersionBytes​(com.google.protobuf.ByteString value)
         API version of the referent.
 +optional
        optional string apiVersion = 5;
        Parameters:
        value - The bytes for apiVersion to set.
        Returns:
        This builder for chaining.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        Whether the resourceVersion field is set.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The resourceVersion.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The bytes for resourceVersion.

      • setResourceVersion

        public Generated.ObjectReference.Builder setResourceVersion​(String value)
         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;
        Parameters:
        value - The resourceVersion to set.
        Returns:
        This builder for chaining.

      • clearResourceVersion

        public Generated.ObjectReference.Builder clearResourceVersion()
         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;
        Returns:
        This builder for chaining.

      • setResourceVersionBytes

        public Generated.ObjectReference.Builder setResourceVersionBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for resourceVersion to set.
        Returns:
        This builder for chaining.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        Whether the fieldPath field is set.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The fieldPath.

      • 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 Generated.ObjectReferenceOrBuilder
        Returns:
        The bytes for fieldPath.

      • setFieldPath

        public Generated.ObjectReference.Builder setFieldPath​(String value)
         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;
        Parameters:
        value - The fieldPath to set.
        Returns:
        This builder for chaining.

      • clearFieldPath

        public Generated.ObjectReference.Builder clearFieldPath()
         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;
        Returns:
        This builder for chaining.

      • setFieldPathBytes

        public Generated.ObjectReference.Builder setFieldPathBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for fieldPath to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Generated.ObjectReference.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Generated.ObjectReference.Builder>

      • mergeUnknownFields

        public final Generated.ObjectReference.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Generated.ObjectReference.Builder>