OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-11 14:02:22 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
32b9880b201303e9e84c5aa74a77dd67efb94de2
google-apis-rs/gen/apigee1/README.md
Sebastian Thiel 7abe6a3de2 regenerate all APIs and CLIs (#357)
2022-09-14 08:40:50 +08:00

212 lines
43 KiB
Markdown
Raw Blame History

<!---
DO NOT EDIT !
This file was generated automatically from 'src/generator/templates/api/README.md.mako'
DO NOT EDIT !
-->
The `google-apigee1` library allows access to all features of the *Google Apigee* service.
This documentation was generated from *Apigee* crate version *4.0.1+20220301*, where *20220301* is the exact revision of the *apigee:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v4.0.1*.
Everything else about the *Apigee* *v1* API can be found at the
[official documentation site](https://cloud.google.com/apigee-api-management/).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/Apigee) ...
* hybrid
* [*issuers list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::HybridIssuerListCall)
* organizations
* [*analytics datastores create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAnalyticDatastoreCreateCall), [*analytics datastores delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAnalyticDatastoreDeleteCall), [*analytics datastores get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAnalyticDatastoreGetCall), [*analytics datastores list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAnalyticDatastoreListCall), [*analytics datastores test*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAnalyticDatastoreTestCall), [*analytics datastores update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAnalyticDatastoreUpdateCall), [*apiproducts attributes*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductAttributeCall), [*apiproducts attributes delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductAttributeDeleteCall), [*apiproducts attributes get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductAttributeGetCall), [*apiproducts attributes list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductAttributeListCall), [*apiproducts attributes update api product attribute*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductAttributeUpdateApiProductAttributeCall), [*apiproducts create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductCreateCall), [*apiproducts delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductDeleteCall), [*apiproducts get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductGetCall), [*apiproducts list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductListCall), [*apiproducts rateplans create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductRateplanCreateCall), [*apiproducts rateplans delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductRateplanDeleteCall), [*apiproducts rateplans get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductRateplanGetCall), [*apiproducts rateplans list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductRateplanListCall), [*apiproducts rateplans update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductRateplanUpdateCall), [*apiproducts update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiproductUpdateCall), [*apis create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiCreateCall), [*apis delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiDeleteCall), [*apis deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiDeploymentListCall), [*apis get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiGetCall), [*apis keyvaluemaps create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiKeyvaluemapCreateCall), [*apis keyvaluemaps delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiKeyvaluemapDeleteCall), [*apis list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiListCall), [*apis patch*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiPatchCall), [*apis revisions delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiRevisionDeleteCall), [*apis revisions deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiRevisionDeploymentListCall), [*apis revisions get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiRevisionGetCall), [*apis revisions update api proxy revision*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationApiRevisionUpdateApiProxyRevisionCall), [*apps get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAppGetCall), [*apps list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationAppListCall), [*create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationCreateCall), [*datacollectors create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDatacollectorCreateCall), [*datacollectors delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDatacollectorDeleteCall), [*datacollectors get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDatacollectorGetCall), [*datacollectors list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDatacollectorListCall), [*datacollectors patch*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDatacollectorPatchCall), [*delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeleteCall), [*deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeploymentListCall), [*developers apps attributes*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppAttributeCall), [*developers apps attributes delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppAttributeDeleteCall), [*developers apps attributes get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppAttributeGetCall), [*developers apps attributes list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppAttributeListCall), [*developers apps attributes update developer app attribute*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppAttributeUpdateDeveloperAppAttributeCall), [*developers apps create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppCreateCall), [*developers apps delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppDeleteCall), [*developers apps generate key pair or update developer app status*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppGenerateKeyPairOrUpdateDeveloperAppStatuCall), [*developers apps get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppGetCall), [*developers apps keys apiproducts delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyApiproductDeleteCall), [*developers apps keys apiproducts update developer app key api product*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyApiproductUpdateDeveloperAppKeyApiProductCall), [*developers apps keys create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyCreateCall), [*developers apps keys create create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyCreateCreateCall), [*developers apps keys delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyDeleteCall), [*developers apps keys get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyGetCall), [*developers apps keys replace developer app key*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyReplaceDeveloperAppKeyCall), [*developers apps keys update developer app key*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppKeyUpdateDeveloperAppKeyCall), [*developers apps list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppListCall), [*developers apps update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAppUpdateCall), [*developers attributes*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAttributeCall), [*developers attributes delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAttributeDeleteCall), [*developers attributes get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAttributeGetCall), [*developers attributes list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAttributeListCall), [*developers attributes update developer attribute*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperAttributeUpdateDeveloperAttributeCall), [*developers balance adjust*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperBalanceAdjustCall), [*developers balance credit*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperBalanceCreditCall), [*developers create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperCreateCall), [*developers delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperDeleteCall), [*developers get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperGetCall), [*developers get balance*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperGetBalanceCall), [*developers get monetization config*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperGetMonetizationConfigCall), [*developers list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperListCall), [*developers set developer status*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperSetDeveloperStatuCall), [*developers subscriptions create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperSubscriptionCreateCall), [*developers subscriptions expire*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperSubscriptionExpireCall), [*developers subscriptions get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperSubscriptionGetCall), [*developers subscriptions list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperSubscriptionListCall), [*developers update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperUpdateCall), [*developers update monetization config*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationDeveloperUpdateMonetizationConfigCall), [*endpoint attachments create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEndpointAttachmentCreateCall), [*endpoint attachments delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEndpointAttachmentDeleteCall), [*endpoint attachments get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEndpointAttachmentGetCall), [*endpoint attachments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEndpointAttachmentListCall), [*envgroups attachments create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupAttachmentCreateCall), [*envgroups attachments delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupAttachmentDeleteCall), [*envgroups attachments get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupAttachmentGetCall), [*envgroups attachments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupAttachmentListCall), [*envgroups create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupCreateCall), [*envgroups delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupDeleteCall), [*envgroups get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupGetCall), [*envgroups list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupListCall), [*envgroups patch*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvgroupPatchCall), [*environments analytics admin get schemav2*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentAnalyticAdminGetSchemav2Call), [*environments analytics exports create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentAnalyticExportCreateCall), [*environments analytics exports get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentAnalyticExportGetCall), [*environments analytics exports list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentAnalyticExportListCall), [*environments apis deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiDeploymentListCall), [*environments apis revisions debugsessions create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDebugsessionCreateCall), [*environments apis revisions debugsessions data get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDebugsessionDataGetCall), [*environments apis revisions debugsessions delete data*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDebugsessionDeleteDataCall), [*environments apis revisions debugsessions get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDebugsessionGetCall), [*environments apis revisions debugsessions list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDebugsessionListCall), [*environments apis revisions deploy*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDeployCall), [*environments apis revisions deployments generate deploy change report*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDeploymentGenerateDeployChangeReportCall), [*environments apis revisions deployments generate undeploy change report*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionDeploymentGenerateUndeployChangeReportCall), [*environments apis revisions get deployments*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionGetDeploymentCall), [*environments apis revisions undeploy*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentApiRevisionUndeployCall), [*environments archive deployments create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentArchiveDeploymentCreateCall), [*environments archive deployments delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentArchiveDeploymentDeleteCall), [*environments archive deployments generate download url*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentArchiveDeploymentGenerateDownloadUrlCall), [*environments archive deployments generate upload url*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentArchiveDeploymentGenerateUploadUrlCall), [*environments archive deployments get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentArchiveDeploymentGetCall), [*environments archive deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentArchiveDeploymentListCall), [*environments archive deployments patch*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentArchiveDeploymentPatchCall), [*environments caches delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentCacheDeleteCall), [*environments create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentCreateCall), [*environments delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentDeleteCall), [*environments deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentDeploymentListCall), [*environments flowhooks attach shared flow to flow hook*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentFlowhookAttachSharedFlowToFlowHookCall), [*environments flowhooks detach shared flow from flow hook*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentFlowhookDetachSharedFlowFromFlowHookCall), [*environments flowhooks get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentFlowhookGetCall), [*environments get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentGetCall), [*environments get debugmask*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentGetDebugmaskCall), [*environments get deployed config*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentGetDeployedConfigCall), [*environments get iam policy*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentGetIamPolicyCall), [*environments get trace config*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentGetTraceConfigCall), [*environments keystores aliases create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreAliaseCreateCall), [*environments keystores aliases csr*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreAliaseCsrCall), [*environments keystores aliases delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreAliaseDeleteCall), [*environments keystores aliases get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreAliaseGetCall), [*environments keystores aliases get certificate*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreAliaseGetCertificateCall), [*environments keystores aliases update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreAliaseUpdateCall), [*environments keystores create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreCreateCall), [*environments keystores delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreDeleteCall), [*environments keystores get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeystoreGetCall), [*environments keyvaluemaps create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeyvaluemapCreateCall), [*environments keyvaluemaps delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentKeyvaluemapDeleteCall), [*environments optimized stats get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentOptimizedStatGetCall), [*environments queries create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentQueryCreateCall), [*environments queries get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentQueryGetCall), [*environments queries get result*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentQueryGetResultCall), [*environments queries list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentQueryListCall), [*environments references create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentReferenceCreateCall), [*environments references delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentReferenceDeleteCall), [*environments references get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentReferenceGetCall), [*environments references update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentReferenceUpdateCall), [*environments resourcefiles create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentResourcefileCreateCall), [*environments resourcefiles delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentResourcefileDeleteCall), [*environments resourcefiles get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentResourcefileGetCall), [*environments resourcefiles list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentResourcefileListCall), [*environments resourcefiles list environment resources*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentResourcefileListEnvironmentResourceCall), [*environments resourcefiles update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentResourcefileUpdateCall), [*environments set iam policy*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentSetIamPolicyCall), [*environments sharedflows deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentSharedflowDeploymentListCall), [*environments sharedflows revisions deploy*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentSharedflowRevisionDeployCall), [*environments sharedflows revisions get deployments*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentSharedflowRevisionGetDeploymentCall), [*environments sharedflows revisions undeploy*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentSharedflowRevisionUndeployCall), [*environments stats get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentStatGetCall), [*environments subscribe*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentSubscribeCall), [*environments targetservers create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTargetserverCreateCall), [*environments targetservers delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTargetserverDeleteCall), [*environments targetservers get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTargetserverGetCall), [*environments targetservers update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTargetserverUpdateCall), [*environments test iam permissions*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTestIamPermissionCall), [*environments trace config overrides create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTraceConfigOverrideCreateCall), [*environments trace config overrides delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTraceConfigOverrideDeleteCall), [*environments trace config overrides get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTraceConfigOverrideGetCall), [*environments trace config overrides list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTraceConfigOverrideListCall), [*environments trace config overrides patch*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentTraceConfigOverridePatchCall), [*environments unsubscribe*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentUnsubscribeCall), [*environments update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentUpdateCall), [*environments update debugmask*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentUpdateDebugmaskCall), [*environments update environment*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentUpdateEnvironmentCall), [*environments update trace config*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationEnvironmentUpdateTraceConfigCall), [*get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationGetCall), [*get deployed ingress config*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationGetDeployedIngressConfigCall), [*get runtime config*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationGetRuntimeConfigCall), [*get sync authorization*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationGetSyncAuthorizationCall), [*host queries create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationHostQueryCreateCall), [*host queries get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationHostQueryGetCall), [*host queries get result*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationHostQueryGetResultCall), [*host queries get result view*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationHostQueryGetResultViewCall), [*host queries list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationHostQueryListCall), [*host stats get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationHostStatGetCall), [*instances attachments create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceAttachmentCreateCall), [*instances attachments delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceAttachmentDeleteCall), [*instances attachments get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceAttachmentGetCall), [*instances attachments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceAttachmentListCall), [*instances canaryevaluations create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceCanaryevaluationCreateCall), [*instances canaryevaluations get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceCanaryevaluationGetCall), [*instances create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceCreateCall), [*instances delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceDeleteCall), [*instances get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceGetCall), [*instances list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceListCall), [*instances nat addresses activate*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceNatAddresseActivateCall), [*instances nat addresses create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceNatAddresseCreateCall), [*instances nat addresses delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceNatAddresseDeleteCall), [*instances nat addresses get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceNatAddresseGetCall), [*instances nat addresses list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceNatAddresseListCall), [*instances patch*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstancePatchCall), [*instances report status*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationInstanceReportStatuCall), [*keyvaluemaps create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationKeyvaluemapCreateCall), [*keyvaluemaps delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationKeyvaluemapDeleteCall), [*list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationListCall), [*operations get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationOperationGetCall), [*operations list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationOperationListCall), [*optimized host stats get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationOptimizedHostStatGetCall), [*reports create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationReportCreateCall), [*reports delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationReportDeleteCall), [*reports get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationReportGetCall), [*reports list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationReportListCall), [*reports update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationReportUpdateCall), [*set addons*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSetAddonCall), [*set sync authorization*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSetSyncAuthorizationCall), [*sharedflows create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowCreateCall), [*sharedflows delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowDeleteCall), [*sharedflows deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowDeploymentListCall), [*sharedflows get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowGetCall), [*sharedflows list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowListCall), [*sharedflows revisions delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowRevisionDeleteCall), [*sharedflows revisions deployments list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowRevisionDeploymentListCall), [*sharedflows revisions get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowRevisionGetCall), [*sharedflows revisions update shared flow revision*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSharedflowRevisionUpdateSharedFlowRevisionCall), [*sites apicategories create*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSiteApicategoryCreateCall), [*sites apicategories delete*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSiteApicategoryDeleteCall), [*sites apicategories get*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSiteApicategoryGetCall), [*sites apicategories list*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSiteApicategoryListCall), [*sites apicategories patch*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationSiteApicategoryPatchCall) and [*update*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::OrganizationUpdateCall)
* projects
* [*provision organization*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/api::ProjectProvisionOrganizationCall)
# Structure of this Library
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/Apigee)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::CallBuilder)
* **[Resources](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::CallBuilder)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
Generally speaking, you can invoke *Activities* like this:
```Rust,ignore
let r = hub.resource().activity(...).doit().await
```
Or specifically ...
```ignore
let r = hub.organizations().endpoint_attachments_create(...).doit().await
let r = hub.organizations().endpoint_attachments_delete(...).doit().await
let r = hub.organizations().envgroups_attachments_create(...).doit().await
let r = hub.organizations().envgroups_attachments_delete(...).doit().await
let r = hub.organizations().envgroups_create(...).doit().await
let r = hub.organizations().envgroups_delete(...).doit().await
let r = hub.organizations().envgroups_patch(...).doit().await
let r = hub.organizations().environments_archive_deployments_create(...).doit().await
let r = hub.organizations().environments_create(...).doit().await
let r = hub.organizations().environments_delete(...).doit().await
let r = hub.organizations().instances_attachments_create(...).doit().await
let r = hub.organizations().instances_attachments_delete(...).doit().await
let r = hub.organizations().instances_canaryevaluations_create(...).doit().await
let r = hub.organizations().instances_nat_addresses_activate(...).doit().await
let r = hub.organizations().instances_nat_addresses_create(...).doit().await
let r = hub.organizations().instances_nat_addresses_delete(...).doit().await
let r = hub.organizations().instances_create(...).doit().await
let r = hub.organizations().instances_delete(...).doit().await
let r = hub.organizations().instances_patch(...).doit().await
let r = hub.organizations().operations_get(...).doit().await
let r = hub.organizations().create(...).doit().await
let r = hub.organizations().delete(...).doit().await
let r = hub.organizations().set_addons(...).doit().await
let r = hub.projects().provision_organization(...).doit().await
```
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired.
The `doit()` method performs the actual communication with the server and returns the respective result.
# Usage
## Setting up your Project
To use this library, you would put the following lines into your `Cargo.toml` file:
```toml
[dependencies]
google-apigee1 = "*"
serde = "^1.0"
serde_json = "^1.0"
```
## A complete example
```Rust
extern crate hyper;
extern crate hyper_rustls;
extern crate google_apigee1 as apigee1;
use apigee1::api::GoogleCloudApigeeV1EndpointAttachment;
use apigee1::{Result, Error};
use std::default::Default;
use apigee1::{Apigee, oauth2, hyper, hyper_rustls};
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
// unless you replace `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = Apigee::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().enable_http2().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GoogleCloudApigeeV1EndpointAttachment::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.organizations().endpoint_attachments_create(req, "parent")
.endpoint_attachment_id("magna")
.doit().await;
match result {
Err(e) => match e {
// The Error enum provides details about what exactly happened.
// You can also just use its `Debug`, `Display` or `Error` traits
Error::HttpError(_)
|Error::Io(_)
|Error::MissingAPIKey
|Error::MissingToken(_)
|Error::Cancelled
|Error::UploadSizeLimitExceeded(_, _)
|Error::Failure(_)
|Error::BadRequest(_)
|Error::FieldClash(_)
|Error::JsonDecodeError(_, _) => println!("{}", e),
},
Ok(res) => println!("Success: {:?}", res),
}
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Result) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
makes the system potentially resilient to all kinds of errors.
## Uploads and Downloads
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::ResponseResult), it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: `.param("alt", "media")`.
Methods supporting uploads can do so using up to 2 different protocols:
*simple* and *resumable*. The distinctiveness of each is represented by customized
`doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively.
## Customization and Callbacks
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Delegate) to the
[Method Builder](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::CallBuilder) before making the final `doit()` call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The [delegate trait](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
## Optional Parts in Server-Requests
All structures provided by this library are made to be [encodable](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::RequestValue) and
[decodable](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
are valid.
Most optionals are are considered [Parts](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::Part) which are identifiable by name, which will be sent to
the server to indicate either the set parts of the request or the desired parts in the response.
## Builder Arguments
Using [method builders](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
These will always take a single argument, for which the following statements are true.
* [PODs][wiki-pod] are handed by copy
* strings are passed as `&str`
* [request values](https://docs.rs/google-apigee1/4.0.1+20220301/google_apigee1/client::RequestValue) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
[wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure
[builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern
[google-go-api]: https://github.com/google/google-api-go-client
# License
The **apigee1** library was generated by Sebastian Thiel, and is placed
under the *MIT* license.
You can read the full text at the repository's [license file][repo-license].
[repo-license]: https://github.com/Byron/google-apis-rsblob/main/LICENSE.md
Reference in New Issue View Git Blame Copy Permalink