Documentation
¶
Index ¶
- Variables
- type EventDie
- func (d *EventDie) APIVersion(v string) *EventDie
- func (d *EventDie) Action(v string) *EventDie
- func (d *EventDie) DeepCopy() *EventDie
- func (d *EventDie) DeepCopyObject() runtime.Object
- func (d *EventDie) DeprecatedCount(v int32) *EventDie
- func (d *EventDie) DeprecatedFirstTimestamp(v apismetav1.Time) *EventDie
- func (d *EventDie) DeprecatedLastTimestamp(v apismetav1.Time) *EventDie
- func (d *EventDie) DeprecatedSource(v corev1.EventSource) *EventDie
- func (d *EventDie) DeprecatedSourceDie(fn func(d *diecorev1.EventSourceDie)) *EventDie
- func (d *EventDie) DieFeed(r eventsv1.Event) *EventDie
- func (d *EventDie) DieFeedJSON(j []byte) *EventDie
- func (d *EventDie) DieFeedPtr(r *eventsv1.Event) *EventDie
- func (d *EventDie) DieFeedRawExtension(raw runtime.RawExtension) *EventDie
- func (d *EventDie) DieFeedYAML(y []byte) *EventDie
- func (d *EventDie) DieFeedYAMLFile(name string) *EventDie
- func (d *EventDie) DieImmutable(immutable bool) *EventDie
- func (d *EventDie) DieRelease() eventsv1.Event
- func (d *EventDie) DieReleaseJSON() []byte
- func (d *EventDie) DieReleasePtr() *eventsv1.Event
- func (d *EventDie) DieReleaseRawExtension() runtime.RawExtension
- func (d *EventDie) DieReleaseUnstructured() *unstructured.Unstructured
- func (d *EventDie) DieReleaseYAML() []byte
- func (d *EventDie) DieStamp(fn func(r *eventsv1.Event)) *EventDie
- func (d *EventDie) DieStampAt(jp string, fn interface{}) *EventDie
- func (d *EventDie) DieWith(fns ...func(d *EventDie)) *EventDie
- func (d *EventDie) EventTime(v apismetav1.MicroTime) *EventDie
- func (d *EventDie) GetObjectKind() schema.ObjectKind
- func (d *EventDie) Kind(v string) *EventDie
- func (d *EventDie) MarshalJSON() ([]byte, error)
- func (d *EventDie) MetadataDie(fn func(d *metav1.ObjectMetaDie)) *EventDie
- func (d *EventDie) Note(v string) *EventDie
- func (d *EventDie) Reason(v string) *EventDie
- func (d *EventDie) Regarding(v corev1.ObjectReference) *EventDie
- func (d *EventDie) RegardingDie(fn func(d *diecorev1.ObjectReferenceDie)) *EventDie
- func (d *EventDie) Related(v *corev1.ObjectReference) *EventDie
- func (d *EventDie) RelatedDie(fn func(d *diecorev1.ObjectReferenceDie)) *EventDie
- func (d *EventDie) ReportingController(v string) *EventDie
- func (d *EventDie) ReportingInstance(v string) *EventDie
- func (d *EventDie) Series(v *eventsv1.EventSeries) *EventDie
- func (d *EventDie) SeriesDie(fn func(d *EventSeriesDie)) *EventDie
- func (d *EventDie) Type(v string) *EventDie
- func (d *EventDie) UnmarshalJSON(b []byte) error
- type EventSeriesDie
- func (d *EventSeriesDie) Count(v int32) *EventSeriesDie
- func (d *EventSeriesDie) DeepCopy() *EventSeriesDie
- func (d *EventSeriesDie) DieFeed(r eventsv1.EventSeries) *EventSeriesDie
- func (d *EventSeriesDie) DieFeedJSON(j []byte) *EventSeriesDie
- func (d *EventSeriesDie) DieFeedPtr(r *eventsv1.EventSeries) *EventSeriesDie
- func (d *EventSeriesDie) DieFeedRawExtension(raw runtime.RawExtension) *EventSeriesDie
- func (d *EventSeriesDie) DieFeedYAML(y []byte) *EventSeriesDie
- func (d *EventSeriesDie) DieFeedYAMLFile(name string) *EventSeriesDie
- func (d *EventSeriesDie) DieImmutable(immutable bool) *EventSeriesDie
- func (d *EventSeriesDie) DieRelease() eventsv1.EventSeries
- func (d *EventSeriesDie) DieReleaseJSON() []byte
- func (d *EventSeriesDie) DieReleasePtr() *eventsv1.EventSeries
- func (d *EventSeriesDie) DieReleaseRawExtension() runtime.RawExtension
- func (d *EventSeriesDie) DieReleaseYAML() []byte
- func (d *EventSeriesDie) DieStamp(fn func(r *eventsv1.EventSeries)) *EventSeriesDie
- func (d *EventSeriesDie) DieStampAt(jp string, fn interface{}) *EventSeriesDie
- func (d *EventSeriesDie) DieWith(fns ...func(d *EventSeriesDie)) *EventSeriesDie
- func (d *EventSeriesDie) LastObservedTime(v apismetav1.MicroTime) *EventSeriesDie
Constants ¶
This section is empty.
Variables ¶
var EventBlank = (&EventDie{}).DieFeed(eventsv1.Event{})
var EventSeriesBlank = (&EventSeriesDie{}).DieFeed(eventsv1.EventSeries{})
Functions ¶
This section is empty.
Types ¶
type EventDie ¶
type EventDie struct { metav1.FrozenObjectMeta // contains filtered or unexported fields }
func (*EventDie) APIVersion ¶
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
func (*EventDie) Action ¶
action is what action was taken/failed regarding to the regarding object. It is machine-readable.
This field cannot be empty for new Events and it can have at most 128 characters.
func (*EventDie) DeepCopy ¶
DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.
func (*EventDie) DeepCopyObject ¶
func (*EventDie) DeprecatedCount ¶
deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
func (*EventDie) DeprecatedFirstTimestamp ¶
func (d *EventDie) DeprecatedFirstTimestamp(v apismetav1.Time) *EventDie
deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
func (*EventDie) DeprecatedLastTimestamp ¶
func (d *EventDie) DeprecatedLastTimestamp(v apismetav1.Time) *EventDie
deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
func (*EventDie) DeprecatedSource ¶
func (d *EventDie) DeprecatedSource(v corev1.EventSource) *EventDie
deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
func (*EventDie) DeprecatedSourceDie ¶
func (d *EventDie) DeprecatedSourceDie(fn func(d *diecorev1.EventSourceDie)) *EventDie
func (*EventDie) DieFeedJSON ¶
DieFeedJSON returns a new die with the provided JSON. Panics on error.
func (*EventDie) DieFeedPtr ¶
DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.
func (*EventDie) DieFeedRawExtension ¶
func (d *EventDie) DieFeedRawExtension(raw runtime.RawExtension) *EventDie
DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.
func (*EventDie) DieFeedYAML ¶
DieFeedYAML returns a new die with the provided YAML. Panics on error.
func (*EventDie) DieFeedYAMLFile ¶
DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.
func (*EventDie) DieImmutable ¶
DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).
func (*EventDie) DieRelease ¶
DieRelease returns the resource managed by the die.
func (*EventDie) DieReleaseJSON ¶
DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.
func (*EventDie) DieReleasePtr ¶
DieReleasePtr returns a pointer to the resource managed by the die.
func (*EventDie) DieReleaseRawExtension ¶
func (d *EventDie) DieReleaseRawExtension() runtime.RawExtension
DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.
func (*EventDie) DieReleaseUnstructured ¶
func (d *EventDie) DieReleaseUnstructured() *unstructured.Unstructured
DieReleaseUnstructured returns the resource managed by the die as an unstructured object. Panics on error.
func (*EventDie) DieReleaseYAML ¶
DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.
func (*EventDie) DieStamp ¶
DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.
func (*EventDie) DieStampAt ¶
Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.
Future iterations will improve type coercion from the resource to the callback argument.
func (*EventDie) DieWith ¶
DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.
func (*EventDie) EventTime ¶
func (d *EventDie) EventTime(v apismetav1.MicroTime) *EventDie
eventTime is the time when this Event was first observed. It is required.
func (*EventDie) GetObjectKind ¶
func (d *EventDie) GetObjectKind() schema.ObjectKind
func (*EventDie) Kind ¶
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
func (*EventDie) MarshalJSON ¶
func (*EventDie) MetadataDie ¶
func (d *EventDie) MetadataDie(fn func(d *metav1.ObjectMetaDie)) *EventDie
MetadataDie stamps the resource's ObjectMeta field with a mutable die.
func (*EventDie) Note ¶
note is a human-readable description of the status of this operation.
Maximal length of the note is 1kB, but libraries should be prepared to ¶
handle values up to 64kB.
func (*EventDie) Reason ¶
reason is why the action was taken. It is human-readable.
This field cannot be empty for new Events and it can have at most 128 characters.
func (*EventDie) Regarding ¶
func (d *EventDie) Regarding(v corev1.ObjectReference) *EventDie
regarding contains the object this Event is about. In most cases it's an Object reporting controller
implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because
it acts on some changes in a ReplicaSet object.
func (*EventDie) RegardingDie ¶
func (d *EventDie) RegardingDie(fn func(d *diecorev1.ObjectReferenceDie)) *EventDie
func (*EventDie) Related ¶
func (d *EventDie) Related(v *corev1.ObjectReference) *EventDie
related is the optional secondary object for more complex actions. E.g. when regarding object triggers
a creation or deletion of related object.
func (*EventDie) RelatedDie ¶
func (d *EventDie) RelatedDie(fn func(d *diecorev1.ObjectReferenceDie)) *EventDie
func (*EventDie) ReportingController ¶
reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
This field cannot be empty for new Events.
func (*EventDie) ReportingInstance ¶
reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`.
This field cannot be empty for new Events and it can have at most 128 characters.
func (*EventDie) Series ¶
func (d *EventDie) Series(v *eventsv1.EventSeries) *EventDie
series is data about the Event series this event represents or nil if it's a singleton Event.
func (*EventDie) SeriesDie ¶
func (d *EventDie) SeriesDie(fn func(d *EventSeriesDie)) *EventDie
func (*EventDie) Type ¶
type is the type of this event (Normal, Warning), new types could be added in the future.
It is machine-readable.
This field cannot be empty for new Events.
func (*EventDie) UnmarshalJSON ¶
type EventSeriesDie ¶
type EventSeriesDie struct {
// contains filtered or unexported fields
}
func (*EventSeriesDie) Count ¶
func (d *EventSeriesDie) Count(v int32) *EventSeriesDie
count is the number of occurrences in this series up to the last heartbeat time.
func (*EventSeriesDie) DeepCopy ¶
func (d *EventSeriesDie) DeepCopy() *EventSeriesDie
DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.
func (*EventSeriesDie) DieFeed ¶
func (d *EventSeriesDie) DieFeed(r eventsv1.EventSeries) *EventSeriesDie
DieFeed returns a new die with the provided resource.
func (*EventSeriesDie) DieFeedJSON ¶
func (d *EventSeriesDie) DieFeedJSON(j []byte) *EventSeriesDie
DieFeedJSON returns a new die with the provided JSON. Panics on error.
func (*EventSeriesDie) DieFeedPtr ¶
func (d *EventSeriesDie) DieFeedPtr(r *eventsv1.EventSeries) *EventSeriesDie
DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.
func (*EventSeriesDie) DieFeedRawExtension ¶
func (d *EventSeriesDie) DieFeedRawExtension(raw runtime.RawExtension) *EventSeriesDie
DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.
func (*EventSeriesDie) DieFeedYAML ¶
func (d *EventSeriesDie) DieFeedYAML(y []byte) *EventSeriesDie
DieFeedYAML returns a new die with the provided YAML. Panics on error.
func (*EventSeriesDie) DieFeedYAMLFile ¶
func (d *EventSeriesDie) DieFeedYAMLFile(name string) *EventSeriesDie
DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.
func (*EventSeriesDie) DieImmutable ¶
func (d *EventSeriesDie) DieImmutable(immutable bool) *EventSeriesDie
DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).
func (*EventSeriesDie) DieRelease ¶
func (d *EventSeriesDie) DieRelease() eventsv1.EventSeries
DieRelease returns the resource managed by the die.
func (*EventSeriesDie) DieReleaseJSON ¶
func (d *EventSeriesDie) DieReleaseJSON() []byte
DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.
func (*EventSeriesDie) DieReleasePtr ¶
func (d *EventSeriesDie) DieReleasePtr() *eventsv1.EventSeries
DieReleasePtr returns a pointer to the resource managed by the die.
func (*EventSeriesDie) DieReleaseRawExtension ¶
func (d *EventSeriesDie) DieReleaseRawExtension() runtime.RawExtension
DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.
func (*EventSeriesDie) DieReleaseYAML ¶
func (d *EventSeriesDie) DieReleaseYAML() []byte
DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.
func (*EventSeriesDie) DieStamp ¶
func (d *EventSeriesDie) DieStamp(fn func(r *eventsv1.EventSeries)) *EventSeriesDie
DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.
func (*EventSeriesDie) DieStampAt ¶
func (d *EventSeriesDie) DieStampAt(jp string, fn interface{}) *EventSeriesDie
Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.
Future iterations will improve type coercion from the resource to the callback argument.
func (*EventSeriesDie) DieWith ¶
func (d *EventSeriesDie) DieWith(fns ...func(d *EventSeriesDie)) *EventSeriesDie
DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.
func (*EventSeriesDie) LastObservedTime ¶
func (d *EventSeriesDie) LastObservedTime(v apismetav1.MicroTime) *EventSeriesDie
lastObservedTime is the time when last Event from the series was seen before last heartbeat.