o S@sdZddlmZddlmZddlmZddlmZddlmZ ddlm Z ddl m Z dd l m Z dd l mZdd lmZddlmZdd lmZdd lmZddlZdZGdddejZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGd d!d!eZ Gd"d#d#eZ!d$d%Z"d&d'Z#d;d(d)Z$d*d+Z%d,d-Z&dz+Utilities for the gcloud meta apis surface.)absolute_import)division)unicode_literals)messages) exceptions) list_pager)apis) apis_internal)resource) arg_utils)log)apis_mapN.c@ eZdZdS)ErrorN__name__ __module__ __qualname__rrJ/tmp/google-cloud-sdk/lib/googlecloudsdk/command_lib/util/apis/registry.pyr&rceZdZfddZZS)UnknownAPIErrorctt|dj|ddS)Nz0API [{api}] does not exist or is not registered.api)superr__init__formatselfapi_name __class__rrr, zUnknownAPIError.__init__rrrr __classcell__rrr#rr*rcr)UnknownAPIVersionErrorcstt|dj||ddS)Nz3Version [{version}] does not exist for API [{api}].)versionr)rr)rr)r!r"r*r#rrr5 zUnknownAPIVersionError.__init__r&rrr#rr)3r(r)cr)NoDefaultVersionErrorcr)NzSAPI [{api}] does not have a default version. You must specify which version to use.r)rr,rrr r#rrr>r%zNoDefaultVersionError.__init__r&rrr#rr,<r(r,cr)UnknownCollectionErrorcs tt|dj|||ddS)NzACollection [{collection}] does not exist for [{api}] [{version}].) collectionrr*)rr-rr)r!r" api_versionr.r#rrrGs zUnknownCollectionError.__init__r&rrr#rr-Er(r-cr)UnknownMethodErrorcstt|dj||ddS)Nz?Method [{method}] does not exist for collection [{collection}].)methodr.)rr0rr)r!r1r.r#rrrPr+zUnknownMethodError.__init__r&rrr#rr0Nr(r0c@r) APICallErrorNrrrrrr2Wrr2c@s eZdZdZddZddZdS)APIz1A data holder for returning API data for display.cCs"||_||_||_||_||_dSN)namer* is_default_clientbase_url)r!r5r*r6clientr8rrrr^s  z API.__init__cCs|jjSr4)r7MESSAGES_MODULEr!rrrGetMessagesModuleeszAPI.GetMessagesModuleN)rrr__doc__rr<rrrrr3[s r3c@seZdZdZddZdS) APICollectionz4A data holder for collection information for an API.cCsd|j|_|j|_|j|_|j|_|j|_|j|_|d|_|d|_ |j |_ |j |_ |j |_ dS)N) r"r/r8docs_urlr5 full_nameGetPath detailed_path GetParamsdetailed_paramspathparamsenable_uri_parsing)r!collection_inforrrrls   zAPICollection.__init__N)rrrr=rrrrrr>is r>c@seZdZdZ d(ddZeddZeddZd d Zd d Z d dZ ddZ ddZ ddZ ddZddZddZddZddZ  d)d d!Z  d*d"d#Zd$d%Zd&d'ZdS)+ APIMethodz;A data holder for method information for an API collection.FcCs||_||_||_||_|j|_|jjt}|j|r&|jt |d|_t |jj |j |_ |j|_|jrGt |jj |j|_t|j|_n|j |_|j|_|j|_|j|_|j|_|j|_||_|j|_dSr4)_service _method_name_disable_paginationr. method_idr5rANAME_SEPARATOR startswithlen_RemoveVersionPrefixr/ relative_pathrFordered_paramsrG flat_pathrCr GetParamsFromPathrE http_method request_fieldrequest_type_name request_typeresponse_type_name response_type_RequestCollection_request_collection query_params)r!servicer5api_collection method_configdisable_pagination dotted_pathrrrr}s2      zAPIMethod.__init__cCs|r|jS|jS)a Gets the collection that should be used to represent the resource. Most of the time this is the same as request_collection because all methods in a collection operate on the same resource and so the API method takes the same parameters that make up the resource. One exception is List methods where the API parameters are for the parent collection. Because people don't specify the resource directly for list commands this also returns the parent collection for parsing purposes. The other exception is Create methods. They reference the parent collection list Like, but the difference is that we *do* want to specify the actual resource on the command line, so the original resource collection is returned here instead of the one that matches the API methods. When generating the request, you must figure out how to generate the message correctly from the parsed resource (as you cannot simply pass the reference to the API). Returns: APICollection: The collection. )IsListr^r.r;rrrresource_argument_collectionsz&APIMethod.resource_argument_collectioncCs|jS)zFGets the API collection that matches the parameters of the API method.)r^r;rrrrequest_collectionszAPIMethod.request_collectioncC|j|jS)z0Gets the apitools request class for this method.)rKGetRequestTyperLr;rrrrizAPIMethod.GetRequestTypecCrh)z1Gets the apitools response class for this method.)rKGetResponseTyperLr;rrrrkrjzAPIMethod.GetResponseTypecCs.|}r|rt||jS|S)aGGets the effective apitools response class for this method. This will be different from GetResponseType for List methods if we are extracting the list of response items from the overall response. This will always match the type of response that Call() returns. Returns: The apitools Message object. ) ListItemFieldHasTokenizedRequestr GetFieldFromMessagerktype)r! item_fieldrrrGetEffectiveResponseTypes z"APIMethod.GetEffectiveResponseTypecCs|jjj}t||dS)axGets a arbitrary apitools message class by name. This method can be used to get arbitrary apitools messages from the underlying service. Examples: policy_type = method.GetMessageByName('Policy') status_type = method.GetMessageByName('Status') Args: name: str, the name of the message to return. Returns: The apitools Message object. N)rKr9r:getattr)r!r5msgsrrrGetMessageByNames  zAPIMethod.GetMessageByNamecCs |jdkS)z)Determines whether this is a List method.List)rLr;rrrres zAPIMethod.IsListcCs |j od|vod|vS)z9Determines whether this is a method that supports paging. pageToken nextPageToken)rM_RequestFieldNames_ResponseFieldNamesr;rrrrms   zAPIMethod.HasTokenizedRequestcCs$|}d|vr dSd|vrdSdS)zAGets the name of the page size field in the request if it exists. maxResultspageSizeN)rx)r!request_fieldsrrrBatchPageSizeFields zAPIMethod.BatchPageSizeFieldcCs>|jrdS|}dd|D}t|dkr|djSdS)aGets the name of the field that contains the items in paginated response. This will return None if the method is not a paginated or if a single repeated field of items could not be found in the response type. Returns: str, The name of the field or None. NcSs$g|]}|jtjjkr|jr|qSr)variantrVariantMESSAGErepeated.0frrr sz+APIMethod.ListItemField..r)rMrk all_fieldsrQr5)r!responsefoundrrrrls   zAPIMethod.ListItemFieldcCsr|j|jjkr |jSt|jj|jj}|D]}|j|jkr'|j|jvr'|Sq|D] }|j|jkr6|Sq*dS)a#Gets the collection that matches the API parameters of this method. Methods apply to elements of a collection. The resource argument is always of the type of that collection. List is an exception where you are listing items of that collection so the argument to be provided is that of the parent collection. This method returns the collection that should be used to parse the resource for this specific method. Returns: APICollection, The collection to use or None if no parent collection could be found. N)rEr.GetAPICollectionsr"r/rC)r! collectionscrrrr]s     zAPIMethod._RequestCollectioncCdd|DS)aGets the fields that are actually a part of the request message. For APIs that use atomic names, this will only be the single name parameter (and any other message fields) but not the detailed parameters. Returns: [str], The field names. cSg|]}|jqSrr5rrrrr2z0APIMethod._RequestFieldNames..)rirr;rrrrx)s zAPIMethod._RequestFieldNamescCr)zrGets the fields that are actually a part of the response message. Returns: [str], The field names. cSrrrrrrrr:rz1APIMethod._ResponseFieldNames..)rkrr;rrrry4szAPIMethod._ResponseFieldNamesNc Cs|durt|jj|jj}t||jj}|j|||||d}z||dWStj y?} z t j dddt t | d} ~ ww)aExecutes this method with the given arguments. Args: request: The apitools request object to send. client: base_api.BaseApiClient, An API client to use for making requests. global_params: {str: str}, A dictionary of global parameters to send with the request. raw: bool, True to not do any processing of the response, False to maybe do processing for List results. limit: int, The max number of items to return if this is a List method. page_size: int, The max number of items to return in a page if this API supports paging. Returns: The response from the API. N)rawlimit page_size global_paramsr?T)exc_info)rGetClientInstancer.r"r/ _GetServicer5_GetRequestFunc apitools_excInvalidUserInputErrorr debugr2str) r!requestr9rrrrr` request_funcerrrCall<s    zAPIMethod.Callcs|sjr Ss rtdSs5r/SSdfdd }|S)aGets a request function to call and process the results. If this is a method with paginated response, it may flatten the response depending on if the List Pager can be used. Args: service: The apitools service that will be making the request. request: The apitools request object to send. raw: bool, True to not do any processing of the response, False to maybe do processing for List results. limit: int, The max number of items to return if this is a List method. page_size: int, The max number of items to return in a page if this API supports paging. Returns: A function to make the request. z.RequestFuncr4)rM_NormalRequestrlrer rrm_FlatNonPagedRequest)r!r`rrrrrrrrrZs    zAPIMethod._GetRequestFunccsdfdd }|S)zGenerates a basic request function for the method. Args: service: The apitools service that will be making the request. request: The apitools request object to send. Returns: A function to make the request. Ncstj}||dSNr)rrrL)rr1rr!r`rrrs  z-APIMethod._NormalRequest..RequestFuncr4r)r!r`rrrrrrs zAPIMethod._NormalRequestcsdfdd }|S)aGenerates a request function for the method that extracts an item list. List responses usually have a single repeated field that represents the actual items being listed. This request function returns only those items not the entire response. Args: service: The apitools service that will be making the request. request: The apitools request object to send. item_field: str, The name of the field that the list of items can be found in. Returns: A function to make the request. Ncs|d}t|Sr)rrr)rrrprr!r`rrrs  z3APIMethod._FlatNonPagedRequest..RequestFuncr4r)r!r`rrprrrrrszAPIMethod._FlatNonPagedRequest)F)NNFNN)FNN)rrrr=rpropertyrfrgrirkrqrtrermr}rlr]rxryrrrrrrrrrJzs6 !      . rJcCs*|sdS||r|t|ddS|S)z@Trims the version number off the front of a URL path if present.Nr)rPrQ)r/rFrrrrRs  rRcCslt|\}}tj|i}|st||r!||vrt|||St|D] \}}|j r1|Sq&t |)zCValidates the API exists and gets the default version if not given.) r _GetApiNameAndAliasr MAPgetrr)six iteritemsdefault_versionr,)r"r/_api_versr*api_defrrr_ValidateAndGetDefaultVersions rcCst||}t||}|jrt|}nt||}t|dr#|j}nz t||j}Wnt y;d ||}Ynwt |||j ||S)zGet a specific API definition. Args: api_name: str, The name of the API. api_version: str, The version string of the API. Returns: API, The API definition. BASE_URLzhttps://{}.googleapis.com/{}) rr GetApiDefapitools_GetClientClassFromDef_GetGapicClientClasshasattrr_GetResourceModule ImportErrorrr3r)r"r/r api_clientr8rrrGetAPIs&      rcCsBg}ttjD]\}}t|D] \}}|t||qq|S)zNGets all registered APIs. Returns: [API], A list of API definitions. )rrr rappendr)all_apisr"versionsr/rrrr GetAllAPIss rcCst|tdS)Nr)tuplesplitrO)r.rrr_SplitFullCollectionNamesrcCs\|r |t||i}nddtD}g}t|D]\}}|ddt||Dq|S)a(Gets the registered collections for the given API version. Args: api_name: str, The name of the API or None for all apis. api_version: str, The version string of the API or None to use the default version. Returns: [APICollection], A list of the registered collections. cSsi|] }|jr|j|jqSr)r6r5r*)rxrrr sz%GetAPICollections..cSsg|]}t|qSr)r>)rrrrrrsz%GetAPICollections..)rrrrextendr _GetApiCollections)r"r/rrnvrrrrs rcCsHt|\}}t||}t||}|D] }|j|kr|Sqt|||)aGets the given collection for the given API version. Args: full_collection_name: str, The collection to get including the api name. api_version: str, The version string of the API or None to use the default for this API. Returns: APICollection, The requested API collection. Raises: UnknownCollectionError: If the collection does not exist for the given API and version. )rrrr5r-)full_collection_namer/r"r.rrrrrGetAPICollections     rFcCs4t|||d}|D] }|j|kr|Sq t||)aGets the specification for the given API method. Args: full_collection_name: str, The collection including the api name. method: str, The name of the method. api_version: str, The version string of the API or None to use the default for this API. disable_pagination: bool, Boolean for whether pagination should be disabled Returns: APIMethod, The method specification. Raises: UnknownMethodError: If the method does not exist on the collection. )r/rc) GetMethodsr5r0)rr1r/rcmethodsmrrr GetMethod+s  rcCst||tddS)Nr)rrreplacerO)r9collection_namerrrrEsrcCs6t||}|jrtj||dd}|St||}|S)z+Gets the repesctive api client for the api.T)no_http)r rrrrGetGapicClientInstance)r"r/rr9rrr _GetApiClientIs  rcs^t||dtjj}t|jsgS}fdd|D}fdd|DS)atGets all the methods available on the given collection. Args: full_collection_name: str, The collection including the api name. api_version: str, The version string of the API or None to use the default for this API. disable_pagination: bool, Boolean for whether pagination should be disabled Returns: [APIMethod], The method specifications. )r/csg|] }||fqSr)GetMethodConfig)rr5)r`rrrjszGetMethods..cs g|] \}}t||qSr)rJ)rr5configrarcr`rrrls)rrr"r/rr5GetMethodsList)rr/rcr9 method_namesmethod_configsrrrrSs   rr4)NN)NF)-r= __future__rrrapitools.base.protorpcliterapitools.base.pyrrrgooglecloudsdk.api_lib.utilrr r $googlecloudsdk.command_lib.util.apisr googlecloudsdk.corer %googlecloudsdk.generated_clients.apisr rrOrrr)r,r-r0r2objectr3r>rJrRrrrrrrrrrrrrrrsT                  6