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

Class Generated.ListOptions

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Generated.ListOptionsOrBuilder
    Enclosing class:
    Generated
    public static final class Generated.ListOptions
extends com.google.protobuf.GeneratedMessageV3
implements Generated.ListOptionsOrBuilder
     ListOptions is the query options to a standard REST list call.
    Protobuf type k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasLabelSelector

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

      • getLabelSelector

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

      • getLabelSelectorBytes

        public 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;
        Specified by:
        getLabelSelectorBytes in interface Generated.ListOptionsOrBuilder
        Returns:
        The bytes for labelSelector.

      • hasFieldSelector

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

      • getFieldSelector

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

      • getFieldSelectorBytes

        public 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;
        Specified by:
        getFieldSelectorBytes in interface Generated.ListOptionsOrBuilder
        Returns:
        The bytes for fieldSelector.

      • hasWatch

        public 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;
        Specified by:
        hasWatch in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the watch field is set.

      • getWatch

        public 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;
        Specified by:
        getWatch in interface Generated.ListOptionsOrBuilder
        Returns:
        The watch.

      • hasAllowWatchBookmarks

        public 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;
        Specified by:
        hasAllowWatchBookmarks in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the allowWatchBookmarks field is set.

      • getAllowWatchBookmarks

        public 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;
        Specified by:
        getAllowWatchBookmarks in interface Generated.ListOptionsOrBuilder
        Returns:
        The allowWatchBookmarks.

      • hasResourceVersion

        public 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;
        Specified by:
        hasResourceVersion in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the resourceVersion field is set.

      • getResourceVersion

        public 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;
        Specified by:
        getResourceVersion in interface Generated.ListOptionsOrBuilder
        Returns:
        The resourceVersion.

      • getResourceVersionBytes

        public 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;
        Specified by:
        getResourceVersionBytes in interface Generated.ListOptionsOrBuilder
        Returns:
        The bytes for resourceVersion.

      • hasResourceVersionMatch

        public 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;
        Specified by:
        hasResourceVersionMatch in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the resourceVersionMatch field is set.

      • getResourceVersionMatch

        public 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;
        Specified by:
        getResourceVersionMatch in interface Generated.ListOptionsOrBuilder
        Returns:
        The resourceVersionMatch.

      • getResourceVersionMatchBytes

        public 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;
        Specified by:
        getResourceVersionMatchBytes in interface Generated.ListOptionsOrBuilder
        Returns:
        The bytes for resourceVersionMatch.

      • hasTimeoutSeconds

        public 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;
        Specified by:
        hasTimeoutSeconds in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the timeoutSeconds field is set.

      • getTimeoutSeconds

        public 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;
        Specified by:
        getTimeoutSeconds in interface Generated.ListOptionsOrBuilder
        Returns:
        The timeoutSeconds.

      • hasLimit

        public 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;
        Specified by:
        hasLimit in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the limit field is set.

      • getLimit

        public 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;
        Specified by:
        getLimit in interface Generated.ListOptionsOrBuilder
        Returns:
        The limit.

      • hasContinue

        public 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;
        Specified by:
        hasContinue in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the continue field is set.

      • getContinue

        public 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;
        Specified by:
        getContinue in interface Generated.ListOptionsOrBuilder
        Returns:
        The continue.

      • getContinueBytes

        public 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;
        Specified by:
        getContinueBytes in interface Generated.ListOptionsOrBuilder
        Returns:
        The bytes for continue.

      • hasSendInitialEvents

        public 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;
        Specified by:
        hasSendInitialEvents in interface Generated.ListOptionsOrBuilder
        Returns:
        Whether the sendInitialEvents field is set.

      • getSendInitialEvents

        public 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;
        Specified by:
        getSendInitialEvents in interface Generated.ListOptionsOrBuilder
        Returns:
        The sendInitialEvents.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Generated.ListOptions parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.ListOptions parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.ListOptions parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.ListOptions parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.ListOptions parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.ListOptions parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Generated.ListOptions.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Generated.ListOptions> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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