65 lines
2.4 KiB
Markdown
65 lines
2.4 KiB
Markdown
---
|
|
api_metadata:
|
|
apiVersion: ""
|
|
import: "k8s.io/api/core/v1"
|
|
kind: "ObjectReference"
|
|
content_type: "api_reference"
|
|
description: "ObjectReference contains enough information to let you inspect or modify the referred object."
|
|
title: "ObjectReference"
|
|
weight: 8
|
|
auto_generated: true
|
|
---
|
|
|
|
<!--
|
|
The file is auto-generated from the Go source code of the component using a generic
|
|
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
|
|
to generate the reference documentation, please read
|
|
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
|
|
To update the reference content, please follow the
|
|
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
|
|
guide. You can file document formatting bugs against the
|
|
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
|
|
-->
|
|
|
|
|
|
|
|
`import "k8s.io/api/core/v1"`
|
|
|
|
|
|
ObjectReference contains enough information to let you inspect or modify the referred object.
|
|
|
|
<hr>
|
|
|
|
- **apiVersion** (string)
|
|
|
|
API version of the referent.
|
|
|
|
- **fieldPath** (string)
|
|
|
|
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.
|
|
|
|
- **kind** (string)
|
|
|
|
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
|
|
|
- **name** (string)
|
|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
|
|
|
- **namespace** (string)
|
|
|
|
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
|
|
|
- **resourceVersion** (string)
|
|
|
|
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
|
|
|
|
- **uid** (string)
|
|
|
|
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
|
|
|
|
|
|
|
|
|
|
|