Package k8s.io.apimachinery.pkg.apis.meta.v1

Interface Generated.ListOptionsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Generated.ListOptions, Generated.ListOptions.Builder
    Enclosing class:
    Generated
    public static interface Generated.ListOptionsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getAllowWatchBookmarks()
      allowWatchBookmarks requests watch events with type "BOOKMARK".
      String getContinue()
      The continue option should be set when retrieving more results from the server.
      com.google.protobuf.ByteString getContinueBytes()
      The continue option should be set when retrieving more results from the server.
      String getFieldSelector()
      A selector to restrict the list of returned objects by their fields.
      com.google.protobuf.ByteString getFieldSelectorBytes()
      A selector to restrict the list of returned objects by their fields.
      String getLabelSelector()
      A selector to restrict the list of returned objects by their labels.
      com.google.protobuf.ByteString getLabelSelectorBytes()
      A selector to restrict the list of returned objects by their labels.
      long getLimit()
      limit is a maximum number of responses to return for a list call.
      String getResourceVersion()
      resourceVersion sets a constraint on what resource versions a request may be served from.
      com.google.protobuf.ByteString getResourceVersionBytes()
      resourceVersion sets a constraint on what resource versions a request may be served from.
      String getResourceVersionMatch()
      resourceVersionMatch determines how resourceVersion is applied to list calls.
      com.google.protobuf.ByteString getResourceVersionMatchBytes()
      resourceVersionMatch determines how resourceVersion is applied to list calls.
      boolean getSendInitialEvents()
      `sendInitialEvents=true` may be set together with `watch=true`.
      long getTimeoutSeconds()
      Timeout for the list/watch call.
      boolean getWatch()
      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
      boolean hasAllowWatchBookmarks()
      allowWatchBookmarks requests watch events with type "BOOKMARK".
      boolean hasContinue()
      The continue option should be set when retrieving more results from the server.
      boolean hasFieldSelector()
      A selector to restrict the list of returned objects by their fields.
      boolean hasLabelSelector()
      A selector to restrict the list of returned objects by their labels.
      boolean hasLimit()
      limit is a maximum number of responses to return for a list call.
      boolean hasResourceVersion()
      resourceVersion sets a constraint on what resource versions a request may be served from.
      boolean hasResourceVersionMatch()
      resourceVersionMatch determines how resourceVersion is applied to list calls.
      boolean hasSendInitialEvents()
      `sendInitialEvents=true` may be set together with `watch=true`.
      boolean hasTimeoutSeconds()
      Timeout for the list/watch call.
      boolean hasWatch()
      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasLabelSelector

        boolean hasLabelSelector()
         A selector to restrict the list of returned objects by their labels.
 Defaults to everything.
 +optional
        optional string labelSelector = 1;
        Returns:
        Whether the labelSelector field is set.

      • getLabelSelector

        String getLabelSelector()
         A selector to restrict the list of returned objects by their labels.
 Defaults to everything.
 +optional
        optional string labelSelector = 1;
        Returns:
        The labelSelector.

      • getLabelSelectorBytes

        com.google.protobuf.ByteString getLabelSelectorBytes()
         A selector to restrict the list of returned objects by their labels.
 Defaults to everything.
 +optional
        optional string labelSelector = 1;
        Returns:
        The bytes for labelSelector.

      • hasFieldSelector

        boolean hasFieldSelector()
         A selector to restrict the list of returned objects by their fields.
 Defaults to everything.
 +optional
        optional string fieldSelector = 2;
        Returns:
        Whether the fieldSelector field is set.

      • getFieldSelector

        String getFieldSelector()
         A selector to restrict the list of returned objects by their fields.
 Defaults to everything.
 +optional
        optional string fieldSelector = 2;
        Returns:
        The fieldSelector.

      • getFieldSelectorBytes

        com.google.protobuf.ByteString getFieldSelectorBytes()
         A selector to restrict the list of returned objects by their fields.
 Defaults to everything.
 +optional
        optional string fieldSelector = 2;
        Returns:
        The bytes for fieldSelector.

      • hasWatch

        boolean hasWatch()
         Watch for changes to the described resources and return them as a stream of
 add, update, and remove notifications. Specify resourceVersion.
 +optional
        optional bool watch = 3;
        Returns:
        Whether the watch field is set.

      • getWatch

        boolean getWatch()
         Watch for changes to the described resources and return them as a stream of
 add, update, and remove notifications. Specify resourceVersion.
 +optional
        optional bool watch = 3;
        Returns:
        The watch.

      • hasAllowWatchBookmarks

        boolean hasAllowWatchBookmarks()
         allowWatchBookmarks requests watch events with type "BOOKMARK".
 Servers that do not implement bookmarks may ignore this flag and
 bookmarks are sent at the server's discretion. Clients should not
 assume bookmarks are returned at any specific interval, nor may they
 assume the server will send any BOOKMARK event during a session.
 If this is not a watch, this field is ignored.
 +optional
        optional bool allowWatchBookmarks = 9;
        Returns:
        Whether the allowWatchBookmarks field is set.

      • getAllowWatchBookmarks

        boolean getAllowWatchBookmarks()
         allowWatchBookmarks requests watch events with type "BOOKMARK".
 Servers that do not implement bookmarks may ignore this flag and
 bookmarks are sent at the server's discretion. Clients should not
 assume bookmarks are returned at any specific interval, nor may they
 assume the server will send any BOOKMARK event during a session.
 If this is not a watch, this field is ignored.
 +optional
        optional bool allowWatchBookmarks = 9;
        Returns:
        The allowWatchBookmarks.

      • hasResourceVersion

        boolean hasResourceVersion()
         resourceVersion sets a constraint on what resource versions a request may be served from.
 See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
 details.

 Defaults to unset
 +optional
        optional string resourceVersion = 4;
        Returns:
        Whether the resourceVersion field is set.

      • getResourceVersion

        String getResourceVersion()
         resourceVersion sets a constraint on what resource versions a request may be served from.
 See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
 details.

 Defaults to unset
 +optional
        optional string resourceVersion = 4;
        Returns:
        The resourceVersion.

      • getResourceVersionBytes

        com.google.protobuf.ByteString getResourceVersionBytes()
         resourceVersion sets a constraint on what resource versions a request may be served from.
 See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
 details.

 Defaults to unset
 +optional
        optional string resourceVersion = 4;
        Returns:
        The bytes for resourceVersion.

      • hasResourceVersionMatch

        boolean hasResourceVersionMatch()
         resourceVersionMatch determines how resourceVersion is applied to list calls.
 It is highly recommended that resourceVersionMatch be set for list calls where
 resourceVersion is set
 See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
 details.

 Defaults to unset
 +optional
        optional string resourceVersionMatch = 10;
        Returns:
        Whether the resourceVersionMatch field is set.

      • getResourceVersionMatch

        String getResourceVersionMatch()
         resourceVersionMatch determines how resourceVersion is applied to list calls.
 It is highly recommended that resourceVersionMatch be set for list calls where
 resourceVersion is set
 See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
 details.

 Defaults to unset
 +optional
        optional string resourceVersionMatch = 10;
        Returns:
        The resourceVersionMatch.

      • getResourceVersionMatchBytes

        com.google.protobuf.ByteString getResourceVersionMatchBytes()
         resourceVersionMatch determines how resourceVersion is applied to list calls.
 It is highly recommended that resourceVersionMatch be set for list calls where
 resourceVersion is set
 See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
 details.

 Defaults to unset
 +optional
        optional string resourceVersionMatch = 10;
        Returns:
        The bytes for resourceVersionMatch.

      • hasTimeoutSeconds

        boolean hasTimeoutSeconds()
         Timeout for the list/watch call.
 This limits the duration of the call, regardless of any activity or inactivity.
 +optional
        optional int64 timeoutSeconds = 5;
        Returns:
        Whether the timeoutSeconds field is set.

      • getTimeoutSeconds

        long getTimeoutSeconds()
         Timeout for the list/watch call.
 This limits the duration of the call, regardless of any activity or inactivity.
 +optional
        optional int64 timeoutSeconds = 5;
        Returns:
        The timeoutSeconds.

      • hasLimit

        boolean hasLimit()
         limit is a maximum number of responses to return for a list call. If more items exist, the
 server will set the `continue` field on the list metadata to a value that can be used with the
 same initial query to retrieve the next set of results. Setting a limit may return fewer than
 the requested amount of items (up to zero items) in the event all requested objects are
 filtered out and clients should only use the presence of the continue field to determine whether
 more results are available. Servers may choose not to support the limit argument and will return
 all of the available results. If limit is specified and the continue field is empty, clients may
 assume that no more results are available. This field is not supported if watch is true.

 The server guarantees that the objects returned when using continue will be identical to issuing
 a single list call without a limit - that is, no objects created, modified, or deleted after the
 first request is issued will be included in any subsequent continued requests. This is sometimes
 referred to as a consistent snapshot, and ensures that a client that is using limit to receive
 smaller chunks of a very large result can ensure they see all possible objects. If objects are
 updated during a chunked list the version of the object that was present at the time the first list
 result was calculated is returned.
        optional int64 limit = 7;
        Returns:
        Whether the limit field is set.

      • getLimit

        long getLimit()
         limit is a maximum number of responses to return for a list call. If more items exist, the
 server will set the `continue` field on the list metadata to a value that can be used with the
 same initial query to retrieve the next set of results. Setting a limit may return fewer than
 the requested amount of items (up to zero items) in the event all requested objects are
 filtered out and clients should only use the presence of the continue field to determine whether
 more results are available. Servers may choose not to support the limit argument and will return
 all of the available results. If limit is specified and the continue field is empty, clients may
 assume that no more results are available. This field is not supported if watch is true.

 The server guarantees that the objects returned when using continue will be identical to issuing
 a single list call without a limit - that is, no objects created, modified, or deleted after the
 first request is issued will be included in any subsequent continued requests. This is sometimes
 referred to as a consistent snapshot, and ensures that a client that is using limit to receive
 smaller chunks of a very large result can ensure they see all possible objects. If objects are
 updated during a chunked list the version of the object that was present at the time the first list
 result was calculated is returned.
        optional int64 limit = 7;
        Returns:
        The limit.

      • hasContinue

        boolean hasContinue()
         The continue option should be set when retrieving more results from the server. Since this value is
 server defined, clients may only use the continue value from a previous query result with identical
 query parameters (except for the value of continue) and the server may reject a continue value it
 does not recognize. If the specified continue value is no longer valid whether due to expiration
 (generally five to fifteen minutes) or a configuration change on the server, the server will
 respond with a 410 ResourceExpired error together with a continue token. If the client needs a
 consistent list, it must restart their list without the continue field. Otherwise, the client may
 send another list request with the token received with the 410 error, the server will respond with
 a list starting from the next key, but from the latest snapshot, which is inconsistent from the
 previous list results - objects that are created, modified, or deleted after the first list request
 will be included in the response, as long as their keys are after the "next key".

 This field is not supported when watch is true. Clients may start a watch from the last
 resourceVersion value returned by the server and not miss any modifications.
        optional string continue = 8;
        Returns:
        Whether the continue field is set.

      • getContinue

        String getContinue()
         The continue option should be set when retrieving more results from the server. Since this value is
 server defined, clients may only use the continue value from a previous query result with identical
 query parameters (except for the value of continue) and the server may reject a continue value it
 does not recognize. If the specified continue value is no longer valid whether due to expiration
 (generally five to fifteen minutes) or a configuration change on the server, the server will
 respond with a 410 ResourceExpired error together with a continue token. If the client needs a
 consistent list, it must restart their list without the continue field. Otherwise, the client may
 send another list request with the token received with the 410 error, the server will respond with
 a list starting from the next key, but from the latest snapshot, which is inconsistent from the
 previous list results - objects that are created, modified, or deleted after the first list request
 will be included in the response, as long as their keys are after the "next key".

 This field is not supported when watch is true. Clients may start a watch from the last
 resourceVersion value returned by the server and not miss any modifications.
        optional string continue = 8;
        Returns:
        The continue.

      • getContinueBytes

        com.google.protobuf.ByteString getContinueBytes()
         The continue option should be set when retrieving more results from the server. Since this value is
 server defined, clients may only use the continue value from a previous query result with identical
 query parameters (except for the value of continue) and the server may reject a continue value it
 does not recognize. If the specified continue value is no longer valid whether due to expiration
 (generally five to fifteen minutes) or a configuration change on the server, the server will
 respond with a 410 ResourceExpired error together with a continue token. If the client needs a
 consistent list, it must restart their list without the continue field. Otherwise, the client may
 send another list request with the token received with the 410 error, the server will respond with
 a list starting from the next key, but from the latest snapshot, which is inconsistent from the
 previous list results - objects that are created, modified, or deleted after the first list request
 will be included in the response, as long as their keys are after the "next key".

 This field is not supported when watch is true. Clients may start a watch from the last
 resourceVersion value returned by the server and not miss any modifications.
        optional string continue = 8;
        Returns:
        The bytes for continue.

      • hasSendInitialEvents

        boolean hasSendInitialEvents()
         `sendInitialEvents=true` may be set together with `watch=true`.
 In that case, the watch stream will begin with synthetic events to
 produce the current state of objects in the collection. Once all such
 events have been sent, a synthetic "Bookmark" event  will be sent.
 The bookmark will report the ResourceVersion (RV) corresponding to the
 set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation.
 Afterwards, the watch stream will proceed as usual, sending watch events
 corresponding to changes (subsequent to the RV) to objects watched.

 When `sendInitialEvents` option is set, we require `resourceVersionMatch`
 option to also be set. The semantic of the watch request is as following:
 - `resourceVersionMatch` = NotOlderThan
   is interpreted as "data at least as new as the provided `resourceVersion`"
   and the bookmark event is send when the state is synced
   to a `resourceVersion` at least as fresh as the one provided by the ListOptions.
   If `resourceVersion` is unset, this is interpreted as "consistent read" and the
   bookmark event is send when the state is synced at least to the moment
   when request started being processed.
 - `resourceVersionMatch` set to any other value or unset
   Invalid error is returned.

 Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward
 compatibility reasons) and to false otherwise.
 +optional
        optional bool sendInitialEvents = 11;
        Returns:
        Whether the sendInitialEvents field is set.

      • getSendInitialEvents

        boolean getSendInitialEvents()
         `sendInitialEvents=true` may be set together with `watch=true`.
 In that case, the watch stream will begin with synthetic events to
 produce the current state of objects in the collection. Once all such
 events have been sent, a synthetic "Bookmark" event  will be sent.
 The bookmark will report the ResourceVersion (RV) corresponding to the
 set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation.
 Afterwards, the watch stream will proceed as usual, sending watch events
 corresponding to changes (subsequent to the RV) to objects watched.

 When `sendInitialEvents` option is set, we require `resourceVersionMatch`
 option to also be set. The semantic of the watch request is as following:
 - `resourceVersionMatch` = NotOlderThan
   is interpreted as "data at least as new as the provided `resourceVersion`"
   and the bookmark event is send when the state is synced
   to a `resourceVersion` at least as fresh as the one provided by the ListOptions.
   If `resourceVersion` is unset, this is interpreted as "consistent read" and the
   bookmark event is send when the state is synced at least to the moment
   when request started being processed.
 - `resourceVersionMatch` set to any other value or unset
   Invalid error is returned.

 Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward
 compatibility reasons) and to false otherwise.
 +optional
        optional bool sendInitialEvents = 11;
        Returns:
        The sendInitialEvents.