iTSrSSKJr SSKJrJrJr SSKrSSKJ r J r SSK J r SSK Jr SSKJr S S KJr "S S \ 5r"S S5r"SS5r"SS5rg)a Search for resources with the global and shared resource properties repository that is integrated in the IBM Cloud platform. The search repository stores and searches cloud resources attributes, which categorize or classify resources. A resource is a physical or logical component that can be created or reserved for an application or service instance. They are owned by resource providers, such as IBM Kubernetes Service, or resource controller in IBM Cloud. Resources are uniquely identified by a Cloud Resource Name (CRN) or by an IMS ID. The properties of a resource include tags and system properties. Both properties are defined in an IBM Cloud billing account, and span across many regions. API Version: 2.0.1 )Enum)DictListOptionalN) BaseServiceDetailedResponse) Authenticator)"get_authenticator_from_environment) convert_list)get_sdk_headersc"\rSrSrSrSrSr\\4S\SS4Sjj5r SS \ SS4S jjr SSSSSSSSSSSSSSS .S \ \S \ \ \S\ \S\ \S\ \S\ \S\ \S\ \S\ \ \S\ \S\ \S\ \S\ \S\ \S\4SjjrSrg)GlobalSearchV20zThe global_search V2 service.z/https://api.global-search-tagging.cloud.ibm.com global_search service_namereturncN[U5nU"U5nURU5 U$)zu Return a new client for the global_search service using the specified parameters and external configuration. )r configure_service)clsr authenticatorservices `/home/james-whalen/.local/lib/python3.13/site-packages/ibm_platform_services/global_search_v2.py new_instanceGlobalSearchV2.new_instance6s+;<H m$!!,/NrcB[R"XRUS9 g)a4 Construct a new client for the global_search service. :param Authenticator authenticator: The authenticator specifies the authentication mechanism. Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md about initializing the authenticator of your choice. ) service_urlrN)r__init__DEFAULT_SERVICE_URL)selfrs rrGlobalSearchV2.__init__Ds T/G/GWder)queryfields search_cursor x_request_idx_correlation_id account_idlimittimeoutsort is_deleted is_reclaimedimpersonate_usercan_tagis_project_resourcer#r$r%r&r'r(r)r*r+r,r-r.r/r0c UUS.n[URSSS9nURU5 UUU[U 5U U U U US. nUUUS.nUR 5VVs0sHunnUcM UU_M nnn[ R "U5nSUS'S U;a#URURS 55 US SUS 'S nURS UUUUS 9nUR"U40UD6nU$s snnf)a 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 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. 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. :param List[str] fields: (optional) The list of the fields returned by the search. By default, the returned fields are the `account_id`, `name`, `type`, `family`, and `crn`. For all queries, `crn` is always returned. You may set `"fields": ["*"]` to discover the set of fields available to 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. 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 underscore (_) and may have a length up to 1024 bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random (version 4) UUID. :param str x_correlation_id: (optional) An alphanumeric string that is used to trace the request as a part of a larger context: the same value is used for downstream requests and retries of those requests. The value may include ASCII alphanumerics and any of following segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024 bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random (version 4) UUID. :param str account_id: (optional) The account ID to filter resources. :param int limit: (optional) The maximum number of hits to return. Defaults to 10. :param int timeout: (optional) A search timeout in milliseconds, bounding the search request to run within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to the system defined timeout. :param List[str] sort: (optional) Comma separated properties names that are used for sorting. :param str is_deleted: (optional) Determines if deleted documents should be included in result set or not. Possible values are false (default), true or any. If false, only existing documents are returned; if true, only deleted documents are returned; If any, both existing and deleted documents are returned. (_for administrators only_). :param str is_reclaimed: (optional) Determines if reclaimed documents should be included in result set or not. Possible values are false (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 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 parameter. (_for administrators only_). :param str can_tag: (optional) Determines if the result set must return the resources that the user can tag or the resources that the user can view (only a GhoST admin can use this parameter). If false (default), only resources user can view are returned; if true, only resources that user has permissions for tagging are returned (_for administrators only_). :param str is_project_resource: (optional) Determines if documents belonging to Project family should be included in result set or not. Possible values are false (default), true or any. If false, documents belonging to all families except Project are returned; if true, only documents belonging to Project family are returned; if any, documents of any family are returned. Only authorized ServiceIds can use this query parameter. :param dict headers: A `dict` containing the request headers :return: A `DetailedResponse` containing the result, headers and HTTP status code. :rtype: DetailedResponse with `dict` result representing a `ScanResult` object )z x-request-idzx-correlation-idV2search)rservice_version operation_id) r(r)r*r+r,r-r.r/r0)r#r$r%zapplication/jsonz content-typeheadersAcceptz/v3/resources/searchPOST)methodurlr6paramsdata) r DEFAULT_SERVICE_NAMEupdater itemsjsondumpsgetprepare_requestsend)r!r#r$r%r&r'r(r)r*r+r,r-r.r/r0kwargsr6 sdk_headersr;r<kvr:requestresponses rr3GlobalSearchV2.searchUs.T) 0 &22 ! {#% &$( 0#6  *  $(::<A<!Q11<Azz$"4   NN6::i0 1y!.$&& ' 99W//'Bs  C%(C%)N)__name__ __module__ __qualname____firstlineno____doc__r r= classmethodstrrr rrrintrr3__static_attributes__rLrrrr0sx'K*1     (, f$ f  f( $&*'+&**.$(#!%$($(&**.!%-1!X}Xc# X  } X sm X#3-XSMX}X#XtCy!XSMXsmX#3-X#X &c]!X$ %XXrrcx\rSrSrSr"SS\\5r"SS\\5r"SS\\5r "S S \\5r S r g ) SearchEnumsz Enums for search parameters. c$\rSrSrSrSrSrSrSrg)SearchEnums.IsDeleteda1 Determines if deleted documents should be included in result set or not. Possible values are false (default), true or any. If false, only existing documents are returned; if true, only deleted documents are returned; If any, both existing and deleted documents are returned. (_for administrators only_). truefalseanyrLN rMrNrOrPrQTRUEFALSEANYrUrLrr IsDeletedrZ rrcc$\rSrSrSrSrSrSrSrg)SearchEnums.IsReclaimedia$ Determines if reclaimed documents should be included in result set or not. Possible values are false (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. r\r]r^rLNr_rLrr IsReclaimedrfrdrrgc \rSrSrSrSrSrSrg)SearchEnums.CanTagi aJ Determines if the result set must return the resources that the user can tag or the resources that the user can view (only a GhoST admin can use this parameter). If false (default), only resources user can view are returned; if true, only resources that user has permissions for tagging are returned (_for administrators only_). r\r]rLN)rMrNrOrPrQr`rarUrLrrCanTagri s rrjc$\rSrSrSrSrSrSrSrg)SearchEnums.IsProjectResourceia Determines if documents belonging to Project family should be included in result set or not. Possible values are false (default), true or any. If false, documents belonging to all families except Project are returned; if true, only documents belonging to Project family are returned; if any, documents of any family are returned. Only authorized ServiceIds can use this query parameter. r\r]r^rLNr_rLrrIsProjectResourcerls rrmrLN) rMrNrOrPrQrSrrcrgrjrmrUrLrrrWrWs? C  c4  d  C rrWc\rSrSrSr\"S/5rS\S\\ SS4Sjr \ S\ SS4S j5r \ S 5rS\ 4S jrS rS\ 4S jrS\4SjrS\4SjrSSS\4SjrSSS\4SjrSrg) ResultItemi,z A resource returned in a search result, which is identified by its `crn`. It contains other properties that depend on the resource type. :param str crn: Resource identifier in CRN format. This type supports additional properties of type object. crnrErNc XlUR5Hnup4U[R;a=[ U[ 5(d[ SRU55e[XU5 MV[ SRU55e g)z Initialize a ResultItem object. :param str crn: Resource identifier in CRN format. :param object **kwargs: (optional) Additional properties of type object 7Value for additional property {} must be of type object9Property {} cannot be specified as an additional propertyN) rpr?ro _properties isinstanceobject ValueErrorformatsetattr)r!rprErGrHs rrResultItem.__init__9spLLNDA ...!!V,,$%^%e%efg%hii# !\!c!cde!fgg #r_dictc0nURS5=nbX2S'O [S5eUR5HIupEX@R;dM[ U[ 5(d[SR U55eXRU'MK U"S0UD6$)6Initialize a ResultItem object from a json dictionary.rpz6Required property 'crn' not present in ResultItem JSONrrrL)rBrwr?rtrurvrx)rr{argsrprGrHs r from_dictResultItem.from_dictMs99U# #C 0KWX XKKMDA'!!V,,$%^%e%efg%hiiQ " {T{rc$URU5$)r}rrr{s r _from_dictResultItem._from_dict\}}U##rc0n[US5(aURbURUS'[U5R5Vs/sHo"[R ;dMUPM snHn[ X5X'M U$s snf)1Return a json dictionary representing this model.rp)hasattrrpvarskeysrortgetattrr!r{_krGs rto_dictResultItem.to_dictass 4  DHH$888E%L#Dz0U0j>T>T4T"0UAt'EHV Vs B&Bc"UR5$rrr!s r_to_dictResultItem._to_dictj||~rc0n[U5R5Vs/sHo"[R;dMUPM snHn[ X5X'M U$s snf)zXReturn the additional properties from this instance of ResultItem in the form of a dict.)rrrortrrs rget_propertiesResultItem.get_propertiesnsP#Dz0U0j>T>T4T"0UAt'EHV Vs AAc[U5R5Vs/sHo"[R;dMUPM snHn[ X5 M UR 5Hnup4U[R;a=[ U[5(d[SRU55e[XU5 MV[SRU55e gs snf)zHSet a dictionary of additional properties in this instance of ResultItemrrrsN) rrrortdelattrr?rurvrwrxry)r!r{rrGrHs rset_propertiesResultItem.set_propertiesus#Dz0U0j>T>T4T"0UA D VKKMDA ...!!V,,$%^%e%efg%hii# !\!c!cde!fgg "Vs CCcH[R"UR5SS9$)z1Return a `str` version of this ResultItem object.indentr@rArrs r__str__ResultItem.__str__zz$,,.33rothercj[XR5(dgURUR:H$z=Return `true` when self and other are equal, false otherwise.Fru __class____dict__r!rs r__eq__ResultItem.__eq__'%00}}..rc X:X+$zAReturn `true` when self and other are not equal, false otherwise.rLrs r__ne__ResultItem.__ne__   r)rp)rMrNrOrPrQ frozensetrtrSrrvrrRrrrrrrdictrrboolrrrUrLrrroro,sUG$Kh h6"h  h( d |  $$ hD h44/L/T/ !L!T!rroc \rSrSrSrSS.S\S\SS\\S S4S jjr \ S \ S S4S j5r \ S 5r S \ 4SjrSrS \4SjrSSS \4SjrSSS \4SjrSrg) ScanResultiaQ The search scan response. :param str search_cursor: (optional) The search cursor to use on all calls after the first one. :param int limit: Value of the limit parameter specified by the user. :param List[ResultItem] items: The array of results. Each item represents a resource. For each resource, the requested `fields` are returned. If you did not set the `fields` request body parameter, then the `account_id`, `name`, `type`, `family`, and `crn` are returned. An empty array signals the end of the result set, which means there are no more results to fetch. N)r%r)r?ror%rc(X0lXlX lg)a\ Initialize a ScanResult object. :param int limit: Value of the limit parameter specified by the user. :param List[ResultItem] items: The array of results. Each item represents a resource. For each resource, the requested `fields` are returned. If you did not set the `fields` request body parameter, then the `account_id`, `name`, `type`, `family`, and `crn` are returned. An empty array signals the end of the result set, which means there are no more results to fetch. :param str search_cursor: (optional) The search cursor to use on all calls after the first one. N)r%r)r?)r!r)r?r%s rrScanResult.__init__s&+  rr{c*0nURS5=nbX2S'URS5=nbXBS'O [S5eURS5=nb*UVs/sHn[RU5PM snUS'O [S5eU"S0UD6$s snf)6Initialize a ScanResult object from a json dictionary.r%r)z8Required property 'limit' not present in ScanResult JSONr?z8Required property 'items' not present in ScanResult JSONrL)rBrwror)rr{r~r%r)r?rHs rrScanResult.from_dicts"YY7 7M D$1 !YYw' 'E 4!MYZ ZYYw' 'E 4>CDeZ11!4eDDMYZ Z{T{EsBc$URU5$)rrrs rrScanResult._from_dictrrc0n[US5(aURbURUS'[US5(aURbURUS'[US5(amURb`/nURHJn[ U[ 5(aUR U5 M+UR UR55 ML X!S'U$)rr%r)r?)rr%r)r?rurappendr)r!r{ items_listrHs rrScanResult.to_dicts 4 ) )d.@.@.L%)%7%7E/ " 4 ! !djj&<!ZZE'N 4 ! !djj&<JZZa&&%%a(%%aiik2  ('N rc"UR5$rrrs rrScanResult._to_dictrrcH[R"UR5SS9$)z1Return a `str` version of this ScanResult object.rrrrs rrScanResult.__str__rrrcj[XR5(dgURUR:H$rrrs rrScanResult.__eq__rrc X:X+$rrLrs rrScanResult.__ne__rr)r?r)r%)rMrNrOrPrQrTrrrSrrRrrrrrrrrrrUrLrrrrs $(, L!  }   . d |  $$"44/L/T/ !L!T!rr)rQenumrtypingrrrr@ibm_cloud_sdk_corerr/ibm_cloud_sdk_core.authenticators.authenticatorr $ibm_cloud_sdk_core.get_authenticatorr ibm_cloud_sdk_core.utilsr commonr rrWrorrLrrrsZ& '' <IS1#}[}@44xa!a!H[![!r