ibm-platform-services 0.68.2__py3-none-any.whl → 0.69.0__py3-none-any.whl

ibm_platform_services/global_search_v2.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# (C) Copyright IBM Corp. 2024.
+# (C) Copyright IBM Corp. 2025.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# IBM OpenAPI SDK Code Generator Version: 3.87.0-91c7c775-20240320-213027
+# IBM OpenAPI SDK Code Generator Version: 3.100.0-2ad7a784-20250212-162551
 
 """
 Search for resources with the global and shared resource properties repository that is
@@ -96,7 +96,6 @@ class GlobalSearchV2(BaseService):
         sort: Optional[List[str]] = None,
         is_deleted: Optional[str] = None,
         is_reclaimed: Optional[str] = None,
-        is_public: Optional[str] = None,
         impersonate_user: Optional[str] = None,
         can_tag: Optional[str] = None,
         is_project_resource: Optional[str] = None,
@@ -106,21 +105,17 @@ class GlobalSearchV2(BaseService):
         Find instances of resources (v3).
 
         Find IAM-enabled resources or storage and network resources that run on classic
-        infrastructure in a specific account ID. You can apply query strings if necessary.
-        To filter results, you can insert a string by using the Lucene syntax and the
-        query string is parsed into a series of terms and operators. A term can be a
-        single word or a phrase, in which case the search is performed for all the words,
-        in the same order. To filter for a specific value regardless of the property that
-        contains it, type the search term without specifying a field. Only resources that
-        belong to the account ID and that are accessible by the client are returned.
+        infrastructure in a specific account ID.
         You must use `/v3/resources/search` when you need to fetch more than `10000`
         resource items. On the first call, the operation returns a live cursor on the data
         that you must use on all the subsequent calls to get the next batch of results
         until you get the empty result set.
-        By default, the fields that are returned for every resource are `crn`, `name`,
-        `family`, `type`, and `account_id`. You can specify the subset of the fields you
-        want in your request using the `fields` request body attribute. Set `"fields":
-        ["*"]` to discover the set of fields which are available to request.
+        To filter results, you can apply query strings following the *Lucene* query
+        syntax.
+        By default, the fields that are returned for every resource are **crn**, **name**,
+        **family**, **type**, and **account_id**. You can specify the subset of the fields
+        you want in your request using the `fields` request body attribute. Set `"fields":
+        ["*"]` to discover the complete set of fields which are available to request.
 
         :param str query: (optional) The Lucene-formatted query string. Default to
                '*' if not set.
@@ -131,8 +126,10 @@ class GlobalSearchV2(BaseService):
                request.
         :param str search_cursor: (optional) An opaque cursor that is returned on
                each call and that must be set on the subsequent call to get the next batch
-               of items. If the search returns no items, then the search_cursor is not
-               present in the response.
+               of items. You can stop paging when the search returns less items than the
+               specified `limit` or when the `search_cursor` is not present in the
+               response. NOTE: when setting this parameter, any other properties present
+               in the body will be ignored.
         :param str x_request_id: (optional) An alphanumeric string that is used to
                trace the request. The value  may include ASCII alphanumerics and any of
                following segment separators: space ( ), comma (,), hyphen, (-), and
@@ -169,10 +166,6 @@ class GlobalSearchV2(BaseService):
                (default), true or any. If false, only not reclaimed documents are
                returned; if true, only reclaimed documents are returned; If any, both
                reclaimed and not reclaimed documents are returned.
-        :param str is_public: (optional) Determines if public resources should be
-               included in result set or not. Possible values are false (default), true or
-               any. If false, do not search public resources; if true, search only public
-               resources; If any, search also public resources.
         :param str impersonate_user: (optional) The user on whose behalf the search
                must be performed. Only a GhoST admin can impersonate a user, so be sure
                you set a GhoST admin IAM token in the Authorization header if you set this
@@ -212,7 +205,6 @@ class GlobalSearchV2(BaseService):
             'sort': convert_list(sort),
             'is_deleted': is_deleted,
             'is_reclaimed': is_reclaimed,
-            'is_public': is_public,
             'impersonate_user': impersonate_user,
             'can_tag': can_tag,
             'is_project_resource': is_project_resource,
@@ -274,17 +266,6 @@ class SearchEnums:
         FALSE = 'false'
         ANY = 'any'
 
-    class IsPublic(str, Enum):
-        """
-        Determines if public resources should be included in result set or not. Possible
-        values are false (default), true or any. If false, do not search public resources;
-        if true, search only public resources; If any, search also public resources.
-        """
-
-        TRUE = 'true'
-        FALSE = 'false'
-        ANY = 'any'
-
     class CanTag(str, Enum):
         """
         Determines if the result set must return the resources that the user can tag or
@@ -322,6 +303,8 @@ class ResultItem:
     other properties that depend on the resource type.
 
     :param str crn: Resource identifier in CRN format.
+
+    This type supports additional properties of type object.
     """
 
     # The set of defined properties for the class
@@ -330,17 +313,22 @@ class ResultItem:
     def __init__(
         self,
         crn: str,
-        **kwargs,
+        **kwargs: Optional[object],
     ) -> None:
         """
         Initialize a ResultItem object.
 
         :param str crn: Resource identifier in CRN format.
-        :param **kwargs: (optional) Any additional properties.
+        :param object **kwargs: (optional) Additional properties of type object
         """
         self.crn = crn
-        for _key, _value in kwargs.items():
-            setattr(self, _key, _value)
+        for k, v in kwargs.items():
+            if k not in ResultItem._properties:
+                if not isinstance(v, object):
+                    raise ValueError('Value for additional property {} must be of type object'.format(k))
+                setattr(self, k, v)
+            else:
+                raise ValueError('Property {} cannot be specified as an additional property'.format(k))
 
     @classmethod
     def from_dict(cls, _dict: Dict) -> 'ResultItem':
@@ -350,7 +338,11 @@ class ResultItem:
             args['crn'] = crn
         else:
             raise ValueError('Required property \'crn\' not present in ResultItem JSON')
-        args.update({k: v for (k, v) in _dict.items() if k not in cls._properties})
+        for k, v in _dict.items():
+            if k not in cls._properties:
+                if not isinstance(v, object):
+                    raise ValueError('Value for additional property {} must be of type object'.format(k))
+                args[k] = v
         return cls(**args)
 
     @classmethod
@@ -363,8 +355,8 @@ class ResultItem:
         _dict = {}
         if hasattr(self, 'crn') and self.crn is not None:
             _dict['crn'] = self.crn
-        for _key in [k for k in vars(self).keys() if k not in ResultItem._properties]:
-            _dict[_key] = getattr(self, _key)
+        for k in [_k for _k in vars(self).keys() if _k not in ResultItem._properties]:
+            _dict[k] = getattr(self, k)
         return _dict
 
     def _to_dict(self):
@@ -372,21 +364,23 @@ class ResultItem:
         return self.to_dict()
 
     def get_properties(self) -> Dict:
-        """Return a dictionary of arbitrary properties from this instance of ResultItem"""
+        """Return the additional properties from this instance of ResultItem in the form of a dict."""
         _dict = {}
-
-        for _key in [k for k in vars(self).keys() if k not in ResultItem._properties]:
-            _dict[_key] = getattr(self, _key)
+        for k in [_k for _k in vars(self).keys() if _k not in ResultItem._properties]:
+            _dict[k] = getattr(self, k)
         return _dict
 
     def set_properties(self, _dict: dict):
-        """Set a dictionary of arbitrary properties to this instance of ResultItem"""
-        for _key in [k for k in vars(self).keys() if k not in ResultItem._properties]:
-            delattr(self, _key)
-
-        for _key, _value in _dict.items():
-            if _key not in ResultItem._properties:
-                setattr(self, _key, _value)
+        """Set a dictionary of additional properties in this instance of ResultItem"""
+        for k in [_k for _k in vars(self).keys() if _k not in ResultItem._properties]:
+            delattr(self, k)
+        for k, v in _dict.items():
+            if k not in ResultItem._properties:
+                if not isinstance(v, object):
+                    raise ValueError('Value for additional property {} must be of type object'.format(k))
+                setattr(self, k, v)
+            else:
+                raise ValueError('Property {} cannot be specified as an additional property'.format(k))
 
     def __str__(self) -> str:
         """Return a `str` version of this ResultItem object."""