Package org.cdk8s.plus24.k8s

Interface ListMeta

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ListMeta.Jsii$Proxy

@Generated(value="jsii-pacmak/1.76.0 (build a2651be)",
           date="2023-03-05T02:40:33.652Z")
@Stability(Stable)
public interface ListMeta
extends software.amazon.jsii.JsiiSerializable

ListMeta describes metadata that synthetic resources must have, including lists and various status objects.

A resource may have only one of {ObjectMeta, ListMeta}.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ListMeta.Builder	A builder for ListMeta
static class	ListMeta.Jsii$Proxy	An implementation for ListMeta

Method Summary

Modifier and Type	Method	Description
static ListMeta.Builder	builder()
default String	getContinueValue()	continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available.
default Number	getRemainingItemCount()	remainingItemCount is the number of subsequent items in the list which are not included in this list response.
default String	getResourceVersion()	String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed.
default String	getSelfLink()	Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContinueValue

@Stability(Stable)
@Nullable
default String getContinueValue()

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available.

The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

getRemainingItemCount

@Stability(Stable)
@Nullable
default Number getRemainingItemCount()

remainingItemCount is the number of subsequent items in the list which are not included in this list response.

If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

getResourceVersion

@Stability(Stable)
@Nullable
default String getResourceVersion()

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed.

Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

getSelfLink

@Stability(Stable)
@Nullable
default String getSelfLink()

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

builder

@Stability(Stable)
static ListMeta.Builder builder()

Returns:

a ListMeta.Builder of ListMeta