Struct google_apigee1::api::OrganizationMethods
source · pub struct OrganizationMethods<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
A builder providing access to all methods supported on organization resources.
It is not used directly, but through the Apigee
hub.
§Example
Instantiate a resource builder
extern crate hyper;
extern crate hyper_rustls;
extern crate google_apigee1 as apigee1;
use std::default::Default;
use apigee1::{Apigee, oauth2, hyper, hyper_rustls, chrono, FieldMask};
let secret: oauth2::ApplicationSecret = Default::default();
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().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `analytics_datastores_create(...)`, `analytics_datastores_delete(...)`, `analytics_datastores_get(...)`, `analytics_datastores_list(...)`, `analytics_datastores_test(...)`, `analytics_datastores_update(...)`, `apiproducts_attributes(...)`, `apiproducts_attributes_delete(...)`, `apiproducts_attributes_get(...)`, `apiproducts_attributes_list(...)`, `apiproducts_attributes_update_api_product_attribute(...)`, `apiproducts_create(...)`, `apiproducts_delete(...)`, `apiproducts_get(...)`, `apiproducts_list(...)`, `apiproducts_rateplans_create(...)`, `apiproducts_rateplans_delete(...)`, `apiproducts_rateplans_get(...)`, `apiproducts_rateplans_list(...)`, `apiproducts_rateplans_update(...)`, `apiproducts_update(...)`, `apis_create(...)`, `apis_delete(...)`, `apis_deployments_list(...)`, `apis_get(...)`, `apis_keyvaluemaps_create(...)`, `apis_keyvaluemaps_delete(...)`, `apis_keyvaluemaps_entries_create(...)`, `apis_keyvaluemaps_entries_delete(...)`, `apis_keyvaluemaps_entries_get(...)`, `apis_keyvaluemaps_entries_list(...)`, `apis_keyvaluemaps_entries_update(...)`, `apis_list(...)`, `apis_patch(...)`, `apis_revisions_delete(...)`, `apis_revisions_deployments_list(...)`, `apis_revisions_get(...)`, `apis_revisions_update_api_proxy_revision(...)`, `appgroups_apps_create(...)`, `appgroups_apps_delete(...)`, `appgroups_apps_get(...)`, `appgroups_apps_keys_apiproducts_delete(...)`, `appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product(...)`, `appgroups_apps_keys_create(...)`, `appgroups_apps_keys_delete(...)`, `appgroups_apps_keys_get(...)`, `appgroups_apps_keys_update_app_group_app_key(...)`, `appgroups_apps_list(...)`, `appgroups_apps_update(...)`, `appgroups_create(...)`, `appgroups_delete(...)`, `appgroups_get(...)`, `appgroups_list(...)`, `appgroups_update(...)`, `apps_get(...)`, `apps_list(...)`, `create(...)`, `datacollectors_create(...)`, `datacollectors_delete(...)`, `datacollectors_get(...)`, `datacollectors_list(...)`, `datacollectors_patch(...)`, `delete(...)`, `deployments_list(...)`, `developers_apps_attributes(...)`, `developers_apps_attributes_delete(...)`, `developers_apps_attributes_get(...)`, `developers_apps_attributes_list(...)`, `developers_apps_attributes_update_developer_app_attribute(...)`, `developers_apps_create(...)`, `developers_apps_delete(...)`, `developers_apps_generate_key_pair_or_update_developer_app_status(...)`, `developers_apps_get(...)`, `developers_apps_keys_apiproducts_delete(...)`, `developers_apps_keys_apiproducts_update_developer_app_key_api_product(...)`, `developers_apps_keys_create(...)`, `developers_apps_keys_create_create(...)`, `developers_apps_keys_delete(...)`, `developers_apps_keys_get(...)`, `developers_apps_keys_replace_developer_app_key(...)`, `developers_apps_keys_update_developer_app_key(...)`, `developers_apps_list(...)`, `developers_apps_update(...)`, `developers_attributes(...)`, `developers_attributes_delete(...)`, `developers_attributes_get(...)`, `developers_attributes_list(...)`, `developers_attributes_update_developer_attribute(...)`, `developers_balance_adjust(...)`, `developers_balance_credit(...)`, `developers_create(...)`, `developers_delete(...)`, `developers_get(...)`, `developers_get_balance(...)`, `developers_get_monetization_config(...)`, `developers_list(...)`, `developers_set_developer_status(...)`, `developers_subscriptions_create(...)`, `developers_subscriptions_expire(...)`, `developers_subscriptions_get(...)`, `developers_subscriptions_list(...)`, `developers_update(...)`, `developers_update_monetization_config(...)`, `endpoint_attachments_create(...)`, `endpoint_attachments_delete(...)`, `endpoint_attachments_get(...)`, `endpoint_attachments_list(...)`, `envgroups_attachments_create(...)`, `envgroups_attachments_delete(...)`, `envgroups_attachments_get(...)`, `envgroups_attachments_list(...)`, `envgroups_create(...)`, `envgroups_delete(...)`, `envgroups_get(...)`, `envgroups_get_deployed_ingress_config(...)`, `envgroups_list(...)`, `envgroups_patch(...)`, `environments_addons_config_set_addon_enablement(...)`, `environments_analytics_admin_get_schemav2(...)`, `environments_analytics_exports_create(...)`, `environments_analytics_exports_get(...)`, `environments_analytics_exports_list(...)`, `environments_apis_deployments_list(...)`, `environments_apis_revisions_debugsessions_create(...)`, `environments_apis_revisions_debugsessions_data_get(...)`, `environments_apis_revisions_debugsessions_delete_data(...)`, `environments_apis_revisions_debugsessions_get(...)`, `environments_apis_revisions_debugsessions_list(...)`, `environments_apis_revisions_deploy(...)`, `environments_apis_revisions_deployments_generate_deploy_change_report(...)`, `environments_apis_revisions_deployments_generate_undeploy_change_report(...)`, `environments_apis_revisions_get_deployments(...)`, `environments_apis_revisions_undeploy(...)`, `environments_archive_deployments_create(...)`, `environments_archive_deployments_delete(...)`, `environments_archive_deployments_generate_download_url(...)`, `environments_archive_deployments_generate_upload_url(...)`, `environments_archive_deployments_get(...)`, `environments_archive_deployments_list(...)`, `environments_archive_deployments_patch(...)`, `environments_caches_delete(...)`, `environments_create(...)`, `environments_delete(...)`, `environments_deployments_list(...)`, `environments_flowhooks_attach_shared_flow_to_flow_hook(...)`, `environments_flowhooks_detach_shared_flow_from_flow_hook(...)`, `environments_flowhooks_get(...)`, `environments_get(...)`, `environments_get_addons_config(...)`, `environments_get_api_security_runtime_config(...)`, `environments_get_debugmask(...)`, `environments_get_deployed_config(...)`, `environments_get_iam_policy(...)`, `environments_get_security_actions_config(...)`, `environments_get_trace_config(...)`, `environments_keystores_aliases_create(...)`, `environments_keystores_aliases_csr(...)`, `environments_keystores_aliases_delete(...)`, `environments_keystores_aliases_get(...)`, `environments_keystores_aliases_get_certificate(...)`, `environments_keystores_aliases_update(...)`, `environments_keystores_create(...)`, `environments_keystores_delete(...)`, `environments_keystores_get(...)`, `environments_keyvaluemaps_create(...)`, `environments_keyvaluemaps_delete(...)`, `environments_keyvaluemaps_entries_create(...)`, `environments_keyvaluemaps_entries_delete(...)`, `environments_keyvaluemaps_entries_get(...)`, `environments_keyvaluemaps_entries_list(...)`, `environments_keyvaluemaps_entries_update(...)`, `environments_modify_environment(...)`, `environments_optimized_stats_get(...)`, `environments_queries_create(...)`, `environments_queries_get(...)`, `environments_queries_get_result(...)`, `environments_queries_get_resulturl(...)`, `environments_queries_list(...)`, `environments_references_create(...)`, `environments_references_delete(...)`, `environments_references_get(...)`, `environments_references_update(...)`, `environments_resourcefiles_create(...)`, `environments_resourcefiles_delete(...)`, `environments_resourcefiles_get(...)`, `environments_resourcefiles_list(...)`, `environments_resourcefiles_list_environment_resources(...)`, `environments_resourcefiles_update(...)`, `environments_security_actions_create(...)`, `environments_security_actions_disable(...)`, `environments_security_actions_enable(...)`, `environments_security_actions_get(...)`, `environments_security_actions_list(...)`, `environments_security_incidents_batch_update(...)`, `environments_security_incidents_get(...)`, `environments_security_incidents_list(...)`, `environments_security_incidents_patch(...)`, `environments_security_reports_create(...)`, `environments_security_reports_get(...)`, `environments_security_reports_get_result(...)`, `environments_security_reports_get_result_view(...)`, `environments_security_reports_list(...)`, `environments_security_stats_query_tabular_stats(...)`, `environments_security_stats_query_time_series_stats(...)`, `environments_set_iam_policy(...)`, `environments_sharedflows_deployments_list(...)`, `environments_sharedflows_revisions_deploy(...)`, `environments_sharedflows_revisions_get_deployments(...)`, `environments_sharedflows_revisions_undeploy(...)`, `environments_stats_get(...)`, `environments_subscribe(...)`, `environments_targetservers_create(...)`, `environments_targetservers_delete(...)`, `environments_targetservers_get(...)`, `environments_targetservers_update(...)`, `environments_test_iam_permissions(...)`, `environments_trace_config_overrides_create(...)`, `environments_trace_config_overrides_delete(...)`, `environments_trace_config_overrides_get(...)`, `environments_trace_config_overrides_list(...)`, `environments_trace_config_overrides_patch(...)`, `environments_unsubscribe(...)`, `environments_update(...)`, `environments_update_debugmask(...)`, `environments_update_environment(...)`, `environments_update_security_actions_config(...)`, `environments_update_trace_config(...)`, `get(...)`, `get_deployed_ingress_config(...)`, `get_project_mapping(...)`, `get_runtime_config(...)`, `get_security_settings(...)`, `get_sync_authorization(...)`, `host_queries_create(...)`, `host_queries_get(...)`, `host_queries_get_result(...)`, `host_queries_get_result_view(...)`, `host_queries_list(...)`, `host_security_reports_create(...)`, `host_security_reports_get(...)`, `host_security_reports_get_result(...)`, `host_security_reports_get_result_view(...)`, `host_security_reports_list(...)`, `host_stats_get(...)`, `instances_attachments_create(...)`, `instances_attachments_delete(...)`, `instances_attachments_get(...)`, `instances_attachments_list(...)`, `instances_canaryevaluations_create(...)`, `instances_canaryevaluations_get(...)`, `instances_create(...)`, `instances_delete(...)`, `instances_get(...)`, `instances_list(...)`, `instances_nat_addresses_activate(...)`, `instances_nat_addresses_create(...)`, `instances_nat_addresses_delete(...)`, `instances_nat_addresses_get(...)`, `instances_nat_addresses_list(...)`, `instances_patch(...)`, `instances_report_status(...)`, `keyvaluemaps_create(...)`, `keyvaluemaps_delete(...)`, `keyvaluemaps_entries_create(...)`, `keyvaluemaps_entries_delete(...)`, `keyvaluemaps_entries_get(...)`, `keyvaluemaps_entries_list(...)`, `keyvaluemaps_entries_update(...)`, `list(...)`, `operations_get(...)`, `operations_list(...)`, `optimized_host_stats_get(...)`, `reports_create(...)`, `reports_delete(...)`, `reports_get(...)`, `reports_list(...)`, `reports_update(...)`, `security_profiles_create(...)`, `security_profiles_delete(...)`, `security_profiles_environments_compute_environment_scores(...)`, `security_profiles_environments_create(...)`, `security_profiles_environments_delete(...)`, `security_profiles_get(...)`, `security_profiles_list(...)`, `security_profiles_list_revisions(...)`, `security_profiles_patch(...)`, `set_addons(...)`, `set_sync_authorization(...)`, `sharedflows_create(...)`, `sharedflows_delete(...)`, `sharedflows_deployments_list(...)`, `sharedflows_get(...)`, `sharedflows_list(...)`, `sharedflows_revisions_delete(...)`, `sharedflows_revisions_deployments_list(...)`, `sharedflows_revisions_get(...)`, `sharedflows_revisions_update_shared_flow_revision(...)`, `sites_apicategories_create(...)`, `sites_apicategories_delete(...)`, `sites_apicategories_get(...)`, `sites_apicategories_list(...)`, `sites_apicategories_patch(...)`, `sites_apidocs_create(...)`, `sites_apidocs_delete(...)`, `sites_apidocs_get(...)`, `sites_apidocs_get_documentation(...)`, `sites_apidocs_list(...)`, `sites_apidocs_update(...)`, `sites_apidocs_update_documentation(...)`, `update(...)` and `update_security_settings(...)`
// to build up your call.
let rb = hub.organizations();
Implementations§
source§impl<'a, S> OrganizationMethods<'a, S>
impl<'a, S> OrganizationMethods<'a, S>
sourcepub fn analytics_datastores_create(
&self,
request: GoogleCloudApigeeV1Datastore,
parent: &str
) -> OrganizationAnalyticDatastoreCreateCall<'a, S>
pub fn analytics_datastores_create( &self, request: GoogleCloudApigeeV1Datastore, parent: &str ) -> OrganizationAnalyticDatastoreCreateCall<'a, S>
Create a builder to help you perform the following task:
Create a Datastore for an org
§Arguments
request
- No description provided.parent
- Required. The parent organization name. Must be of the formorganizations/{org}
.
sourcepub fn analytics_datastores_delete(
&self,
name: &str
) -> OrganizationAnalyticDatastoreDeleteCall<'a, S>
pub fn analytics_datastores_delete( &self, name: &str ) -> OrganizationAnalyticDatastoreDeleteCall<'a, S>
Create a builder to help you perform the following task:
Delete a Datastore from an org.
§Arguments
name
- Required. Resource name of the Datastore to be deleted. Must be of the formorganizations/{org}/analytics/datastores/{datastoreId}
sourcepub fn analytics_datastores_get(
&self,
name: &str
) -> OrganizationAnalyticDatastoreGetCall<'a, S>
pub fn analytics_datastores_get( &self, name: &str ) -> OrganizationAnalyticDatastoreGetCall<'a, S>
Create a builder to help you perform the following task:
Get a Datastore
§Arguments
name
- Required. Resource name of the Datastore to be get. Must be of the formorganizations/{org}/analytics/datastores/{datastoreId}
sourcepub fn analytics_datastores_list(
&self,
parent: &str
) -> OrganizationAnalyticDatastoreListCall<'a, S>
pub fn analytics_datastores_list( &self, parent: &str ) -> OrganizationAnalyticDatastoreListCall<'a, S>
Create a builder to help you perform the following task:
List Datastores
§Arguments
parent
- Required. The parent organization name. Must be of the formorganizations/{org}
.
sourcepub fn analytics_datastores_test(
&self,
request: GoogleCloudApigeeV1Datastore,
parent: &str
) -> OrganizationAnalyticDatastoreTestCall<'a, S>
pub fn analytics_datastores_test( &self, request: GoogleCloudApigeeV1Datastore, parent: &str ) -> OrganizationAnalyticDatastoreTestCall<'a, S>
Create a builder to help you perform the following task:
Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage
§Arguments
request
- No description provided.parent
- Required. The parent organization name Must be of the formorganizations/{org}
sourcepub fn analytics_datastores_update(
&self,
request: GoogleCloudApigeeV1Datastore,
name: &str
) -> OrganizationAnalyticDatastoreUpdateCall<'a, S>
pub fn analytics_datastores_update( &self, request: GoogleCloudApigeeV1Datastore, name: &str ) -> OrganizationAnalyticDatastoreUpdateCall<'a, S>
Create a builder to help you perform the following task:
Update a Datastore
§Arguments
request
- No description provided.name
- Required. The resource name of datastore to be updated. Must be of the formorganizations/{org}/analytics/datastores/{datastoreId}
sourcepub fn apiproducts_attributes_delete(
&self,
name: &str
) -> OrganizationApiproductAttributeDeleteCall<'a, S>
pub fn apiproducts_attributes_delete( &self, name: &str ) -> OrganizationApiproductAttributeDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an API product attribute.
§Arguments
name
- Required. Name of the API product attribute. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}
sourcepub fn apiproducts_attributes_get(
&self,
name: &str
) -> OrganizationApiproductAttributeGetCall<'a, S>
pub fn apiproducts_attributes_get( &self, name: &str ) -> OrganizationApiproductAttributeGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the value of an API product attribute.
§Arguments
name
- Required. Name of the API product attribute. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}
sourcepub fn apiproducts_attributes_list(
&self,
parent: &str
) -> OrganizationApiproductAttributeListCall<'a, S>
pub fn apiproducts_attributes_list( &self, parent: &str ) -> OrganizationApiproductAttributeListCall<'a, S>
Create a builder to help you perform the following task:
Lists all API product attributes.
§Arguments
parent
- Required. Name of the API product. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
sourcepub fn apiproducts_attributes_update_api_product_attribute(
&self,
request: GoogleCloudApigeeV1Attribute,
name: &str
) -> OrganizationApiproductAttributeUpdateApiProductAttributeCall<'a, S>
pub fn apiproducts_attributes_update_api_product_attribute( &self, request: GoogleCloudApigeeV1Attribute, name: &str ) -> OrganizationApiproductAttributeUpdateApiProductAttributeCall<'a, S>
Create a builder to help you perform the following task:
Updates the value of an API product attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn
element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.
§Arguments
request
- No description provided.name
- Required. Name of the API product. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
sourcepub fn apiproducts_rateplans_create(
&self,
request: GoogleCloudApigeeV1RatePlan,
parent: &str
) -> OrganizationApiproductRateplanCreateCall<'a, S>
pub fn apiproducts_rateplans_create( &self, request: GoogleCloudApigeeV1RatePlan, parent: &str ) -> OrganizationApiproductRateplanCreateCall<'a, S>
Create a builder to help you perform the following task:
Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners An API product can have multiple rate plans associated with it but only one rate plan can be active at any point of time. **Note: From the developer’s perspective, they purchase API products not rate plans.
§Arguments
request
- No description provided.parent
- Required. Name of the API product that is associated with the rate plan. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
sourcepub fn apiproducts_rateplans_delete(
&self,
name: &str
) -> OrganizationApiproductRateplanDeleteCall<'a, S>
pub fn apiproducts_rateplans_delete( &self, name: &str ) -> OrganizationApiproductRateplanDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a rate plan.
§Arguments
name
- Required. ID of the rate plan. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
sourcepub fn apiproducts_rateplans_get(
&self,
name: &str
) -> OrganizationApiproductRateplanGetCall<'a, S>
pub fn apiproducts_rateplans_get( &self, name: &str ) -> OrganizationApiproductRateplanGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the details of a rate plan.
§Arguments
name
- Required. Name of the rate plan. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
sourcepub fn apiproducts_rateplans_list(
&self,
parent: &str
) -> OrganizationApiproductRateplanListCall<'a, S>
pub fn apiproducts_rateplans_list( &self, parent: &str ) -> OrganizationApiproductRateplanListCall<'a, S>
Create a builder to help you perform the following task:
Lists all the rate plans for an API product.
§Arguments
parent
- Required. Name of the API product. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
Useorganizations/{org}/apiproducts/-
to return rate plans for all API products within the organization.
sourcepub fn apiproducts_rateplans_update(
&self,
request: GoogleCloudApigeeV1RatePlan,
name: &str
) -> OrganizationApiproductRateplanUpdateCall<'a, S>
pub fn apiproducts_rateplans_update( &self, request: GoogleCloudApigeeV1RatePlan, name: &str ) -> OrganizationApiproductRateplanUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing rate plan.
§Arguments
request
- No description provided.name
- Required. Name of the rate plan. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
sourcepub fn apiproducts_attributes(
&self,
request: GoogleCloudApigeeV1Attributes,
name: &str
) -> OrganizationApiproductAttributeCall<'a, S>
pub fn apiproducts_attributes( &self, request: GoogleCloudApigeeV1Attributes, name: &str ) -> OrganizationApiproductAttributeCall<'a, S>
Create a builder to help you perform the following task:
Updates or creates API product attributes. This API replaces the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn
element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.
§Arguments
request
- No description provided.name
- Required. Name of the API product. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
sourcepub fn apiproducts_create(
&self,
request: GoogleCloudApigeeV1ApiProduct,
parent: &str
) -> OrganizationApiproductCreateCall<'a, S>
pub fn apiproducts_create( &self, request: GoogleCloudApigeeV1ApiProduct, parent: &str ) -> OrganizationApiproductCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. WARNING: - If you don’t specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don’t specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?
§Arguments
request
- No description provided.parent
- Required. Name of the organization in which the API product will be created. Use the following structure in your request:organizations/{org}
sourcepub fn apiproducts_delete(
&self,
name: &str
) -> OrganizationApiproductDeleteCall<'a, S>
pub fn apiproducts_delete( &self, name: &str ) -> OrganizationApiproductDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.
§Arguments
name
- Required. Name of the API product. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
sourcepub fn apiproducts_get(
&self,
name: &str
) -> OrganizationApiproductGetCall<'a, S>
pub fn apiproducts_get( &self, name: &str ) -> OrganizationApiproductGetCall<'a, S>
Create a builder to help you perform the following task:
Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.
§Arguments
name
- Required. Name of the API product. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
sourcepub fn apiproducts_list(
&self,
parent: &str
) -> OrganizationApiproductListCall<'a, S>
pub fn apiproducts_list( &self, parent: &str ) -> OrganizationApiproductListCall<'a, S>
Create a builder to help you perform the following task:
Lists all API product names for an organization. Filter the list by passing an attributename
and attibutevalue
. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the startKey
and count
query parameters.
§Arguments
parent
- Required. Name of the organization. Use the following structure in your request:organizations/{org}
sourcepub fn apiproducts_update(
&self,
request: GoogleCloudApigeeV1ApiProduct,
name: &str
) -> OrganizationApiproductUpdateCall<'a, S>
pub fn apiproducts_update( &self, request: GoogleCloudApigeeV1ApiProduct, name: &str ) -> OrganizationApiproductUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.
§Arguments
request
- No description provided.name
- Required. Name of the API product. Use the following structure in your request:organizations/{org}/apiproducts/{apiproduct}
sourcepub fn apis_deployments_list(
&self,
parent: &str
) -> OrganizationApiDeploymentListCall<'a, S>
pub fn apis_deployments_list( &self, parent: &str ) -> OrganizationApiDeploymentListCall<'a, S>
Create a builder to help you perform the following task:
Lists all deployments of an API proxy.
§Arguments
parent
- Required. Name of the API proxy for which to return deployment information in the following format:organizations/{org}/apis/{api}
sourcepub fn apis_keyvaluemaps_entries_create(
&self,
request: GoogleCloudApigeeV1KeyValueEntry,
parent: &str
) -> OrganizationApiKeyvaluemapEntryCreateCall<'a, S>
pub fn apis_keyvaluemaps_entries_create( &self, request: GoogleCloudApigeeV1KeyValueEntry, parent: &str ) -> OrganizationApiKeyvaluemapEntryCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
request
- No description provided.parent
- Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn apis_keyvaluemaps_entries_delete(
&self,
name: &str
) -> OrganizationApiKeyvaluemapEntryDeleteCall<'a, S>
pub fn apis_keyvaluemaps_entries_delete( &self, name: &str ) -> OrganizationApiKeyvaluemapEntryDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
§Arguments
name
- Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
sourcepub fn apis_keyvaluemaps_entries_get(
&self,
name: &str
) -> OrganizationApiKeyvaluemapEntryGetCall<'a, S>
pub fn apis_keyvaluemaps_entries_get( &self, name: &str ) -> OrganizationApiKeyvaluemapEntryGetCall<'a, S>
Create a builder to help you perform the following task:
Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
name
- Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
sourcepub fn apis_keyvaluemaps_entries_list(
&self,
parent: &str
) -> OrganizationApiKeyvaluemapEntryListCall<'a, S>
pub fn apis_keyvaluemaps_entries_list( &self, parent: &str ) -> OrganizationApiKeyvaluemapEntryListCall<'a, S>
Create a builder to help you perform the following task:
Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
parent
- Required. Scope as indicated by the URI in which to list key value maps. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn apis_keyvaluemaps_entries_update(
&self,
request: GoogleCloudApigeeV1KeyValueEntry,
name: &str
) -> OrganizationApiKeyvaluemapEntryUpdateCall<'a, S>
pub fn apis_keyvaluemaps_entries_update( &self, request: GoogleCloudApigeeV1KeyValueEntry, name: &str ) -> OrganizationApiKeyvaluemapEntryUpdateCall<'a, S>
Create a builder to help you perform the following task:
Update key value entry scoped to an organization, environment, or API proxy for an existing key.
§Arguments
request
- No description provided.name
- Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn apis_keyvaluemaps_create(
&self,
request: GoogleCloudApigeeV1KeyValueMap,
parent: &str
) -> OrganizationApiKeyvaluemapCreateCall<'a, S>
pub fn apis_keyvaluemaps_create( &self, request: GoogleCloudApigeeV1KeyValueMap, parent: &str ) -> OrganizationApiKeyvaluemapCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a key value map in an API proxy.
§Arguments
request
- No description provided.parent
- Required. Name of the environment in which to create the key value map. Use the following structure in your request:organizations/{org}/apis/{api}
sourcepub fn apis_keyvaluemaps_delete(
&self,
name: &str
) -> OrganizationApiKeyvaluemapDeleteCall<'a, S>
pub fn apis_keyvaluemaps_delete( &self, name: &str ) -> OrganizationApiKeyvaluemapDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a key value map from an API proxy.
§Arguments
name
- Required. Name of the key value map. Use the following structure in your request:organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}
sourcepub fn apis_revisions_deployments_list(
&self,
parent: &str
) -> OrganizationApiRevisionDeploymentListCall<'a, S>
pub fn apis_revisions_deployments_list( &self, parent: &str ) -> OrganizationApiRevisionDeploymentListCall<'a, S>
Create a builder to help you perform the following task:
Lists all deployments of an API proxy revision.
§Arguments
parent
- Required. Name of the API proxy revision for which to return deployment information in the following format:organizations/{org}/apis/{api}/revisions/{rev}
.
sourcepub fn apis_revisions_delete(
&self,
name: &str
) -> OrganizationApiRevisionDeleteCall<'a, S>
pub fn apis_revisions_delete( &self, name: &str ) -> OrganizationApiRevisionDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.
§Arguments
name
- Required. API proxy revision in the following format:organizations/{org}/apis/{api}/revisions/{rev}
sourcepub fn apis_revisions_get(
&self,
name: &str
) -> OrganizationApiRevisionGetCall<'a, S>
pub fn apis_revisions_get( &self, name: &str ) -> OrganizationApiRevisionGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, set the format
query parameter to bundle
. If you are using curl, specify -o filename.zip
to save the output to a file; otherwise, it displays to stdout
. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in updateApiProxyRevision.
§Arguments
name
- Required. API proxy revision in the following format:organizations/{org}/apis/{api}/revisions/{rev}
sourcepub fn apis_revisions_update_api_proxy_revision(
&self,
request: GoogleApiHttpBody,
name: &str
) -> OrganizationApiRevisionUpdateApiProxyRevisionCall<'a, S>
pub fn apis_revisions_update_api_proxy_revision( &self, request: GoogleApiHttpBody, name: &str ) -> OrganizationApiRevisionUpdateApiProxyRevisionCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the Content-Type
header to either multipart/form-data
or application/octet-stream
.
§Arguments
request
- No description provided.name
- Required. API proxy revision to update in the following format:organizations/{org}/apis/{api}/revisions/{rev}
sourcepub fn apis_create(
&self,
request: GoogleApiHttpBody,
parent: &str
) -> OrganizationApiCreateCall<'a, S>
pub fn apis_create( &self, request: GoogleApiHttpBody, parent: &str ) -> OrganizationApiCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name
query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the name
query parameter to the name of the API proxy. * Set the action
query parameter to import
. * Set the Content-Type
header to multipart/form-data
. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file
form field. Note: To validate the API proxy configuration bundle only without importing it, set the action
query parameter to validate
. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.
§Arguments
request
- No description provided.parent
- Required. Name of the organization in the following format:organizations/{org}
sourcepub fn apis_delete(&self, name: &str) -> OrganizationApiDeleteCall<'a, S>
pub fn apis_delete(&self, name: &str) -> OrganizationApiDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.
§Arguments
name
- Required. Name of the API proxy in the following format:organizations/{org}/apis/{api}
sourcepub fn apis_get(&self, name: &str) -> OrganizationApiGetCall<'a, S>
pub fn apis_get(&self, name: &str) -> OrganizationApiGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an API proxy including a list of existing revisions.
§Arguments
name
- Required. Name of the API proxy in the following format:organizations/{org}/apis/{api}
sourcepub fn apis_list(&self, parent: &str) -> OrganizationApiListCall<'a, S>
pub fn apis_list(&self, parent: &str) -> OrganizationApiListCall<'a, S>
Create a builder to help you perform the following task:
Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
§Arguments
parent
- Required. Name of the organization in the following format:organizations/{org}
sourcepub fn apis_patch(
&self,
request: GoogleCloudApigeeV1ApiProxy,
name: &str
) -> OrganizationApiPatchCall<'a, S>
pub fn apis_patch( &self, request: GoogleCloudApigeeV1ApiProxy, name: &str ) -> OrganizationApiPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing API proxy.
§Arguments
request
- No description provided.name
- Required. API proxy to update in the following format:organizations/{org}/apis/{api}
sourcepub fn appgroups_apps_keys_apiproducts_delete(
&self,
name: &str
) -> OrganizationAppgroupAppKeyApiproductDeleteCall<'a, S>
pub fn appgroups_apps_keys_apiproducts_delete( &self, name: &str ) -> OrganizationAppgroupAppKeyApiproductDeleteCall<'a, S>
Create a builder to help you perform the following task:
Removes an API product from an app’s consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. Note: The consumer key is not removed, only its association with the API product.
§Arguments
name
- Required. Parent of the AppGroup app key. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}/apiproducts/{apiproduct}
sourcepub fn appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product(
&self,
name: &str
) -> OrganizationAppgroupAppKeyApiproductUpdateAppGroupAppKeyApiProductCall<'a, S>
pub fn appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product( &self, name: &str ) -> OrganizationAppgroupAppKeyApiproductUpdateAppGroupAppKeyApiProductCall<'a, S>
Create a builder to help you perform the following task:
Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked
will not allow access to the API.
§Arguments
name
- Required. Name of the API product in the developer app key in the following format:organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}/apiproducts/{apiproduct}
sourcepub fn appgroups_apps_keys_create(
&self,
request: GoogleCloudApigeeV1AppGroupAppKey,
parent: &str
) -> OrganizationAppgroupAppKeyCreateCall<'a, S>
pub fn appgroups_apps_keys_create( &self, request: GoogleCloudApigeeV1AppGroupAppKey, parent: &str ) -> OrganizationAppgroupAppKeyCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the ProductizeAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.
§Arguments
request
- No description provided.parent
- Required. Parent of the AppGroup app key. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys
sourcepub fn appgroups_apps_keys_delete(
&self,
name: &str
) -> OrganizationAppgroupAppKeyDeleteCall<'a, S>
pub fn appgroups_apps_keys_delete( &self, name: &str ) -> OrganizationAppgroupAppKeyDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an app’s consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.
§Arguments
name
- Required. Name of the AppGroup app key. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}
sourcepub fn appgroups_apps_keys_get(
&self,
name: &str
) -> OrganizationAppgroupAppKeyGetCall<'a, S>
pub fn appgroups_apps_keys_get( &self, name: &str ) -> OrganizationAppgroupAppKeyGetCall<'a, S>
Create a builder to help you perform the following task:
Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.
§Arguments
name
- Required. Name of the AppGroup app key. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}
sourcepub fn appgroups_apps_keys_update_app_group_app_key(
&self,
request: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest,
name: &str
) -> OrganizationAppgroupAppKeyUpdateAppGroupAppKeyCall<'a, S>
pub fn appgroups_apps_keys_update_app_group_app_key( &self, request: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest, name: &str ) -> OrganizationAppgroupAppKeyUpdateAppGroupAppKeyCall<'a, S>
Create a builder to help you perform the following task:
Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.
§Arguments
request
- No description provided.name
- Required. Name of the AppGroup app key. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}
sourcepub fn appgroups_apps_create(
&self,
request: GoogleCloudApigeeV1AppGroupApp,
parent: &str
) -> OrganizationAppgroupAppCreateCall<'a, S>
pub fn appgroups_apps_create( &self, request: GoogleCloudApigeeV1AppGroupApp, parent: &str ) -> OrganizationAppgroupAppCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an app and associates it with an AppGroup. This API associates the AppGroup app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The name
is the unique ID of the app that you can use in API calls.
§Arguments
request
- No description provided.parent
- Required. Name of the AppGroup. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}
sourcepub fn appgroups_apps_delete(
&self,
name: &str
) -> OrganizationAppgroupAppDeleteCall<'a, S>
pub fn appgroups_apps_delete( &self, name: &str ) -> OrganizationAppgroupAppDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an AppGroup app. Note: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.
§Arguments
name
- Required. Name of the AppGroup app. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}
sourcepub fn appgroups_apps_get(
&self,
name: &str
) -> OrganizationAppgroupAppGetCall<'a, S>
pub fn appgroups_apps_get( &self, name: &str ) -> OrganizationAppgroupAppGetCall<'a, S>
Create a builder to help you perform the following task:
Returns the details for an AppGroup app.
§Arguments
name
- Required. Name of the AppGroup app. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}
sourcepub fn appgroups_apps_list(
&self,
parent: &str
) -> OrganizationAppgroupAppListCall<'a, S>
pub fn appgroups_apps_list( &self, parent: &str ) -> OrganizationAppgroupAppListCall<'a, S>
Create a builder to help you perform the following task:
Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.
§Arguments
parent
- Required. Name of the AppGroup. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}
sourcepub fn appgroups_apps_update(
&self,
request: GoogleCloudApigeeV1AppGroupApp,
name: &str
) -> OrganizationAppgroupAppUpdateCall<'a, S>
pub fn appgroups_apps_update( &self, request: GoogleCloudApigeeV1AppGroupApp, name: &str ) -> OrganizationAppgroupAppUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.
§Arguments
request
- No description provided.name
- Required. Name of the AppGroup app. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}/apps/{app}
sourcepub fn appgroups_create(
&self,
request: GoogleCloudApigeeV1AppGroup,
parent: &str
) -> OrganizationAppgroupCreateCall<'a, S>
pub fn appgroups_create( &self, request: GoogleCloudApigeeV1AppGroup, parent: &str ) -> OrganizationAppgroupCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup’s state is set as active
.
§Arguments
request
- No description provided.parent
- Required. Name of the Apigee organization in which the AppGroup is created. Use the following structure in your request:organizations/{org}
.
sourcepub fn appgroups_delete(
&self,
name: &str
) -> OrganizationAppgroupDeleteCall<'a, S>
pub fn appgroups_delete( &self, name: &str ) -> OrganizationAppgroupDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. Warning: This API will permanently delete the AppGroup and related artifacts. Note: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.
§Arguments
name
- Required. Name of the AppGroup. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}
sourcepub fn appgroups_get(&self, name: &str) -> OrganizationAppgroupGetCall<'a, S>
pub fn appgroups_get(&self, name: &str) -> OrganizationAppgroupGetCall<'a, S>
Create a builder to help you perform the following task:
Returns the AppGroup details for the provided AppGroup name in the request URI.
§Arguments
name
- Required. Name of the AppGroup. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}
sourcepub fn appgroups_list(
&self,
parent: &str
) -> OrganizationAppgroupListCall<'a, S>
pub fn appgroups_list( &self, parent: &str ) -> OrganizationAppgroupListCall<'a, S>
Create a builder to help you perform the following task:
Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.
§Arguments
parent
- Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
.
sourcepub fn appgroups_update(
&self,
request: GoogleCloudApigeeV1AppGroup,
name: &str
) -> OrganizationAppgroupUpdateCall<'a, S>
pub fn appgroups_update( &self, request: GoogleCloudApigeeV1AppGroup, name: &str ) -> OrganizationAppgroupUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using action
, and not via AppGroup.
§Arguments
request
- No description provided.name
- Required. Name of the AppGroup. Use the following structure in your request:organizations/{org}/appgroups/{app_group_name}
sourcepub fn apps_get(&self, name: &str) -> OrganizationAppGetCall<'a, S>
pub fn apps_get(&self, name: &str) -> OrganizationAppGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the app profile for the specified app ID.
§Arguments
name
- Required. App ID in the following format:organizations/{org}/apps/{app}
sourcepub fn apps_list(&self, parent: &str) -> OrganizationAppListCall<'a, S>
pub fn apps_list(&self, parent: &str) -> OrganizationAppListCall<'a, S>
Create a builder to help you perform the following task:
Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).
§Arguments
parent
- Required. Resource path of the parent in the following format:organizations/{org}
sourcepub fn datacollectors_create(
&self,
request: GoogleCloudApigeeV1DataCollector,
parent: &str
) -> OrganizationDatacollectorCreateCall<'a, S>
pub fn datacollectors_create( &self, request: GoogleCloudApigeeV1DataCollector, parent: &str ) -> OrganizationDatacollectorCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new data collector.
§Arguments
request
- No description provided.parent
- Required. Name of the organization in which to create the data collector in the following format:organizations/{org}
.
sourcepub fn datacollectors_delete(
&self,
name: &str
) -> OrganizationDatacollectorDeleteCall<'a, S>
pub fn datacollectors_delete( &self, name: &str ) -> OrganizationDatacollectorDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a data collector.
§Arguments
name
- Required. Name of the data collector in the following format:organizations/{org}/datacollectors/{data_collector_id}
.
sourcepub fn datacollectors_get(
&self,
name: &str
) -> OrganizationDatacollectorGetCall<'a, S>
pub fn datacollectors_get( &self, name: &str ) -> OrganizationDatacollectorGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a data collector.
§Arguments
name
- Required. Name of the data collector in the following format:organizations/{org}/datacollectors/{data_collector_id}
.
sourcepub fn datacollectors_list(
&self,
parent: &str
) -> OrganizationDatacollectorListCall<'a, S>
pub fn datacollectors_list( &self, parent: &str ) -> OrganizationDatacollectorListCall<'a, S>
Create a builder to help you perform the following task:
Lists all data collectors.
§Arguments
parent
- Required. Name of the organization for which to list data collectors in the following format:organizations/{org}
.
sourcepub fn datacollectors_patch(
&self,
request: GoogleCloudApigeeV1DataCollector,
name: &str
) -> OrganizationDatacollectorPatchCall<'a, S>
pub fn datacollectors_patch( &self, request: GoogleCloudApigeeV1DataCollector, name: &str ) -> OrganizationDatacollectorPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates a data collector.
§Arguments
request
- No description provided.name
- Required. Name of the data collector in the following format:organizations/{org}/datacollectors/{data_collector_id}
.
sourcepub fn deployments_list(
&self,
parent: &str
) -> OrganizationDeploymentListCall<'a, S>
pub fn deployments_list( &self, parent: &str ) -> OrganizationDeploymentListCall<'a, S>
Create a builder to help you perform the following task:
Lists all deployments of API proxies or shared flows.
§Arguments
parent
- Required. Name of the organization for which to return deployment information in the following format:organizations/{org}
sourcepub fn developers_apps_attributes_delete(
&self,
name: &str
) -> OrganizationDeveloperAppAttributeDeleteCall<'a, S>
pub fn developers_apps_attributes_delete( &self, name: &str ) -> OrganizationDeveloperAppAttributeDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a developer app attribute.
§Arguments
name
- Required. Name of the developer app attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}
sourcepub fn developers_apps_attributes_get(
&self,
name: &str
) -> OrganizationDeveloperAppAttributeGetCall<'a, S>
pub fn developers_apps_attributes_get( &self, name: &str ) -> OrganizationDeveloperAppAttributeGetCall<'a, S>
Create a builder to help you perform the following task:
Returns a developer app attribute.
§Arguments
name
- Required. Name of the developer app attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}
sourcepub fn developers_apps_attributes_list(
&self,
parent: &str
) -> OrganizationDeveloperAppAttributeListCall<'a, S>
pub fn developers_apps_attributes_list( &self, parent: &str ) -> OrganizationDeveloperAppAttributeListCall<'a, S>
Create a builder to help you perform the following task:
Returns a list of all developer app attributes.
§Arguments
parent
- Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
sourcepub fn developers_apps_attributes_update_developer_app_attribute(
&self,
request: GoogleCloudApigeeV1Attribute,
name: &str
) -> OrganizationDeveloperAppAttributeUpdateDeveloperAppAttributeCall<'a, S>
pub fn developers_apps_attributes_update_developer_app_attribute( &self, request: GoogleCloudApigeeV1Attribute, name: &str ) -> OrganizationDeveloperAppAttributeUpdateDeveloperAppAttributeCall<'a, S>
Create a builder to help you perform the following task:
Updates a developer app attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn
element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.
§Arguments
request
- No description provided.name
- Required. Name of the developer app attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}
sourcepub fn developers_apps_keys_apiproducts_delete(
&self,
name: &str
) -> OrganizationDeveloperAppKeyApiproductDeleteCall<'a, S>
pub fn developers_apps_keys_apiproducts_delete( &self, name: &str ) -> OrganizationDeveloperAppKeyApiproductDeleteCall<'a, S>
Create a builder to help you perform the following task:
Removes an API product from an app’s consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. Note: The consumer key is not removed, only its association with the API product.
§Arguments
name
- Name of the API product in the developer app key in the following format:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}
sourcepub fn developers_apps_keys_apiproducts_update_developer_app_key_api_product(
&self,
name: &str
) -> OrganizationDeveloperAppKeyApiproductUpdateDeveloperAppKeyApiProductCall<'a, S>
pub fn developers_apps_keys_apiproducts_update_developer_app_key_api_product( &self, name: &str ) -> OrganizationDeveloperAppKeyApiproductUpdateDeveloperAppKeyApiProductCall<'a, S>
Create a builder to help you perform the following task:
Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked
will not allow access to the API.
§Arguments
name
- Name of the API product in the developer app key in the following format:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}
sourcepub fn developers_apps_keys_create_create(
&self,
request: GoogleCloudApigeeV1DeveloperAppKey,
parent: &str
) -> OrganizationDeveloperAppKeyCreateCreateCall<'a, S>
pub fn developers_apps_keys_create_create( &self, request: GoogleCloudApigeeV1DeveloperAppKey, parent: &str ) -> OrganizationDeveloperAppKeyCreateCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API. Note: All keys start out with status=approved, even if status=revoked is passed when the key is created. To revoke a key, use the UpdateDeveloperAppKey API.
§Arguments
request
- No description provided.parent
- Parent of the developer app key. Use the following structure in your request: ‘organizations/{org}/developers/{developerEmail}/apps/{appName}’
sourcepub fn developers_apps_keys_create(
&self,
request: GoogleCloudApigeeV1DeveloperAppKey,
parent: &str
) -> OrganizationDeveloperAppKeyCreateCall<'a, S>
pub fn developers_apps_keys_create( &self, request: GoogleCloudApigeeV1DeveloperAppKey, parent: &str ) -> OrganizationDeveloperAppKeyCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API. Note: All keys start out with status=approved, even if status=revoked is passed when the key is created. To revoke a key, use the UpdateDeveloperAppKey API.
§Arguments
request
- No description provided.parent
- Parent of the developer app key. Use the following structure in your request: ‘organizations/{org}/developers/{developerEmail}/apps/{appName}’
sourcepub fn developers_apps_keys_delete(
&self,
name: &str
) -> OrganizationDeveloperAppKeyDeleteCall<'a, S>
pub fn developers_apps_keys_delete( &self, name: &str ) -> OrganizationDeveloperAppKeyDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an app’s consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. Note: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.
§Arguments
name
- Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
sourcepub fn developers_apps_keys_get(
&self,
name: &str
) -> OrganizationDeveloperAppKeyGetCall<'a, S>
pub fn developers_apps_keys_get( &self, name: &str ) -> OrganizationDeveloperAppKeyGetCall<'a, S>
Create a builder to help you perform the following task:
Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.
§Arguments
name
- Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
sourcepub fn developers_apps_keys_replace_developer_app_key(
&self,
request: GoogleCloudApigeeV1DeveloperAppKey,
name: &str
) -> OrganizationDeveloperAppKeyReplaceDeveloperAppKeyCall<'a, S>
pub fn developers_apps_keys_replace_developer_app_key( &self, request: GoogleCloudApigeeV1DeveloperAppKey, name: &str ) -> OrganizationDeveloperAppKeyReplaceDeveloperAppKeyCall<'a, S>
Create a builder to help you perform the following task:
Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the scopes
element under the apiProducts
element in the attributes of the app.
§Arguments
request
- No description provided.name
- Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
sourcepub fn developers_apps_keys_update_developer_app_key(
&self,
request: GoogleCloudApigeeV1DeveloperAppKey,
name: &str
) -> OrganizationDeveloperAppKeyUpdateDeveloperAppKeyCall<'a, S>
pub fn developers_apps_keys_update_developer_app_key( &self, request: GoogleCloudApigeeV1DeveloperAppKey, name: &str ) -> OrganizationDeveloperAppKeyUpdateDeveloperAppKeyCall<'a, S>
Create a builder to help you perform the following task:
Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.
§Arguments
request
- No description provided.name
- Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
sourcepub fn developers_apps_attributes(
&self,
request: GoogleCloudApigeeV1Attributes,
name: &str
) -> OrganizationDeveloperAppAttributeCall<'a, S>
pub fn developers_apps_attributes( &self, request: GoogleCloudApigeeV1Attributes, name: &str ) -> OrganizationDeveloperAppAttributeCall<'a, S>
Create a builder to help you perform the following task:
Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.
§Arguments
request
- No description provided.name
- Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
sourcepub fn developers_apps_create(
&self,
request: GoogleCloudApigeeV1DeveloperApp,
parent: &str
) -> OrganizationDeveloperAppCreateCall<'a, S>
pub fn developers_apps_create( &self, request: GoogleCloudApigeeV1DeveloperApp, parent: &str ) -> OrganizationDeveloperAppCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The name
is the unique ID of the app that you can use in API calls. The DisplayName
(set as an attribute) appears in the UI. If you don’t set the DisplayName
attribute, the name
appears in the UI.
§Arguments
request
- No description provided.parent
- Required. Name of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_apps_delete(
&self,
name: &str
) -> OrganizationDeveloperAppDeleteCall<'a, S>
pub fn developers_apps_delete( &self, name: &str ) -> OrganizationDeveloperAppDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a developer app. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.
§Arguments
name
- Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
sourcepub fn developers_apps_generate_key_pair_or_update_developer_app_status(
&self,
request: GoogleCloudApigeeV1DeveloperApp,
name: &str
) -> OrganizationDeveloperAppGenerateKeyPairOrUpdateDeveloperAppStatuCall<'a, S>
pub fn developers_apps_generate_key_pair_or_update_developer_app_status( &self, request: GoogleCloudApigeeV1DeveloperApp, name: &str ) -> OrganizationDeveloperAppGenerateKeyPairOrUpdateDeveloperAppStatuCall<'a, S>
Create a builder to help you perform the following task:
Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the action
query parameter to approve
or revoke
, respectively, and the Content-Type
header to application/octet-stream
. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: 204 No Content
To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (approve
or revoke
) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you’re using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The keyExpiresIn
property defines the expiration time for the API key in milliseconds. If you don’t set this property or set it to -1
, the API key never expires. Notes: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.
§Arguments
request
- No description provided.name
- Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
sourcepub fn developers_apps_get(
&self,
name: &str
) -> OrganizationDeveloperAppGetCall<'a, S>
pub fn developers_apps_get( &self, name: &str ) -> OrganizationDeveloperAppGetCall<'a, S>
Create a builder to help you perform the following task:
Returns the details for a developer app.
§Arguments
name
- Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
sourcepub fn developers_apps_list(
&self,
parent: &str
) -> OrganizationDeveloperAppListCall<'a, S>
pub fn developers_apps_list( &self, parent: &str ) -> OrganizationDeveloperAppListCall<'a, S>
Create a builder to help you perform the following task:
Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the startKey
and count
query parameters.
§Arguments
parent
- Required. Name of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_apps_update(
&self,
request: GoogleCloudApigeeV1DeveloperApp,
name: &str
) -> OrganizationDeveloperAppUpdateCall<'a, S>
pub fn developers_apps_update( &self, request: GoogleCloudApigeeV1DeveloperApp, name: &str ) -> OrganizationDeveloperAppUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.
§Arguments
request
- No description provided.name
- Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
sourcepub fn developers_attributes_delete(
&self,
name: &str
) -> OrganizationDeveloperAttributeDeleteCall<'a, S>
pub fn developers_attributes_delete( &self, name: &str ) -> OrganizationDeveloperAttributeDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a developer attribute.
§Arguments
name
- Required. Name of the developer attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/attributes/{attribute}
sourcepub fn developers_attributes_get(
&self,
name: &str
) -> OrganizationDeveloperAttributeGetCall<'a, S>
pub fn developers_attributes_get( &self, name: &str ) -> OrganizationDeveloperAttributeGetCall<'a, S>
Create a builder to help you perform the following task:
Returns the value of the specified developer attribute.
§Arguments
name
- Required. Name of the developer attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/attributes/{attribute}
sourcepub fn developers_attributes_list(
&self,
parent: &str
) -> OrganizationDeveloperAttributeListCall<'a, S>
pub fn developers_attributes_list( &self, parent: &str ) -> OrganizationDeveloperAttributeListCall<'a, S>
Create a builder to help you perform the following task:
Returns a list of all developer attributes.
§Arguments
parent
- Required. Email address of the developer for which attributes are being listed. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_attributes_update_developer_attribute(
&self,
request: GoogleCloudApigeeV1Attribute,
name: &str
) -> OrganizationDeveloperAttributeUpdateDeveloperAttributeCall<'a, S>
pub fn developers_attributes_update_developer_attribute( &self, request: GoogleCloudApigeeV1Attribute, name: &str ) -> OrganizationDeveloperAttributeUpdateDeveloperAttributeCall<'a, S>
Create a builder to help you perform the following task:
Updates a developer attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn
element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.
§Arguments
request
- No description provided.name
- Required. Name of the developer attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/attributes/{attribute}
sourcepub fn developers_balance_adjust(
&self,
request: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest,
name: &str
) -> OrganizationDeveloperBalanceAdjustCall<'a, S>
pub fn developers_balance_adjust( &self, request: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest, name: &str ) -> OrganizationDeveloperBalanceAdjustCall<'a, S>
Create a builder to help you perform the following task:
Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.
§Arguments
request
- No description provided.name
- Required. Account balance for the developer. Use the following structure in your request:organizations/{org}/developers/{developer}/balance
sourcepub fn developers_balance_credit(
&self,
request: GoogleCloudApigeeV1CreditDeveloperBalanceRequest,
name: &str
) -> OrganizationDeveloperBalanceCreditCall<'a, S>
pub fn developers_balance_credit( &self, request: GoogleCloudApigeeV1CreditDeveloperBalanceRequest, name: &str ) -> OrganizationDeveloperBalanceCreditCall<'a, S>
Create a builder to help you perform the following task:
Credits the account balance for the developer.
§Arguments
request
- No description provided.name
- Required. Account balance for the developer. Use the following structure in your request:organizations/{org}/developers/{developer}/balance
sourcepub fn developers_subscriptions_create(
&self,
request: GoogleCloudApigeeV1DeveloperSubscription,
parent: &str
) -> OrganizationDeveloperSubscriptionCreateCall<'a, S>
pub fn developers_subscriptions_create( &self, request: GoogleCloudApigeeV1DeveloperSubscription, parent: &str ) -> OrganizationDeveloperSubscriptionCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a subscription to an API product.
§Arguments
request
- No description provided.parent
- Required. Email address of the developer that is purchasing a subscription to the API product. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_subscriptions_expire(
&self,
request: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest,
name: &str
) -> OrganizationDeveloperSubscriptionExpireCall<'a, S>
pub fn developers_subscriptions_expire( &self, request: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest, name: &str ) -> OrganizationDeveloperSubscriptionExpireCall<'a, S>
Create a builder to help you perform the following task:
Expires an API product subscription immediately.
§Arguments
request
- No description provided.name
- Required. Name of the API product subscription. Use the following structure in your request:organizations/{org}/developers/{developer_email}/subscriptions/{subscription}
sourcepub fn developers_subscriptions_get(
&self,
name: &str
) -> OrganizationDeveloperSubscriptionGetCall<'a, S>
pub fn developers_subscriptions_get( &self, name: &str ) -> OrganizationDeveloperSubscriptionGetCall<'a, S>
Create a builder to help you perform the following task:
Gets details for an API product subscription.
§Arguments
name
- Required. Name of the API product subscription. Use the following structure in your request:organizations/{org}/developers/{developer_email}/subscriptions/{subscription}
sourcepub fn developers_subscriptions_list(
&self,
parent: &str
) -> OrganizationDeveloperSubscriptionListCall<'a, S>
pub fn developers_subscriptions_list( &self, parent: &str ) -> OrganizationDeveloperSubscriptionListCall<'a, S>
Create a builder to help you perform the following task:
Lists all API product subscriptions for a developer.
§Arguments
parent
- Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_attributes(
&self,
request: GoogleCloudApigeeV1Attributes,
parent: &str
) -> OrganizationDeveloperAttributeCall<'a, S>
pub fn developers_attributes( &self, request: GoogleCloudApigeeV1Attributes, parent: &str ) -> OrganizationDeveloperAttributeCall<'a, S>
Create a builder to help you perform the following task:
Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn
element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.
§Arguments
request
- No description provided.parent
- Required. Email address of the developer for which attributes are being updated. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_create(
&self,
request: GoogleCloudApigeeV1Developer,
parent: &str
) -> OrganizationDeveloperCreateCall<'a, S>
pub fn developers_create( &self, request: GoogleCloudApigeeV1Developer, parent: &str ) -> OrganizationDeveloperCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as active
. To change the developer status, use the SetDeveloperStatus API.
§Arguments
request
- No description provided.parent
- Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request:organizations/{org}
.
sourcepub fn developers_delete(
&self,
name: &str
) -> OrganizationDeveloperDeleteCall<'a, S>
pub fn developers_delete( &self, name: &str ) -> OrganizationDeveloperDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a developer. All apps and API keys associated with the developer are also removed. Warning: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to inactive
using the SetDeveloperStatus API. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.
§Arguments
name
- Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_get(&self, name: &str) -> OrganizationDeveloperGetCall<'a, S>
pub fn developers_get(&self, name: &str) -> OrganizationDeveloperGetCall<'a, S>
Create a builder to help you perform the following task:
Returns the developer details, including the developer’s name, email address, apps, and other information. Note: The response includes only the first 100 developer apps.
§Arguments
name
- Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_get_balance(
&self,
name: &str
) -> OrganizationDeveloperGetBalanceCall<'a, S>
pub fn developers_get_balance( &self, name: &str ) -> OrganizationDeveloperGetBalanceCall<'a, S>
Create a builder to help you perform the following task:
Gets the account balance for the developer.
§Arguments
name
- Required. Account balance for the developer. Use the following structure in your request:organizations/{org}/developers/{developer}/balance
sourcepub fn developers_get_monetization_config(
&self,
name: &str
) -> OrganizationDeveloperGetMonetizationConfigCall<'a, S>
pub fn developers_get_monetization_config( &self, name: &str ) -> OrganizationDeveloperGetMonetizationConfigCall<'a, S>
Create a builder to help you perform the following task:
Gets the monetization configuration for the developer.
§Arguments
name
- Required. Monetization configuration for the developer. Use the following structure in your request:organizations/{org}/developers/{developer}/monetizationConfig
sourcepub fn developers_list(
&self,
parent: &str
) -> OrganizationDeveloperListCall<'a, S>
pub fn developers_list( &self, parent: &str ) -> OrganizationDeveloperListCall<'a, S>
Create a builder to help you perform the following task:
Lists all developers in an organization by email address. By default, the response does not include company developers. Set the includeCompany
query parameter to true
to include company developers. Note: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the startKey
and count
query parameters.
§Arguments
parent
- Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
.
sourcepub fn developers_set_developer_status(
&self,
name: &str
) -> OrganizationDeveloperSetDeveloperStatuCall<'a, S>
pub fn developers_set_developer_status( &self, name: &str ) -> OrganizationDeveloperSetDeveloperStatuCall<'a, S>
Create a builder to help you perform the following task:
Sets the status of a developer. A developer is active
by default. If you set a developer’s status to inactive
, the API keys assigned to the developer apps are no longer valid even though the API keys are set to approved
. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won’t work. To set the status of a developer, set the action
query parameter to active
or inactive
, and the Content-Type
header to application/octet-stream
. If successful, the API call returns the following HTTP status code: 204 No Content
§Arguments
name
- Required. Name of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_id}
sourcepub fn developers_update(
&self,
request: GoogleCloudApigeeV1Developer,
name: &str
) -> OrganizationDeveloperUpdateCall<'a, S>
pub fn developers_update( &self, request: GoogleCloudApigeeV1Developer, name: &str ) -> OrganizationDeveloperUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn
element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.
§Arguments
request
- No description provided.name
- Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
sourcepub fn developers_update_monetization_config(
&self,
request: GoogleCloudApigeeV1DeveloperMonetizationConfig,
name: &str
) -> OrganizationDeveloperUpdateMonetizationConfigCall<'a, S>
pub fn developers_update_monetization_config( &self, request: GoogleCloudApigeeV1DeveloperMonetizationConfig, name: &str ) -> OrganizationDeveloperUpdateMonetizationConfigCall<'a, S>
Create a builder to help you perform the following task:
Updates the monetization configuration for the developer.
§Arguments
request
- No description provided.name
- Required. Monetization configuration for the developer. Use the following structure in your request:organizations/{org}/developers/{developer}/monetizationConfig
sourcepub fn endpoint_attachments_create(
&self,
request: GoogleCloudApigeeV1EndpointAttachment,
parent: &str
) -> OrganizationEndpointAttachmentCreateCall<'a, S>
pub fn endpoint_attachments_create( &self, request: GoogleCloudApigeeV1EndpointAttachment, parent: &str ) -> OrganizationEndpointAttachmentCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an endpoint attachment. Note: Not supported for Apigee hybrid.
§Arguments
request
- No description provided.parent
- Required. Organization the endpoint attachment will be created in.
sourcepub fn endpoint_attachments_delete(
&self,
name: &str
) -> OrganizationEndpointAttachmentDeleteCall<'a, S>
pub fn endpoint_attachments_delete( &self, name: &str ) -> OrganizationEndpointAttachmentDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an endpoint attachment.
§Arguments
name
- Required. Name of the endpoint attachment. Use the following structure in your request:organizations/{org}/endpointAttachments/{endpoint_attachment}
sourcepub fn endpoint_attachments_get(
&self,
name: &str
) -> OrganizationEndpointAttachmentGetCall<'a, S>
pub fn endpoint_attachments_get( &self, name: &str ) -> OrganizationEndpointAttachmentGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the endpoint attachment.
§Arguments
name
- Required. Name of the endpoint attachment. Use the following structure in your request:organizations/{org}/endpointAttachments/{endpoint_attachment}
sourcepub fn endpoint_attachments_list(
&self,
parent: &str
) -> OrganizationEndpointAttachmentListCall<'a, S>
pub fn endpoint_attachments_list( &self, parent: &str ) -> OrganizationEndpointAttachmentListCall<'a, S>
Create a builder to help you perform the following task:
Lists the endpoint attachments in an organization.
§Arguments
parent
- Required. Name of the organization for which to list endpoint attachments. Use the following structure in your request:organizations/{org}
sourcepub fn envgroups_attachments_create(
&self,
request: GoogleCloudApigeeV1EnvironmentGroupAttachment,
parent: &str
) -> OrganizationEnvgroupAttachmentCreateCall<'a, S>
pub fn envgroups_attachments_create( &self, request: GoogleCloudApigeeV1EnvironmentGroupAttachment, parent: &str ) -> OrganizationEnvgroupAttachmentCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new attachment of an environment to an environment group.
§Arguments
request
- No description provided.parent
- Required. EnvironmentGroup under which to create the attachment in the following format:organizations/{org}/envgroups/{envgroup}
.
sourcepub fn envgroups_attachments_delete(
&self,
name: &str
) -> OrganizationEnvgroupAttachmentDeleteCall<'a, S>
pub fn envgroups_attachments_delete( &self, name: &str ) -> OrganizationEnvgroupAttachmentDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an environment group attachment.
§Arguments
name
- Required. Name of the environment group attachment to delete in the following format:organizations/{org}/envgroups/{envgroup}/attachments/{attachment}
.
sourcepub fn envgroups_attachments_get(
&self,
name: &str
) -> OrganizationEnvgroupAttachmentGetCall<'a, S>
pub fn envgroups_attachments_get( &self, name: &str ) -> OrganizationEnvgroupAttachmentGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an environment group attachment.
§Arguments
name
- Required. Name of the environment group attachment in the following format:organizations/{org}/envgroups/{envgroup}/attachments/{attachment}
sourcepub fn envgroups_attachments_list(
&self,
parent: &str
) -> OrganizationEnvgroupAttachmentListCall<'a, S>
pub fn envgroups_attachments_list( &self, parent: &str ) -> OrganizationEnvgroupAttachmentListCall<'a, S>
Create a builder to help you perform the following task:
Lists all attachments of an environment group.
§Arguments
parent
- Required. Name of the environment group in the following format:organizations/{org}/envgroups/{envgroup}
.
sourcepub fn envgroups_create(
&self,
request: GoogleCloudApigeeV1EnvironmentGroup,
parent: &str
) -> OrganizationEnvgroupCreateCall<'a, S>
pub fn envgroups_create( &self, request: GoogleCloudApigeeV1EnvironmentGroup, parent: &str ) -> OrganizationEnvgroupCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new environment group.
§Arguments
request
- No description provided.parent
- Required. Name of the organization in which to create the environment group in the following format:organizations/{org}
.
sourcepub fn envgroups_delete(
&self,
name: &str
) -> OrganizationEnvgroupDeleteCall<'a, S>
pub fn envgroups_delete( &self, name: &str ) -> OrganizationEnvgroupDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an environment group.
§Arguments
name
- Required. Name of the environment group in the following format:organizations/{org}/envgroups/{envgroup}
.
sourcepub fn envgroups_get(&self, name: &str) -> OrganizationEnvgroupGetCall<'a, S>
pub fn envgroups_get(&self, name: &str) -> OrganizationEnvgroupGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an environment group.
§Arguments
name
- Required. Name of the environment group in the following format:organizations/{org}/envgroups/{envgroup}
.
sourcepub fn envgroups_get_deployed_ingress_config(
&self,
name: &str
) -> OrganizationEnvgroupGetDeployedIngressConfigCall<'a, S>
pub fn envgroups_get_deployed_ingress_config( &self, name: &str ) -> OrganizationEnvgroupGetDeployedIngressConfigCall<'a, S>
Create a builder to help you perform the following task:
Gets the deployed ingress configuration for an environment group.
§Arguments
name
- Required. Name of the deployed configuration for the environment group in the following format: ‘organizations/{org}/envgroups/{envgroup}/deployedIngressConfig’.
sourcepub fn envgroups_list(
&self,
parent: &str
) -> OrganizationEnvgroupListCall<'a, S>
pub fn envgroups_list( &self, parent: &str ) -> OrganizationEnvgroupListCall<'a, S>
Create a builder to help you perform the following task:
Lists all environment groups.
§Arguments
parent
- Required. Name of the organization for which to list environment groups in the following format:organizations/{org}
.
sourcepub fn envgroups_patch(
&self,
request: GoogleCloudApigeeV1EnvironmentGroup,
name: &str
) -> OrganizationEnvgroupPatchCall<'a, S>
pub fn envgroups_patch( &self, request: GoogleCloudApigeeV1EnvironmentGroup, name: &str ) -> OrganizationEnvgroupPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates an environment group.
§Arguments
request
- No description provided.name
- Required. Name of the environment group to update in the format: `organizations/{org}/envgroups/{envgroup}.
sourcepub fn environments_addons_config_set_addon_enablement(
&self,
request: GoogleCloudApigeeV1SetAddonEnablementRequest,
name: &str
) -> OrganizationEnvironmentAddonsConfigSetAddonEnablementCall<'a, S>
pub fn environments_addons_config_set_addon_enablement( &self, request: GoogleCloudApigeeV1SetAddonEnablementRequest, name: &str ) -> OrganizationEnvironmentAddonsConfigSetAddonEnablementCall<'a, S>
Create a builder to help you perform the following task:
Updates an add-on enablement status of an environment.
§Arguments
request
- No description provided.name
- Required. Name of the add-ons config. Must be in the format of/organizations/{org}/environments/{env}/addonsConfig
sourcepub fn environments_analytics_admin_get_schemav2(
&self,
name: &str
) -> OrganizationEnvironmentAnalyticAdminGetSchemav2Call<'a, S>
pub fn environments_analytics_admin_get_schemav2( &self, name: &str ) -> OrganizationEnvironmentAnalyticAdminGetSchemav2Call<'a, S>
Create a builder to help you perform the following task:
Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.
§Arguments
name
- Required. Path to the schema. Use the following structure in your request:organizations/{org}/environments/{env}/analytics/admin/schemav2
.
sourcepub fn environments_analytics_exports_create(
&self,
request: GoogleCloudApigeeV1ExportRequest,
parent: &str
) -> OrganizationEnvironmentAnalyticExportCreateCall<'a, S>
pub fn environments_analytics_exports_create( &self, request: GoogleCloudApigeeV1ExportRequest, parent: &str ) -> OrganizationEnvironmentAnalyticExportCreateCall<'a, S>
Create a builder to help you perform the following task:
Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state
value of “enqueued”.
§Arguments
request
- No description provided.parent
- Required. Names of the parent organization and environment. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_analytics_exports_get(
&self,
name: &str
) -> OrganizationEnvironmentAnalyticExportGetCall<'a, S>
pub fn environments_analytics_exports_get( &self, name: &str ) -> OrganizationEnvironmentAnalyticExportGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the details and status of an analytics export job. If the export job is still in progress, its state
is set to “running”. After the export job has completed successfully, its state
is set to “completed”. If the export job fails, its state
is set to failed
.
§Arguments
name
- Required. Resource name of the export to get.
sourcepub fn environments_analytics_exports_list(
&self,
parent: &str
) -> OrganizationEnvironmentAnalyticExportListCall<'a, S>
pub fn environments_analytics_exports_list( &self, parent: &str ) -> OrganizationEnvironmentAnalyticExportListCall<'a, S>
Create a builder to help you perform the following task:
Lists the details and status of all analytics export jobs belonging to the parent organization and environment.
§Arguments
parent
- Required. Names of the parent organization and environment. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_apis_deployments_list(
&self,
parent: &str
) -> OrganizationEnvironmentApiDeploymentListCall<'a, S>
pub fn environments_apis_deployments_list( &self, parent: &str ) -> OrganizationEnvironmentApiDeploymentListCall<'a, S>
Create a builder to help you perform the following task:
Lists all deployments of an API proxy in an environment.
§Arguments
parent
- Required. Name representing an API proxy in an environment in the following format:organizations/{org}/environments/{env}/apis/{api}
sourcepub fn environments_apis_revisions_debugsessions_data_get(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionDebugsessionDataGetCall<'a, S>
pub fn environments_apis_revisions_debugsessions_data_get( &self, name: &str ) -> OrganizationEnvironmentApiRevisionDebugsessionDataGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the debug data from a transaction.
§Arguments
name
- Required. The name of the debug session transaction. Must be of the form:organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}
.
sourcepub fn environments_apis_revisions_debugsessions_create(
&self,
request: GoogleCloudApigeeV1DebugSession,
parent: &str
) -> OrganizationEnvironmentApiRevisionDebugsessionCreateCall<'a, S>
pub fn environments_apis_revisions_debugsessions_create( &self, request: GoogleCloudApigeeV1DebugSession, parent: &str ) -> OrganizationEnvironmentApiRevisionDebugsessionCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a debug session for a deployed API Proxy revision.
§Arguments
request
- No description provided.parent
- Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the formorganizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}
.
sourcepub fn environments_apis_revisions_debugsessions_delete_data(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionDebugsessionDeleteDataCall<'a, S>
pub fn environments_apis_revisions_debugsessions_delete_data( &self, name: &str ) -> OrganizationEnvironmentApiRevisionDebugsessionDeleteDataCall<'a, S>
Create a builder to help you perform the following task:
Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.
§Arguments
name
- Required. The name of the debug session to delete. Must be of the form:organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}
.
sourcepub fn environments_apis_revisions_debugsessions_get(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionDebugsessionGetCall<'a, S>
pub fn environments_apis_revisions_debugsessions_get( &self, name: &str ) -> OrganizationEnvironmentApiRevisionDebugsessionGetCall<'a, S>
Create a builder to help you perform the following task:
Retrieves a debug session.
§Arguments
name
- Required. The name of the debug session to retrieve. Must be of the form:organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}
.
sourcepub fn environments_apis_revisions_debugsessions_list(
&self,
parent: &str
) -> OrganizationEnvironmentApiRevisionDebugsessionListCall<'a, S>
pub fn environments_apis_revisions_debugsessions_list( &self, parent: &str ) -> OrganizationEnvironmentApiRevisionDebugsessionListCall<'a, S>
Create a builder to help you perform the following task:
Lists debug sessions that are currently active in the given API Proxy revision.
§Arguments
parent
- Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form:organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}
.
sourcepub fn environments_apis_revisions_deployments_generate_deploy_change_report(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionDeploymentGenerateDeployChangeReportCall<'a, S>
pub fn environments_apis_revisions_deployments_generate_deploy_change_report( &self, name: &str ) -> OrganizationEnvironmentApiRevisionDeploymentGenerateDeployChangeReportCall<'a, S>
Create a builder to help you perform the following task:
Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport
, two permissions are required: * apigee.deployments.create
on the resource organizations/{org}/environments/{env}
* apigee.proxyrevisions.deploy
on the resource organizations/{org}/apis/{api}/revisions/{rev}
§Arguments
name
- Name of the API proxy revision deployment in the following format:organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
sourcepub fn environments_apis_revisions_deployments_generate_undeploy_change_report(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionDeploymentGenerateUndeployChangeReportCall<'a, S>
pub fn environments_apis_revisions_deployments_generate_undeploy_change_report( &self, name: &str ) -> OrganizationEnvironmentApiRevisionDeploymentGenerateUndeployChangeReportCall<'a, S>
Create a builder to help you perform the following task:
Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport
, two permissions are required: * apigee.deployments.delete
on the resource organizations/{org}/environments/{env}
* apigee.proxyrevisions.undeploy
on the resource organizations/{org}/apis/{api}/revisions/{rev}
§Arguments
name
- Name of the API proxy revision deployment in the following format:organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
sourcepub fn environments_apis_revisions_deploy(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
pub fn environments_apis_revisions_deploy( &self, name: &str ) -> OrganizationEnvironmentApiRevisionDeployCall<'a, S>
Create a builder to help you perform the following task:
Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the override
parameter to true
to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments
, two permissions are required: * apigee.deployments.create
on the resource organizations/{org}/environments/{env}
* apigee.proxyrevisions.deploy
on the resource organizations/{org}/apis/{api}/revisions/{rev}
§Arguments
name
- Required. Name of the API proxy revision deployment in the following format:organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
sourcepub fn environments_apis_revisions_get_deployments(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionGetDeploymentCall<'a, S>
pub fn environments_apis_revisions_get_deployments( &self, name: &str ) -> OrganizationEnvironmentApiRevisionGetDeploymentCall<'a, S>
Create a builder to help you perform the following task:
Gets the deployment of an API proxy revision and actual state reported by runtime pods.
§Arguments
name
- Required. Name representing an API proxy revision in an environment in the following format:organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
sourcepub fn environments_apis_revisions_undeploy(
&self,
name: &str
) -> OrganizationEnvironmentApiRevisionUndeployCall<'a, S>
pub fn environments_apis_revisions_undeploy( &self, name: &str ) -> OrganizationEnvironmentApiRevisionUndeployCall<'a, S>
Create a builder to help you perform the following task:
Undeploys an API proxy revision from an environment. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments
, two permissions are required: * apigee.deployments.delete
on the resource organizations/{org}/environments/{env}
* apigee.proxyrevisions.undeploy
on the resource organizations/{org}/apis/{api}/revisions/{rev}
§Arguments
name
- Required. Name of the API proxy revision deployment in the following format:organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
sourcepub fn environments_archive_deployments_create(
&self,
request: GoogleCloudApigeeV1ArchiveDeployment,
parent: &str
) -> OrganizationEnvironmentArchiveDeploymentCreateCall<'a, S>
pub fn environments_archive_deployments_create( &self, request: GoogleCloudApigeeV1ArchiveDeployment, parent: &str ) -> OrganizationEnvironmentArchiveDeploymentCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new ArchiveDeployment.
§Arguments
request
- No description provided.parent
- Required. The Environment this Archive Deployment will be created in.
sourcepub fn environments_archive_deployments_delete(
&self,
name: &str
) -> OrganizationEnvironmentArchiveDeploymentDeleteCall<'a, S>
pub fn environments_archive_deployments_delete( &self, name: &str ) -> OrganizationEnvironmentArchiveDeploymentDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an archive deployment.
§Arguments
name
- Required. Name of the Archive Deployment in the following format:organizations/{org}/environments/{env}/archiveDeployments/{id}
.
sourcepub fn environments_archive_deployments_generate_download_url(
&self,
request: GoogleCloudApigeeV1GenerateDownloadUrlRequest,
name: &str
) -> OrganizationEnvironmentArchiveDeploymentGenerateDownloadUrlCall<'a, S>
pub fn environments_archive_deployments_generate_download_url( &self, request: GoogleCloudApigeeV1GenerateDownloadUrlRequest, name: &str ) -> OrganizationEnvironmentArchiveDeploymentGenerateDownloadUrlCall<'a, S>
Create a builder to help you perform the following task:
Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL.
§Arguments
request
- No description provided.name
- Required. The name of the Archive Deployment you want to download.
sourcepub fn environments_archive_deployments_generate_upload_url(
&self,
request: GoogleCloudApigeeV1GenerateUploadUrlRequest,
parent: &str
) -> OrganizationEnvironmentArchiveDeploymentGenerateUploadUrlCall<'a, S>
pub fn environments_archive_deployments_generate_upload_url( &self, request: GoogleCloudApigeeV1GenerateUploadUrlRequest, parent: &str ) -> OrganizationEnvironmentArchiveDeploymentGenerateUploadUrlCall<'a, S>
Create a builder to help you perform the following task:
Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * content-type: application/zip
* x-goog-content-length-range: 0,1073741824
And this header SHOULD NOT be specified: * Authorization: Bearer YOUR_TOKEN
§Arguments
request
- No description provided.parent
- Required. The organization and environment to upload to.
sourcepub fn environments_archive_deployments_get(
&self,
name: &str
) -> OrganizationEnvironmentArchiveDeploymentGetCall<'a, S>
pub fn environments_archive_deployments_get( &self, name: &str ) -> OrganizationEnvironmentArchiveDeploymentGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified ArchiveDeployment.
§Arguments
name
- Required. Name of the Archive Deployment in the following format:organizations/{org}/environments/{env}/archiveDeployments/{id}
.
sourcepub fn environments_archive_deployments_list(
&self,
parent: &str
) -> OrganizationEnvironmentArchiveDeploymentListCall<'a, S>
pub fn environments_archive_deployments_list( &self, parent: &str ) -> OrganizationEnvironmentArchiveDeploymentListCall<'a, S>
Create a builder to help you perform the following task:
Lists the ArchiveDeployments in the specified Environment.
§Arguments
parent
- Required. Name of the Environment for which to list Archive Deployments in the format:organizations/{org}/environments/{env}
.
sourcepub fn environments_archive_deployments_patch(
&self,
request: GoogleCloudApigeeV1ArchiveDeployment,
name: &str
) -> OrganizationEnvironmentArchiveDeploymentPatchCall<'a, S>
pub fn environments_archive_deployments_patch( &self, request: GoogleCloudApigeeV1ArchiveDeployment, name: &str ) -> OrganizationEnvironmentArchiveDeploymentPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable.
§Arguments
request
- No description provided.name
- Name of the Archive Deployment in the following format:organizations/{org}/environments/{env}/archiveDeployments/{id}
.
sourcepub fn environments_caches_delete(
&self,
name: &str
) -> OrganizationEnvironmentCacheDeleteCall<'a, S>
pub fn environments_caches_delete( &self, name: &str ) -> OrganizationEnvironmentCacheDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a cache.
§Arguments
name
- Required. Cache resource name of the form:organizations/{organization_id}/environments/{environment_id}/caches/{cache_id}
sourcepub fn environments_deployments_list(
&self,
parent: &str
) -> OrganizationEnvironmentDeploymentListCall<'a, S>
pub fn environments_deployments_list( &self, parent: &str ) -> OrganizationEnvironmentDeploymentListCall<'a, S>
Create a builder to help you perform the following task:
Lists all deployments of API proxies or shared flows in an environment.
§Arguments
parent
- Required. Name of the environment for which to return deployment information in the following format:organizations/{org}/environments/{env}
Create a builder to help you perform the following task:
Attaches a shared flow to a flow hook.
§Arguments
request
- No description provided.name
- Required. Name of the flow hook to which the shared flow should be attached in the following format:organizations/{org}/environments/{env}/flowhooks/{flowhook}
Create a builder to help you perform the following task:
Detaches a shared flow from a flow hook.
§Arguments
name
- Required. Name of the flow hook to detach in the following format:organizations/{org}/environments/{env}/flowhooks/{flowhook}
sourcepub fn environments_flowhooks_get(
&self,
name: &str
) -> OrganizationEnvironmentFlowhookGetCall<'a, S>
pub fn environments_flowhooks_get( &self, name: &str ) -> OrganizationEnvironmentFlowhookGetCall<'a, S>
Create a builder to help you perform the following task:
Returns the name of the shared flow attached to the specified flow hook. If there’s no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.
§Arguments
name
- Required. Name of the flow hook in the following format:organizations/{org}/environments/{env}/flowhooks/{flowhook}
sourcepub fn environments_keystores_aliases_create(
&self,
request: GoogleApiHttpBody,
parent: &str
) -> OrganizationEnvironmentKeystoreAliasCreateCall<'a, S>
pub fn environments_keystores_aliases_create( &self, request: GoogleApiHttpBody, parent: &str ) -> OrganizationEnvironmentKeystoreAliasCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an alias from a key/certificate pair. The structure of the request is controlled by the format
query parameter: - keycertfile
- Separate PEM-encoded key and certificate files are uploaded. Set Content-Type: multipart/form-data
and include the keyFile
, certFile
, and password
(if keys are encrypted) fields in the request body. If uploading to a truststore, omit keyFile
. - pkcs12
- A PKCS12 file is uploaded. Set Content-Type: multipart/form-data
, provide the file in the file
field, and include the password
field if the file is encrypted in the request body. - selfsignedcert
- A new private key and certificate are generated. Set Content-Type: application/json
and include CertificateGenerationSpec in the request body.
§Arguments
request
- No description provided.parent
- Required. Name of the keystore. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}
.
sourcepub fn environments_keystores_aliases_csr(
&self,
name: &str
) -> OrganizationEnvironmentKeystoreAliasCsrCall<'a, S>
pub fn environments_keystores_aliases_csr( &self, name: &str ) -> OrganizationEnvironmentKeystoreAliasCsrCall<'a, S>
Create a builder to help you perform the following task:
Generates a PKCS #10 Certificate Signing Request for the private key in an alias.
§Arguments
name
- Required. Name of the alias. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}
.
sourcepub fn environments_keystores_aliases_delete(
&self,
name: &str
) -> OrganizationEnvironmentKeystoreAliasDeleteCall<'a, S>
pub fn environments_keystores_aliases_delete( &self, name: &str ) -> OrganizationEnvironmentKeystoreAliasDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an alias.
§Arguments
name
- Required. Name of the alias. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}
.
sourcepub fn environments_keystores_aliases_get(
&self,
name: &str
) -> OrganizationEnvironmentKeystoreAliasGetCall<'a, S>
pub fn environments_keystores_aliases_get( &self, name: &str ) -> OrganizationEnvironmentKeystoreAliasGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an alias.
§Arguments
name
- Required. Name of the alias. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}
.
sourcepub fn environments_keystores_aliases_get_certificate(
&self,
name: &str
) -> OrganizationEnvironmentKeystoreAliasGetCertificateCall<'a, S>
pub fn environments_keystores_aliases_get_certificate( &self, name: &str ) -> OrganizationEnvironmentKeystoreAliasGetCertificateCall<'a, S>
Create a builder to help you perform the following task:
Gets the certificate from an alias in PEM-encoded form.
§Arguments
name
- Required. Name of the alias. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}
.
sourcepub fn environments_keystores_aliases_update(
&self,
request: GoogleApiHttpBody,
name: &str
) -> OrganizationEnvironmentKeystoreAliasUpdateCall<'a, S>
pub fn environments_keystores_aliases_update( &self, request: GoogleApiHttpBody, name: &str ) -> OrganizationEnvironmentKeystoreAliasUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates the certificate in an alias.
§Arguments
request
- No description provided.name
- Required. Name of the alias. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}
sourcepub fn environments_keystores_create(
&self,
request: GoogleCloudApigeeV1Keystore,
parent: &str
) -> OrganizationEnvironmentKeystoreCreateCall<'a, S>
pub fn environments_keystores_create( &self, request: GoogleCloudApigeeV1Keystore, parent: &str ) -> OrganizationEnvironmentKeystoreCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a server’s certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.
§Arguments
request
- No description provided.parent
- Required. Name of the environment in which to create the keystore. Use the following format in your request:organizations/{org}/environments/{env}
sourcepub fn environments_keystores_delete(
&self,
name: &str
) -> OrganizationEnvironmentKeystoreDeleteCall<'a, S>
pub fn environments_keystores_delete( &self, name: &str ) -> OrganizationEnvironmentKeystoreDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a keystore or truststore.
§Arguments
name
- Required. Name of the keystore. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}
sourcepub fn environments_keystores_get(
&self,
name: &str
) -> OrganizationEnvironmentKeystoreGetCall<'a, S>
pub fn environments_keystores_get( &self, name: &str ) -> OrganizationEnvironmentKeystoreGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a keystore or truststore.
§Arguments
name
- Required. Name of the keystore. Use the following format in your request:organizations/{org}/environments/{env}/keystores/{keystore}
.
sourcepub fn environments_keyvaluemaps_entries_create(
&self,
request: GoogleCloudApigeeV1KeyValueEntry,
parent: &str
) -> OrganizationEnvironmentKeyvaluemapEntryCreateCall<'a, S>
pub fn environments_keyvaluemaps_entries_create( &self, request: GoogleCloudApigeeV1KeyValueEntry, parent: &str ) -> OrganizationEnvironmentKeyvaluemapEntryCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
request
- No description provided.parent
- Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn environments_keyvaluemaps_entries_delete(
&self,
name: &str
) -> OrganizationEnvironmentKeyvaluemapEntryDeleteCall<'a, S>
pub fn environments_keyvaluemaps_entries_delete( &self, name: &str ) -> OrganizationEnvironmentKeyvaluemapEntryDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
§Arguments
name
- Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
sourcepub fn environments_keyvaluemaps_entries_get(
&self,
name: &str
) -> OrganizationEnvironmentKeyvaluemapEntryGetCall<'a, S>
pub fn environments_keyvaluemaps_entries_get( &self, name: &str ) -> OrganizationEnvironmentKeyvaluemapEntryGetCall<'a, S>
Create a builder to help you perform the following task:
Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
name
- Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
sourcepub fn environments_keyvaluemaps_entries_list(
&self,
parent: &str
) -> OrganizationEnvironmentKeyvaluemapEntryListCall<'a, S>
pub fn environments_keyvaluemaps_entries_list( &self, parent: &str ) -> OrganizationEnvironmentKeyvaluemapEntryListCall<'a, S>
Create a builder to help you perform the following task:
Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
parent
- Required. Scope as indicated by the URI in which to list key value maps. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn environments_keyvaluemaps_entries_update(
&self,
request: GoogleCloudApigeeV1KeyValueEntry,
name: &str
) -> OrganizationEnvironmentKeyvaluemapEntryUpdateCall<'a, S>
pub fn environments_keyvaluemaps_entries_update( &self, request: GoogleCloudApigeeV1KeyValueEntry, name: &str ) -> OrganizationEnvironmentKeyvaluemapEntryUpdateCall<'a, S>
Create a builder to help you perform the following task:
Update key value entry scoped to an organization, environment, or API proxy for an existing key.
§Arguments
request
- No description provided.name
- Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn environments_keyvaluemaps_create(
&self,
request: GoogleCloudApigeeV1KeyValueMap,
parent: &str
) -> OrganizationEnvironmentKeyvaluemapCreateCall<'a, S>
pub fn environments_keyvaluemaps_create( &self, request: GoogleCloudApigeeV1KeyValueMap, parent: &str ) -> OrganizationEnvironmentKeyvaluemapCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a key value map in an environment.
§Arguments
request
- No description provided.parent
- Required. Name of the environment in which to create the key value map. Use the following structure in your request:organizations/{org}/environments/{env}
sourcepub fn environments_keyvaluemaps_delete(
&self,
name: &str
) -> OrganizationEnvironmentKeyvaluemapDeleteCall<'a, S>
pub fn environments_keyvaluemaps_delete( &self, name: &str ) -> OrganizationEnvironmentKeyvaluemapDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a key value map from an environment.
§Arguments
name
- Required. Name of the key value map. Use the following structure in your request:organizations/{org}/environments/{env}/keyvaluemaps/{keyvaluemap}
sourcepub fn environments_optimized_stats_get(
&self,
name: &str
) -> OrganizationEnvironmentOptimizedStatGetCall<'a, S>
pub fn environments_optimized_stats_get( &self, name: &str ) -> OrganizationEnvironmentOptimizedStatGetCall<'a, S>
Create a builder to help you perform the following task:
Similar to GetStats except that the response is less verbose.
§Arguments
name
- Required. Resource name for which the interactive query will be executed. Use the following format in your request:organizations/{org}/environments/{env}/optimizedStats/{dimensions}
Dimensions let you view metrics in meaningful groupings, such asapiproxy
,target_host
. The value ofdimensions
should be a comma-separated list as shown below:organizations/{org}/environments/{env}/optimizedStats/apiproxy,request_verb
sourcepub fn environments_queries_create(
&self,
request: GoogleCloudApigeeV1Query,
parent: &str
) -> OrganizationEnvironmentQueryCreateCall<'a, S>
pub fn environments_queries_create( &self, request: GoogleCloudApigeeV1Query, parent: &str ) -> OrganizationEnvironmentQueryCreateCall<'a, S>
Create a builder to help you perform the following task:
Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state
of “enqueued” means that the request succeeded.
§Arguments
request
- No description provided.parent
- Required. The parent resource name. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_queries_get(
&self,
name: &str
) -> OrganizationEnvironmentQueryGetCall<'a, S>
pub fn environments_queries_get( &self, name: &str ) -> OrganizationEnvironmentQueryGetCall<'a, S>
Create a builder to help you perform the following task:
Get query status If the query is still in progress, the state
is set to “running” After the query has completed successfully, state
is set to “completed”
§Arguments
name
- Required. Name of the asynchronous query to get. Must be of the formorganizations/{org}/environments/{env}/queries/{queryId}
.
sourcepub fn environments_queries_get_result(
&self,
name: &str
) -> OrganizationEnvironmentQueryGetResultCall<'a, S>
pub fn environments_queries_get_result( &self, name: &str ) -> OrganizationEnvironmentQueryGetResultCall<'a, S>
Create a builder to help you perform the following task:
After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip
§Arguments
name
- Required. Name of the asynchronous query result to get. Must be of the formorganizations/{org}/environments/{env}/queries/{queryId}/result
.
sourcepub fn environments_queries_get_resulturl(
&self,
name: &str
) -> OrganizationEnvironmentQueryGetResulturlCall<'a, S>
pub fn environments_queries_get_resulturl( &self, name: &str ) -> OrganizationEnvironmentQueryGetResulturlCall<'a, S>
Create a builder to help you perform the following task:
After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is sent to the client as a list of urls to JSON files.
§Arguments
name
- Required. Name of the asynchronous query result to get. Must be of the formorganizations/{org}/environments/{env}/queries/{queryId}/resulturl
.
sourcepub fn environments_queries_list(
&self,
parent: &str
) -> OrganizationEnvironmentQueryListCall<'a, S>
pub fn environments_queries_list( &self, parent: &str ) -> OrganizationEnvironmentQueryListCall<'a, S>
Create a builder to help you perform the following task:
Return a list of Asynchronous Queries
§Arguments
parent
- Required. The parent resource name. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_references_create(
&self,
request: GoogleCloudApigeeV1Reference,
parent: &str
) -> OrganizationEnvironmentReferenceCreateCall<'a, S>
pub fn environments_references_create( &self, request: GoogleCloudApigeeV1Reference, parent: &str ) -> OrganizationEnvironmentReferenceCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a Reference in the specified environment.
§Arguments
request
- No description provided.parent
- Required. The parent environment name under which the Reference will be created. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_references_delete(
&self,
name: &str
) -> OrganizationEnvironmentReferenceDeleteCall<'a, S>
pub fn environments_references_delete( &self, name: &str ) -> OrganizationEnvironmentReferenceDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a Reference from an environment. Returns the deleted Reference resource.
§Arguments
name
- Required. The name of the Reference to delete. Must be of the formorganizations/{org}/environments/{env}/references/{ref}
.
sourcepub fn environments_references_get(
&self,
name: &str
) -> OrganizationEnvironmentReferenceGetCall<'a, S>
pub fn environments_references_get( &self, name: &str ) -> OrganizationEnvironmentReferenceGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a Reference resource.
§Arguments
name
- Required. The name of the Reference to get. Must be of the formorganizations/{org}/environments/{env}/references/{ref}
.
sourcepub fn environments_references_update(
&self,
request: GoogleCloudApigeeV1Reference,
name: &str
) -> OrganizationEnvironmentReferenceUpdateCall<'a, S>
pub fn environments_references_update( &self, request: GoogleCloudApigeeV1Reference, name: &str ) -> OrganizationEnvironmentReferenceUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.
§Arguments
request
- No description provided.name
- Required. The name of the Reference to update. Must be of the formorganizations/{org}/environments/{env}/references/{ref}
.
sourcepub fn environments_resourcefiles_create(
&self,
request: GoogleApiHttpBody,
parent: &str
) -> OrganizationEnvironmentResourcefileCreateCall<'a, S>
pub fn environments_resourcefiles_create( &self, request: GoogleApiHttpBody, parent: &str ) -> OrganizationEnvironmentResourcefileCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a resource file. Specify the Content-Type
as application/octet-stream
or multipart/form-data
. For more information about resource files, see Resource files.
§Arguments
request
- No description provided.parent
- Required. Name of the environment in which to create the resource file in the following format:organizations/{org}/environments/{env}
.
sourcepub fn environments_resourcefiles_delete(
&self,
parent: &str,
type_: &str,
name: &str
) -> OrganizationEnvironmentResourcefileDeleteCall<'a, S>
pub fn environments_resourcefiles_delete( &self, parent: &str, type_: &str, name: &str ) -> OrganizationEnvironmentResourcefileDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a resource file. For more information about resource files, see Resource files.
§Arguments
parent
- Required. Name of the environment in the following format:organizations/{org}/environments/{env}
.type
- Required. Resource file type. {{ resource_file_type }}name
- Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&{}[]()+-=,.~’` ]{1,255}
sourcepub fn environments_resourcefiles_get(
&self,
parent: &str,
type_: &str,
name: &str
) -> OrganizationEnvironmentResourcefileGetCall<'a, S>
pub fn environments_resourcefiles_get( &self, parent: &str, type_: &str, name: &str ) -> OrganizationEnvironmentResourcefileGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the contents of a resource file. For more information about resource files, see Resource files.
§Arguments
parent
- Required. Name of the environment in the following format:organizations/{org}/environments/{env}
.type
- Required. Resource file type. {{ resource_file_type }}name
- Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&{}[]()+-=,.~’` ]{1,255}
sourcepub fn environments_resourcefiles_list(
&self,
parent: &str
) -> OrganizationEnvironmentResourcefileListCall<'a, S>
pub fn environments_resourcefiles_list( &self, parent: &str ) -> OrganizationEnvironmentResourcefileListCall<'a, S>
Create a builder to help you perform the following task:
Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.
§Arguments
parent
- Required. Name of the environment in which to list resource files in the following format:organizations/{org}/environments/{env}
.
sourcepub fn environments_resourcefiles_list_environment_resources(
&self,
parent: &str,
type_: &str
) -> OrganizationEnvironmentResourcefileListEnvironmentResourceCall<'a, S>
pub fn environments_resourcefiles_list_environment_resources( &self, parent: &str, type_: &str ) -> OrganizationEnvironmentResourcefileListEnvironmentResourceCall<'a, S>
Create a builder to help you perform the following task:
Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.
§Arguments
parent
- Required. Name of the environment in which to list resource files in the following format:organizations/{org}/environments/{env}
.type
- Optional. Type of resource files to list. {{ resource_file_type }}
sourcepub fn environments_resourcefiles_update(
&self,
request: GoogleApiHttpBody,
parent: &str,
type_: &str,
name: &str
) -> OrganizationEnvironmentResourcefileUpdateCall<'a, S>
pub fn environments_resourcefiles_update( &self, request: GoogleApiHttpBody, parent: &str, type_: &str, name: &str ) -> OrganizationEnvironmentResourcefileUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates a resource file. Specify the Content-Type
as application/octet-stream
or multipart/form-data
. For more information about resource files, see Resource files.
§Arguments
request
- No description provided.parent
- Required. Name of the environment in the following format:organizations/{org}/environments/{env}
.type
- Required. Resource file type. {{ resource_file_type }}name
- Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&{}[]()+-=,.~’` ]{1,255}
sourcepub fn environments_security_actions_create(
&self,
request: GoogleCloudApigeeV1SecurityAction,
parent: &str
) -> OrganizationEnvironmentSecurityActionCreateCall<'a, S>
pub fn environments_security_actions_create( &self, request: GoogleCloudApigeeV1SecurityAction, parent: &str ) -> OrganizationEnvironmentSecurityActionCreateCall<'a, S>
Create a builder to help you perform the following task:
CreateSecurityAction creates a SecurityAction.
§Arguments
request
- No description provided.parent
- Required. The organization and environment that this SecurityAction applies to. Format: organizations/{org}/environments/{env}
sourcepub fn environments_security_actions_disable(
&self,
request: GoogleCloudApigeeV1DisableSecurityActionRequest,
name: &str
) -> OrganizationEnvironmentSecurityActionDisableCall<'a, S>
pub fn environments_security_actions_disable( &self, request: GoogleCloudApigeeV1DisableSecurityActionRequest, name: &str ) -> OrganizationEnvironmentSecurityActionDisableCall<'a, S>
Create a builder to help you perform the following task:
Disable a SecurityAction. The state
of the SecurityAction after disabling is DISABLED
. DisableSecurityAction
can be called on SecurityActions in the state ENABLED
; SecurityActions in a different state (including DISABLED
) return an error.
§Arguments
request
- No description provided.name
- Required. The name of the SecurityAction to disable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
sourcepub fn environments_security_actions_enable(
&self,
request: GoogleCloudApigeeV1EnableSecurityActionRequest,
name: &str
) -> OrganizationEnvironmentSecurityActionEnableCall<'a, S>
pub fn environments_security_actions_enable( &self, request: GoogleCloudApigeeV1EnableSecurityActionRequest, name: &str ) -> OrganizationEnvironmentSecurityActionEnableCall<'a, S>
Create a builder to help you perform the following task:
Enable a SecurityAction. The state
of the SecurityAction after enabling is ENABLED
. EnableSecurityAction
can be called on SecurityActions in the state DISABLED
; SecurityActions in a different state (including `ENABLED) return an error.
§Arguments
request
- No description provided.name
- Required. The name of the SecurityAction to enable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
sourcepub fn environments_security_actions_get(
&self,
name: &str
) -> OrganizationEnvironmentSecurityActionGetCall<'a, S>
pub fn environments_security_actions_get( &self, name: &str ) -> OrganizationEnvironmentSecurityActionGetCall<'a, S>
Create a builder to help you perform the following task:
Get a SecurityAction by name.
§Arguments
name
- Required. The fully qualified name of the SecurityAction to retrieve. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
sourcepub fn environments_security_actions_list(
&self,
parent: &str
) -> OrganizationEnvironmentSecurityActionListCall<'a, S>
pub fn environments_security_actions_list( &self, parent: &str ) -> OrganizationEnvironmentSecurityActionListCall<'a, S>
Create a builder to help you perform the following task:
Returns a list of SecurityActions. This returns both enabled and disabled actions.
§Arguments
parent
- Required. The parent, which owns this collection of SecurityActions. Format: organizations/{org}/environments/{env}
sourcepub fn environments_security_incidents_batch_update(
&self,
request: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest,
parent: &str
) -> OrganizationEnvironmentSecurityIncidentBatchUpdateCall<'a, S>
pub fn environments_security_incidents_batch_update( &self, request: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest, parent: &str ) -> OrganizationEnvironmentSecurityIncidentBatchUpdateCall<'a, S>
Create a builder to help you perform the following task:
BatchUpdateSecurityIncident updates multiple existing security incidents.
§Arguments
request
- No description provided.parent
- Optional. The parent resource shared by all security incidents being updated. If this is set, the parent field in the UpdateSecurityIncidentRequest messages must either be empty or match this field.
sourcepub fn environments_security_incidents_get(
&self,
name: &str
) -> OrganizationEnvironmentSecurityIncidentGetCall<'a, S>
pub fn environments_security_incidents_get( &self, name: &str ) -> OrganizationEnvironmentSecurityIncidentGetCall<'a, S>
Create a builder to help you perform the following task:
GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment.
§Arguments
name
- Required. Security incident in the following format: `organizations/{org}/environments/{environment}/securityIncidents/{incident}’. Example: organizations/testOrg/environments/testEnv/securityIncidents/1234-4567-890-111
sourcepub fn environments_security_incidents_list(
&self,
parent: &str
) -> OrganizationEnvironmentSecurityIncidentListCall<'a, S>
pub fn environments_security_incidents_list( &self, parent: &str ) -> OrganizationEnvironmentSecurityIncidentListCall<'a, S>
Create a builder to help you perform the following task:
ListSecurityIncidents lists all the security incident associated with the environment.
§Arguments
parent
- Required. For a specific organization, list of all the security incidents. Format:organizations/{org}/environments/{environment}
sourcepub fn environments_security_incidents_patch(
&self,
request: GoogleCloudApigeeV1SecurityIncident,
name: &str
) -> OrganizationEnvironmentSecurityIncidentPatchCall<'a, S>
pub fn environments_security_incidents_patch( &self, request: GoogleCloudApigeeV1SecurityIncident, name: &str ) -> OrganizationEnvironmentSecurityIncidentPatchCall<'a, S>
Create a builder to help you perform the following task:
UpdateSecurityIncidents updates an existing security incident.
§Arguments
request
- No description provided.name
- Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
sourcepub fn environments_security_reports_create(
&self,
request: GoogleCloudApigeeV1SecurityReportQuery,
parent: &str
) -> OrganizationEnvironmentSecurityReportCreateCall<'a, S>
pub fn environments_security_reports_create( &self, request: GoogleCloudApigeeV1SecurityReportQuery, parent: &str ) -> OrganizationEnvironmentSecurityReportCreateCall<'a, S>
Create a builder to help you perform the following task:
Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the state
of “enqueued” means that the request succeeded.
§Arguments
request
- No description provided.parent
- Required. The parent resource name. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_security_reports_get(
&self,
name: &str
) -> OrganizationEnvironmentSecurityReportGetCall<'a, S>
pub fn environments_security_reports_get( &self, name: &str ) -> OrganizationEnvironmentSecurityReportGetCall<'a, S>
Create a builder to help you perform the following task:
Get security report status If the query is still in progress, the state
is set to “running” After the query has completed successfully, state
is set to “completed”
§Arguments
name
- Required. Name of the security report to get. Must be of the formorganizations/{org}/environments/{env}/securityReports/{reportId}
.
sourcepub fn environments_security_reports_get_result(
&self,
name: &str
) -> OrganizationEnvironmentSecurityReportGetResultCall<'a, S>
pub fn environments_security_reports_get_result( &self, name: &str ) -> OrganizationEnvironmentSecurityReportGetResultCall<'a, S>
Create a builder to help you perform the following task:
After the query is completed, use this API to retrieve the results as file. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip
§Arguments
name
- Required. Name of the security report result to get. Must be of the formorganizations/{org}/environments/{env}/securityReports/{reportId}/result
.
sourcepub fn environments_security_reports_get_result_view(
&self,
name: &str
) -> OrganizationEnvironmentSecurityReportGetResultViewCall<'a, S>
pub fn environments_security_reports_get_result_view( &self, name: &str ) -> OrganizationEnvironmentSecurityReportGetResultViewCall<'a, S>
Create a builder to help you perform the following task:
After the query is completed, use this API to view the query result when result size is small.
§Arguments
name
- Required. Name of the security report result view to get. Must be of the formorganizations/{org}/environments/{env}/securityReports/{reportId}/resultView
.
sourcepub fn environments_security_reports_list(
&self,
parent: &str
) -> OrganizationEnvironmentSecurityReportListCall<'a, S>
pub fn environments_security_reports_list( &self, parent: &str ) -> OrganizationEnvironmentSecurityReportListCall<'a, S>
Create a builder to help you perform the following task:
Return a list of Security Reports
§Arguments
parent
- Required. The parent resource name. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_security_stats_query_tabular_stats(
&self,
request: GoogleCloudApigeeV1QueryTabularStatsRequest,
orgenv: &str
) -> OrganizationEnvironmentSecurityStatQueryTabularStatCall<'a, S>
pub fn environments_security_stats_query_tabular_stats( &self, request: GoogleCloudApigeeV1QueryTabularStatsRequest, orgenv: &str ) -> OrganizationEnvironmentSecurityStatQueryTabularStatCall<'a, S>
Create a builder to help you perform the following task:
Retrieve security statistics as tabular rows.
§Arguments
request
- No description provided.orgenv
- Required. Should be of the form organizations//environments/.
sourcepub fn environments_security_stats_query_time_series_stats(
&self,
request: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest,
orgenv: &str
) -> OrganizationEnvironmentSecurityStatQueryTimeSeriesStatCall<'a, S>
pub fn environments_security_stats_query_time_series_stats( &self, request: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest, orgenv: &str ) -> OrganizationEnvironmentSecurityStatQueryTimeSeriesStatCall<'a, S>
Create a builder to help you perform the following task:
Retrieve security statistics as a collection of time series.
§Arguments
request
- No description provided.orgenv
- Required. Should be of the form organizations//environments/.
Create a builder to help you perform the following task:
Lists all deployments of a shared flow in an environment.
§Arguments
parent
- Required. Name representing a shared flow in an environment in the following format:organizations/{org}/environments/{env}/sharedflows/{sharedflow}
Create a builder to help you perform the following task:
Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the override
parameter to true
to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments
, two permissions are required: * apigee.deployments.create
on the resource organizations/{org}/environments/{env}
* apigee.sharedflowrevisions.deploy
on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}
§Arguments
name
- Required. Name of the shared flow revision to deploy in the following format:organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
Create a builder to help you perform the following task:
Gets the deployment of a shared flow revision and actual state reported by runtime pods.
§Arguments
name
- Required. Name representing a shared flow in an environment in the following format:organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
Create a builder to help you perform the following task:
Undeploys a shared flow revision from an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments
, two permissions are required: * apigee.deployments.delete
on the resource organizations/{org}/environments/{env}
* apigee.sharedflowrevisions.undeploy
on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}
§Arguments
name
- Required. Name of the shared flow revision to undeploy in the following format:organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
sourcepub fn environments_stats_get(
&self,
name: &str
) -> OrganizationEnvironmentStatGetCall<'a, S>
pub fn environments_stats_get( &self, name: &str ) -> OrganizationEnvironmentStatGetCall<'a, S>
Create a builder to help you perform the following task:
Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the stats
API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
§Arguments
name
- Required. Resource name for which the interactive query will be executed. Use the following format in your request:organizations/{org}/environments/{env}/stats/{dimensions}
Dimensions let you view metrics in meaningful groupings, such asapiproxy
ortarget_host
. The value of dimensions should be a comma-separated list, as shown below:organizations/{org}/environments/{env}/stats/apiproxy,request_verb
sourcepub fn environments_targetservers_create(
&self,
request: GoogleCloudApigeeV1TargetServer,
parent: &str
) -> OrganizationEnvironmentTargetserverCreateCall<'a, S>
pub fn environments_targetservers_create( &self, request: GoogleCloudApigeeV1TargetServer, parent: &str ) -> OrganizationEnvironmentTargetserverCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a TargetServer in the specified environment.
§Arguments
request
- No description provided.parent
- Required. The parent environment name under which the TargetServer will be created. Must be of the formorganizations/{org}/environments/{env}
.
sourcepub fn environments_targetservers_delete(
&self,
name: &str
) -> OrganizationEnvironmentTargetserverDeleteCall<'a, S>
pub fn environments_targetservers_delete( &self, name: &str ) -> OrganizationEnvironmentTargetserverDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.
§Arguments
name
- Required. The name of the TargetServer to delete. Must be of the formorganizations/{org}/environments/{env}/targetservers/{target_server_id}
.
sourcepub fn environments_targetservers_get(
&self,
name: &str
) -> OrganizationEnvironmentTargetserverGetCall<'a, S>
pub fn environments_targetservers_get( &self, name: &str ) -> OrganizationEnvironmentTargetserverGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a TargetServer resource.
§Arguments
name
- Required. The name of the TargetServer to get. Must be of the formorganizations/{org}/environments/{env}/targetservers/{target_server_id}
.
sourcepub fn environments_targetservers_update(
&self,
request: GoogleCloudApigeeV1TargetServer,
name: &str
) -> OrganizationEnvironmentTargetserverUpdateCall<'a, S>
pub fn environments_targetservers_update( &self, request: GoogleCloudApigeeV1TargetServer, name: &str ) -> OrganizationEnvironmentTargetserverUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.
§Arguments
request
- No description provided.name
- Required. The name of the TargetServer to replace. Must be of the formorganizations/{org}/environments/{env}/targetservers/{target_server_id}
.
sourcepub fn environments_trace_config_overrides_create(
&self,
request: GoogleCloudApigeeV1TraceConfigOverride,
parent: &str
) -> OrganizationEnvironmentTraceConfigOverrideCreateCall<'a, S>
pub fn environments_trace_config_overrides_create( &self, request: GoogleCloudApigeeV1TraceConfigOverride, parent: &str ) -> OrganizationEnvironmentTraceConfigOverrideCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.
§Arguments
request
- No description provided.parent
- Required. Parent resource of the trace configuration override. Use the following structure in your request. “organizations//environments//traceConfig”.
sourcepub fn environments_trace_config_overrides_delete(
&self,
name: &str
) -> OrganizationEnvironmentTraceConfigOverrideDeleteCall<'a, S>
pub fn environments_trace_config_overrides_delete( &self, name: &str ) -> OrganizationEnvironmentTraceConfigOverrideDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a distributed trace configuration override.
§Arguments
name
- Required. Name of the trace configuration override. Use the following structure in your request: “organizations//environments//traceConfig/overrides/*”.
sourcepub fn environments_trace_config_overrides_get(
&self,
name: &str
) -> OrganizationEnvironmentTraceConfigOverrideGetCall<'a, S>
pub fn environments_trace_config_overrides_get( &self, name: &str ) -> OrganizationEnvironmentTraceConfigOverrideGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a trace configuration override.
§Arguments
name
- Required. Name of the trace configuration override. Use the following structure in your request: “organizations//environments//traceConfig/overrides/*”.
sourcepub fn environments_trace_config_overrides_list(
&self,
parent: &str
) -> OrganizationEnvironmentTraceConfigOverrideListCall<'a, S>
pub fn environments_trace_config_overrides_list( &self, parent: &str ) -> OrganizationEnvironmentTraceConfigOverrideListCall<'a, S>
Create a builder to help you perform the following task:
Lists all of the distributed trace configuration overrides in an environment.
§Arguments
parent
- Required. Parent resource of the trace configuration override. Use the following structure in your request: “organizations//environments//traceConfig”.
sourcepub fn environments_trace_config_overrides_patch(
&self,
request: GoogleCloudApigeeV1TraceConfigOverride,
name: &str
) -> OrganizationEnvironmentTraceConfigOverridePatchCall<'a, S>
pub fn environments_trace_config_overrides_patch( &self, request: GoogleCloudApigeeV1TraceConfigOverride, name: &str ) -> OrganizationEnvironmentTraceConfigOverridePatchCall<'a, S>
Create a builder to help you perform the following task:
Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
§Arguments
request
- No description provided.name
- Required. Name of the trace configuration override. Use the following structure in your request: “organizations//environments//traceConfig/overrides/*”.
sourcepub fn environments_create(
&self,
request: GoogleCloudApigeeV1Environment,
parent: &str
) -> OrganizationEnvironmentCreateCall<'a, S>
pub fn environments_create( &self, request: GoogleCloudApigeeV1Environment, parent: &str ) -> OrganizationEnvironmentCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an environment in an organization.
§Arguments
request
- No description provided.parent
- Required. Name of the organization in which the environment will be created. Use the following structure in your request:organizations/{org}
sourcepub fn environments_delete(
&self,
name: &str
) -> OrganizationEnvironmentDeleteCall<'a, S>
pub fn environments_delete( &self, name: &str ) -> OrganizationEnvironmentDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an environment from an organization. Warning: You must delete all key value maps and key value entries before you delete an environment. Otherwise, if you re-create the environment the key value map entry operations will encounter encryption/decryption discrepancies.
§Arguments
name
- Required. Name of the environment. Use the following structure in your request:organizations/{org}/environments/{env}
sourcepub fn environments_get(
&self,
name: &str
) -> OrganizationEnvironmentGetCall<'a, S>
pub fn environments_get( &self, name: &str ) -> OrganizationEnvironmentGetCall<'a, S>
Create a builder to help you perform the following task:
Gets environment details.
§Arguments
name
- Required. Name of the environment. Use the following structure in your request:organizations/{org}/environments/{env}
sourcepub fn environments_get_addons_config(
&self,
name: &str
) -> OrganizationEnvironmentGetAddonsConfigCall<'a, S>
pub fn environments_get_addons_config( &self, name: &str ) -> OrganizationEnvironmentGetAddonsConfigCall<'a, S>
Create a builder to help you perform the following task:
Gets the add-ons config of an environment.
§Arguments
name
- Required. Name of the add-ons config. Must be in the format of/organizations/{org}/environments/{env}/addonsConfig
sourcepub fn environments_get_api_security_runtime_config(
&self,
name: &str
) -> OrganizationEnvironmentGetApiSecurityRuntimeConfigCall<'a, S>
pub fn environments_get_api_security_runtime_config( &self, name: &str ) -> OrganizationEnvironmentGetApiSecurityRuntimeConfigCall<'a, S>
Create a builder to help you perform the following task:
Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config.
§Arguments
name
- Required. Name of the environment API Security Runtime configuration resource. Use the following structure in your request:organizations/{org}/environments/{env}/apiSecurityRuntimeConfig
sourcepub fn environments_get_debugmask(
&self,
name: &str
) -> OrganizationEnvironmentGetDebugmaskCall<'a, S>
pub fn environments_get_debugmask( &self, name: &str ) -> OrganizationEnvironmentGetDebugmaskCall<'a, S>
Create a builder to help you perform the following task:
Gets the debug mask singleton resource for an environment.
§Arguments
name
- Required. Name of the debug mask. Use the following structure in your request:organizations/{org}/environments/{env}/debugmask
.
sourcepub fn environments_get_deployed_config(
&self,
name: &str
) -> OrganizationEnvironmentGetDeployedConfigCall<'a, S>
pub fn environments_get_deployed_config( &self, name: &str ) -> OrganizationEnvironmentGetDeployedConfigCall<'a, S>
Create a builder to help you perform the following task:
Gets the deployed configuration for an environment.
§Arguments
name
- Required. Name of the environment deployed configuration resource. Use the following structure in your request:organizations/{org}/environments/{env}/deployedConfig
sourcepub fn environments_get_iam_policy(
&self,
resource: &str
) -> OrganizationEnvironmentGetIamPolicyCall<'a, S>
pub fn environments_get_iam_policy( &self, resource: &str ) -> OrganizationEnvironmentGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.getIamPolicy
permission to call this API.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn environments_get_security_actions_config(
&self,
name: &str
) -> OrganizationEnvironmentGetSecurityActionsConfigCall<'a, S>
pub fn environments_get_security_actions_config( &self, name: &str ) -> OrganizationEnvironmentGetSecurityActionsConfigCall<'a, S>
Create a builder to help you perform the following task:
GetSecurityActionConfig returns the current SecurityActions configuration.
§Arguments
name
- Required. The name of the SecurityActionsConfig to retrieve. This will always be:organizations/{org}/environments/{env}/security_actions_config
sourcepub fn environments_get_trace_config(
&self,
name: &str
) -> OrganizationEnvironmentGetTraceConfigCall<'a, S>
pub fn environments_get_trace_config( &self, name: &str ) -> OrganizationEnvironmentGetTraceConfigCall<'a, S>
Create a builder to help you perform the following task:
Get distributed trace configuration in an environment.
§Arguments
name
- Required. Name of the trace configuration. Use the following structure in your request: “organizations//environments//traceConfig”.
sourcepub fn environments_modify_environment(
&self,
request: GoogleCloudApigeeV1Environment,
name: &str
) -> OrganizationEnvironmentModifyEnvironmentCall<'a, S>
pub fn environments_modify_environment( &self, request: GoogleCloudApigeeV1Environment, name: &str ) -> OrganizationEnvironmentModifyEnvironmentCall<'a, S>
Create a builder to help you perform the following task:
Updates properties for an Apigee environment with patch semantics using a field mask. Note: Not supported for Apigee hybrid.
§Arguments
request
- No description provided.name
- Required. Name of the environment. Use the following structure in your request:organizations/{org}/environments/{environment}
.
sourcepub fn environments_set_iam_policy(
&self,
request: GoogleIamV1SetIamPolicyRequest,
resource: &str
) -> OrganizationEnvironmentSetIamPolicyCall<'a, S>
pub fn environments_set_iam_policy( &self, request: GoogleIamV1SetIamPolicyRequest, resource: &str ) -> OrganizationEnvironmentSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.setIamPolicy
permission to call this API.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn environments_subscribe(
&self,
parent: &str
) -> OrganizationEnvironmentSubscribeCall<'a, S>
pub fn environments_subscribe( &self, parent: &str ) -> OrganizationEnvironmentSubscribeCall<'a, S>
Create a builder to help you perform the following task:
Creates a subscription for the environment’s Pub/Sub topic. The server will assign a random name for this subscription. The “name” and “push_config” must not be specified.
§Arguments
parent
- Required. Name of the environment. Use the following structure in your request:organizations/{org}/environments/{env}
sourcepub fn environments_test_iam_permissions(
&self,
request: GoogleIamV1TestIamPermissionsRequest,
resource: &str
) -> OrganizationEnvironmentTestIamPermissionCall<'a, S>
pub fn environments_test_iam_permissions( &self, request: GoogleIamV1TestIamPermissionsRequest, resource: &str ) -> OrganizationEnvironmentTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn environments_unsubscribe(
&self,
request: GoogleCloudApigeeV1Subscription,
parent: &str
) -> OrganizationEnvironmentUnsubscribeCall<'a, S>
pub fn environments_unsubscribe( &self, request: GoogleCloudApigeeV1Subscription, parent: &str ) -> OrganizationEnvironmentUnsubscribeCall<'a, S>
Create a builder to help you perform the following task:
Deletes a subscription for the environment’s Pub/Sub topic.
§Arguments
request
- No description provided.parent
- Required. Name of the environment. Use the following structure in your request:organizations/{org}/environments/{env}
sourcepub fn environments_update(
&self,
request: GoogleCloudApigeeV1Environment,
name: &str
) -> OrganizationEnvironmentUpdateCall<'a, S>
pub fn environments_update( &self, request: GoogleCloudApigeeV1Environment, name: &str ) -> OrganizationEnvironmentUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API. Note: Both PUT
and POST
methods are supported for updating an existing environment.
§Arguments
request
- No description provided.name
- Required. Name of the environment. Use the following structure in your request:organizations/{org}/environments/{env}
sourcepub fn environments_update_debugmask(
&self,
request: GoogleCloudApigeeV1DebugMask,
name: &str
) -> OrganizationEnvironmentUpdateDebugmaskCall<'a, S>
pub fn environments_update_debugmask( &self, request: GoogleCloudApigeeV1DebugMask, name: &str ) -> OrganizationEnvironmentUpdateDebugmaskCall<'a, S>
Create a builder to help you perform the following task:
Updates the debug mask singleton resource for an environment.
§Arguments
request
- No description provided.name
- Name of the debug mask.
sourcepub fn environments_update_environment(
&self,
request: GoogleCloudApigeeV1Environment,
name: &str
) -> OrganizationEnvironmentUpdateEnvironmentCall<'a, S>
pub fn environments_update_environment( &self, request: GoogleCloudApigeeV1Environment, name: &str ) -> OrganizationEnvironmentUpdateEnvironmentCall<'a, S>
Create a builder to help you perform the following task:
Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API. Note: Both PUT
and POST
methods are supported for updating an existing environment.
§Arguments
request
- No description provided.name
- Required. Name of the environment. Use the following structure in your request:organizations/{org}/environments/{env}
sourcepub fn environments_update_security_actions_config(
&self,
request: GoogleCloudApigeeV1SecurityActionsConfig,
name: &str
) -> OrganizationEnvironmentUpdateSecurityActionsConfigCall<'a, S>
pub fn environments_update_security_actions_config( &self, request: GoogleCloudApigeeV1SecurityActionsConfig, name: &str ) -> OrganizationEnvironmentUpdateSecurityActionsConfigCall<'a, S>
Create a builder to help you perform the following task:
UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.
§Arguments
request
- No description provided.name
- This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always:organizations/{org}/environments/{env}/security_actions_config
sourcepub fn environments_update_trace_config(
&self,
request: GoogleCloudApigeeV1TraceConfig,
name: &str
) -> OrganizationEnvironmentUpdateTraceConfigCall<'a, S>
pub fn environments_update_trace_config( &self, request: GoogleCloudApigeeV1TraceConfig, name: &str ) -> OrganizationEnvironmentUpdateTraceConfigCall<'a, S>
Create a builder to help you perform the following task:
Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
§Arguments
request
- No description provided.name
- Required. Name of the trace configuration. Use the following structure in your request: “organizations//environments//traceConfig”.
sourcepub fn host_queries_create(
&self,
request: GoogleCloudApigeeV1Query,
parent: &str
) -> OrganizationHostQueryCreateCall<'a, S>
pub fn host_queries_create( &self, request: GoogleCloudApigeeV1Query, parent: &str ) -> OrganizationHostQueryCreateCall<'a, S>
Create a builder to help you perform the following task:
Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state
of “enqueued” means that the request succeeded.
§Arguments
request
- No description provided.parent
- Required. The parent resource name. Must be of the formorganizations/{org}
.
sourcepub fn host_queries_get(
&self,
name: &str
) -> OrganizationHostQueryGetCall<'a, S>
pub fn host_queries_get( &self, name: &str ) -> OrganizationHostQueryGetCall<'a, S>
Create a builder to help you perform the following task:
Get status of a query submitted at host level. If the query is still in progress, the state
is set to “running” After the query has completed successfully, state
is set to “completed”
§Arguments
name
- Required. Name of the asynchronous query to get. Must be of the formorganizations/{org}/queries/{queryId}
.
sourcepub fn host_queries_get_result(
&self,
name: &str
) -> OrganizationHostQueryGetResultCall<'a, S>
pub fn host_queries_get_result( &self, name: &str ) -> OrganizationHostQueryGetResultCall<'a, S>
Create a builder to help you perform the following task:
After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip
§Arguments
name
- Required. Name of the asynchronous query result to get. Must be of the formorganizations/{org}/queries/{queryId}/result
.
sourcepub fn host_queries_get_result_view(
&self,
name: &str
) -> OrganizationHostQueryGetResultViewCall<'a, S>
pub fn host_queries_get_result_view( &self, name: &str ) -> OrganizationHostQueryGetResultViewCall<'a, S>
Create a builder to help you perform the following task:
§Arguments
name
- Required. Name of the asynchronous query result view to get. Must be of the formorganizations/{org}/queries/{queryId}/resultView
.
sourcepub fn host_queries_list(
&self,
parent: &str
) -> OrganizationHostQueryListCall<'a, S>
pub fn host_queries_list( &self, parent: &str ) -> OrganizationHostQueryListCall<'a, S>
Create a builder to help you perform the following task:
Return a list of Asynchronous Queries at host level.
§Arguments
parent
- Required. The parent resource name. Must be of the formorganizations/{org}
.
sourcepub fn host_security_reports_create(
&self,
request: GoogleCloudApigeeV1SecurityReportQuery,
parent: &str
) -> OrganizationHostSecurityReportCreateCall<'a, S>
pub fn host_security_reports_create( &self, request: GoogleCloudApigeeV1SecurityReportQuery, parent: &str ) -> OrganizationHostSecurityReportCreateCall<'a, S>
Create a builder to help you perform the following task:
Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state
of “enqueued” means that the request succeeded.
§Arguments
request
- No description provided.parent
- Required. The parent resource name. Must be of the formorganizations/{org}
.
sourcepub fn host_security_reports_get(
&self,
name: &str
) -> OrganizationHostSecurityReportGetCall<'a, S>
pub fn host_security_reports_get( &self, name: &str ) -> OrganizationHostSecurityReportGetCall<'a, S>
Create a builder to help you perform the following task:
Get status of a query submitted at host level. If the query is still in progress, the state
is set to “running” After the query has completed successfully, state
is set to “completed”
§Arguments
name
- Required. Name of the security report to get. Must be of the formorganizations/{org}/securityReports/{reportId}
.
sourcepub fn host_security_reports_get_result(
&self,
name: &str
) -> OrganizationHostSecurityReportGetResultCall<'a, S>
pub fn host_security_reports_get_result( &self, name: &str ) -> OrganizationHostSecurityReportGetResultCall<'a, S>
Create a builder to help you perform the following task:
After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip
§Arguments
name
- Required. Name of the security report result to get. Must be of the formorganizations/{org}/securityReports/{reportId}/result
.
sourcepub fn host_security_reports_get_result_view(
&self,
name: &str
) -> OrganizationHostSecurityReportGetResultViewCall<'a, S>
pub fn host_security_reports_get_result_view( &self, name: &str ) -> OrganizationHostSecurityReportGetResultViewCall<'a, S>
Create a builder to help you perform the following task:
After the query is completed, use this API to view the query result when result size is small.
§Arguments
name
- Required. Name of the security report result view to get. Must be of the formorganizations/{org}/securityReports/{reportId}/resultView
.
sourcepub fn host_security_reports_list(
&self,
parent: &str
) -> OrganizationHostSecurityReportListCall<'a, S>
pub fn host_security_reports_list( &self, parent: &str ) -> OrganizationHostSecurityReportListCall<'a, S>
Create a builder to help you perform the following task:
Return a list of Security Reports at host level.
§Arguments
parent
- Required. The parent resource name. Must be of the formorganizations/{org}
.
sourcepub fn host_stats_get(&self, name: &str) -> OrganizationHostStatGetCall<'a, S>
pub fn host_stats_get(&self, name: &str) -> OrganizationHostStatGetCall<'a, S>
Create a builder to help you perform the following task:
Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the stats
API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
§Arguments
name
- Required. Resource name for which the interactive query will be executed. Use the following format in your request:organizations/{org}/hostStats/{dimensions}
Dimensions let you view metrics in meaningful groupings, such asapiproxy
,target_host
. The value of dimensions should be a comma-separated list as shown beloworganizations/{org}/hostStats/apiproxy,request_verb
sourcepub fn instances_attachments_create(
&self,
request: GoogleCloudApigeeV1InstanceAttachment,
parent: &str
) -> OrganizationInstanceAttachmentCreateCall<'a, S>
pub fn instances_attachments_create( &self, request: GoogleCloudApigeeV1InstanceAttachment, parent: &str ) -> OrganizationInstanceAttachmentCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new attachment of an environment to an instance. Note: Not supported for Apigee hybrid.
§Arguments
request
- No description provided.parent
- Required. Name of the instance. Use the following structure in your request:organizations/{org}/instances/{instance}
.
sourcepub fn instances_attachments_delete(
&self,
name: &str
) -> OrganizationInstanceAttachmentDeleteCall<'a, S>
pub fn instances_attachments_delete( &self, name: &str ) -> OrganizationInstanceAttachmentDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an attachment. Note: Not supported for Apigee hybrid.
§Arguments
name
- Required. Name of the attachment. Use the following structure in your request:organizations/{org}/instances/{instance}/attachments/{attachment}
.
sourcepub fn instances_attachments_get(
&self,
name: &str
) -> OrganizationInstanceAttachmentGetCall<'a, S>
pub fn instances_attachments_get( &self, name: &str ) -> OrganizationInstanceAttachmentGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an attachment. Note: Not supported for Apigee hybrid.
§Arguments
name
- Required. Name of the attachment. Use the following structure in your request:organizations/{org}/instances/{instance}/attachments/{attachment}
sourcepub fn instances_attachments_list(
&self,
parent: &str
) -> OrganizationInstanceAttachmentListCall<'a, S>
pub fn instances_attachments_list( &self, parent: &str ) -> OrganizationInstanceAttachmentListCall<'a, S>
Create a builder to help you perform the following task:
Lists all attachments to an instance. Note: Not supported for Apigee hybrid.
§Arguments
parent
- Required. Name of the organization. Use the following structure in your request:organizations/{org}/instances/{instance}
sourcepub fn instances_canaryevaluations_create(
&self,
request: GoogleCloudApigeeV1CanaryEvaluation,
parent: &str
) -> OrganizationInstanceCanaryevaluationCreateCall<'a, S>
pub fn instances_canaryevaluations_create( &self, request: GoogleCloudApigeeV1CanaryEvaluation, parent: &str ) -> OrganizationInstanceCanaryevaluationCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new canary evaluation for an organization.
§Arguments
request
- No description provided.parent
- Required. Name of the organization. Use the following structure in your request:organizations/{org}/instances/{instance}
.
sourcepub fn instances_canaryevaluations_get(
&self,
name: &str
) -> OrganizationInstanceCanaryevaluationGetCall<'a, S>
pub fn instances_canaryevaluations_get( &self, name: &str ) -> OrganizationInstanceCanaryevaluationGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a CanaryEvaluation for an organization.
§Arguments
name
- Required. Name of the CanaryEvaluation. Use the following structure in your request:organizations/{org}/instances/*/canaryevaluations/{evaluation}
sourcepub fn instances_nat_addresses_activate(
&self,
request: GoogleCloudApigeeV1ActivateNatAddressRequest,
name: &str
) -> OrganizationInstanceNatAddressActivateCall<'a, S>
pub fn instances_nat_addresses_activate( &self, request: GoogleCloudApigeeV1ActivateNatAddressRequest, name: &str ) -> OrganizationInstanceNatAddressActivateCall<'a, S>
Create a builder to help you perform the following task:
Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.
§Arguments
request
- No description provided.name
- Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``
sourcepub fn instances_nat_addresses_create(
&self,
request: GoogleCloudApigeeV1NatAddress,
parent: &str
) -> OrganizationInstanceNatAddressCreateCall<'a, S>
pub fn instances_nat_addresses_create( &self, request: GoogleCloudApigeeV1NatAddress, parent: &str ) -> OrganizationInstanceNatAddressCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. Note: Not supported for Apigee hybrid.
§Arguments
request
- No description provided.parent
- Required. Name of the instance. Use the following structure in your request:organizations/{org}/instances/{instance}
sourcepub fn instances_nat_addresses_delete(
&self,
name: &str
) -> OrganizationInstanceNatAddressDeleteCall<'a, S>
pub fn instances_nat_addresses_delete( &self, name: &str ) -> OrganizationInstanceNatAddressDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.
§Arguments
name
- Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``
sourcepub fn instances_nat_addresses_get(
&self,
name: &str
) -> OrganizationInstanceNatAddressGetCall<'a, S>
pub fn instances_nat_addresses_get( &self, name: &str ) -> OrganizationInstanceNatAddressGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the details of a NAT address. Note: Not supported for Apigee hybrid.
§Arguments
name
- Required. Name of the nat address. Use the following structure in your request:organizations/{org}/instances/{instances}/natAddresses/{nataddress}
sourcepub fn instances_nat_addresses_list(
&self,
parent: &str
) -> OrganizationInstanceNatAddressListCall<'a, S>
pub fn instances_nat_addresses_list( &self, parent: &str ) -> OrganizationInstanceNatAddressListCall<'a, S>
Create a builder to help you perform the following task:
Lists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid.
§Arguments
parent
- Required. Name of the instance. Use the following structure in your request:organizations/{org}/instances/{instance}
sourcepub fn instances_create(
&self,
request: GoogleCloudApigeeV1Instance,
parent: &str
) -> OrganizationInstanceCreateCall<'a, S>
pub fn instances_create( &self, request: GoogleCloudApigeeV1Instance, parent: &str ) -> OrganizationInstanceCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.
§Arguments
request
- No description provided.parent
- Required. Name of the organization. Use the following structure in your request:organizations/{org}
.
sourcepub fn instances_delete(
&self,
name: &str
) -> OrganizationInstanceDeleteCall<'a, S>
pub fn instances_delete( &self, name: &str ) -> OrganizationInstanceDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.
§Arguments
name
- Required. Name of the instance. Use the following structure in your request:organizations/{org}/instances/{instance}
.
sourcepub fn instances_get(&self, name: &str) -> OrganizationInstanceGetCall<'a, S>
pub fn instances_get(&self, name: &str) -> OrganizationInstanceGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.
§Arguments
name
- Required. Name of the instance. Use the following structure in your request:organizations/{org}/instances/{instance}
.
sourcepub fn instances_list(
&self,
parent: &str
) -> OrganizationInstanceListCall<'a, S>
pub fn instances_list( &self, parent: &str ) -> OrganizationInstanceListCall<'a, S>
Create a builder to help you perform the following task:
Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.
§Arguments
parent
- Required. Name of the organization. Use the following structure in your request:organizations/{org}
.
sourcepub fn instances_patch(
&self,
request: GoogleCloudApigeeV1Instance,
name: &str
) -> OrganizationInstancePatchCall<'a, S>
pub fn instances_patch( &self, request: GoogleCloudApigeeV1Instance, name: &str ) -> OrganizationInstancePatchCall<'a, S>
Create a builder to help you perform the following task:
Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. Note: Not supported for Apigee hybrid.
§Arguments
request
- No description provided.name
- Required. Name of the instance. Use the following structure in your request:organizations/{org}/instances/{instance}
.
sourcepub fn instances_report_status(
&self,
request: GoogleCloudApigeeV1ReportInstanceStatusRequest,
instance: &str
) -> OrganizationInstanceReportStatuCall<'a, S>
pub fn instances_report_status( &self, request: GoogleCloudApigeeV1ReportInstanceStatusRequest, instance: &str ) -> OrganizationInstanceReportStatuCall<'a, S>
Create a builder to help you perform the following task:
Reports the latest status for a runtime instance.
§Arguments
request
- No description provided.instance
- The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance}
sourcepub fn keyvaluemaps_entries_create(
&self,
request: GoogleCloudApigeeV1KeyValueEntry,
parent: &str
) -> OrganizationKeyvaluemapEntryCreateCall<'a, S>
pub fn keyvaluemaps_entries_create( &self, request: GoogleCloudApigeeV1KeyValueEntry, parent: &str ) -> OrganizationKeyvaluemapEntryCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
request
- No description provided.parent
- Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn keyvaluemaps_entries_delete(
&self,
name: &str
) -> OrganizationKeyvaluemapEntryDeleteCall<'a, S>
pub fn keyvaluemaps_entries_delete( &self, name: &str ) -> OrganizationKeyvaluemapEntryDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
§Arguments
name
- Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
sourcepub fn keyvaluemaps_entries_get(
&self,
name: &str
) -> OrganizationKeyvaluemapEntryGetCall<'a, S>
pub fn keyvaluemaps_entries_get( &self, name: &str ) -> OrganizationKeyvaluemapEntryGetCall<'a, S>
Create a builder to help you perform the following task:
Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
name
- Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
sourcepub fn keyvaluemaps_entries_list(
&self,
parent: &str
) -> OrganizationKeyvaluemapEntryListCall<'a, S>
pub fn keyvaluemaps_entries_list( &self, parent: &str ) -> OrganizationKeyvaluemapEntryListCall<'a, S>
Create a builder to help you perform the following task:
Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
§Arguments
parent
- Required. Scope as indicated by the URI in which to list key value maps. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn keyvaluemaps_entries_update(
&self,
request: GoogleCloudApigeeV1KeyValueEntry,
name: &str
) -> OrganizationKeyvaluemapEntryUpdateCall<'a, S>
pub fn keyvaluemaps_entries_update( &self, request: GoogleCloudApigeeV1KeyValueEntry, name: &str ) -> OrganizationKeyvaluemapEntryUpdateCall<'a, S>
Create a builder to help you perform the following task:
Update key value entry scoped to an organization, environment, or API proxy for an existing key.
§Arguments
request
- No description provided.name
- Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: *organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
. *organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
*organizations/{organization}/keyvaluemaps/{keyvaluemap}
.
sourcepub fn keyvaluemaps_create(
&self,
request: GoogleCloudApigeeV1KeyValueMap,
parent: &str
) -> OrganizationKeyvaluemapCreateCall<'a, S>
pub fn keyvaluemaps_create( &self, request: GoogleCloudApigeeV1KeyValueMap, parent: &str ) -> OrganizationKeyvaluemapCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a key value map in an organization.
§Arguments
request
- No description provided.parent
- Required. Name of the organization in which to create the key value map file. Use the following structure in your request:organizations/{org}
sourcepub fn keyvaluemaps_delete(
&self,
name: &str
) -> OrganizationKeyvaluemapDeleteCall<'a, S>
pub fn keyvaluemaps_delete( &self, name: &str ) -> OrganizationKeyvaluemapDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a key value map from an organization.
§Arguments
name
- Required. Name of the key value map. Use the following structure in your request:organizations/{org}/keyvaluemaps/{keyvaluemap}
sourcepub fn operations_get(&self, name: &str) -> OrganizationOperationGetCall<'a, S>
pub fn operations_get(&self, name: &str) -> OrganizationOperationGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
§Arguments
name
- The name of the operation resource.
sourcepub fn operations_list(
&self,
name: &str
) -> OrganizationOperationListCall<'a, S>
pub fn operations_list( &self, name: &str ) -> OrganizationOperationListCall<'a, S>
Create a builder to help you perform the following task:
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED
.
§Arguments
name
- The name of the operation’s parent resource.
sourcepub fn optimized_host_stats_get(
&self,
name: &str
) -> OrganizationOptimizedHostStatGetCall<'a, S>
pub fn optimized_host_stats_get( &self, name: &str ) -> OrganizationOptimizedHostStatGetCall<'a, S>
Create a builder to help you perform the following task:
Similar to GetHostStats except that the response is less verbose.
§Arguments
name
- Required. Resource name for which the interactive query will be executed. Use the following format in your request:organizations/{organization_id}/optimizedHostStats/{dimensions}
Dimensions let you view metrics in meaningful groupings, such asapiproxy
,target_host
. The value of dimensions should be a comma-separated list as shown below:organizations/{org}/optimizedHostStats/apiproxy,request_verb
sourcepub fn reports_create(
&self,
request: GoogleCloudApigeeV1CustomReport,
parent: &str
) -> OrganizationReportCreateCall<'a, S>
pub fn reports_create( &self, request: GoogleCloudApigeeV1CustomReport, parent: &str ) -> OrganizationReportCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.
§Arguments
request
- No description provided.parent
- Required. The parent organization name under which the Custom Report will be created. Must be of the form:organizations/{organization_id}/reports
sourcepub fn reports_delete(&self, name: &str) -> OrganizationReportDeleteCall<'a, S>
pub fn reports_delete(&self, name: &str) -> OrganizationReportDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an existing custom report definition
§Arguments
name
- Required. Custom Report name of the form:organizations/{organization_id}/reports/{report_name}
sourcepub fn reports_get(&self, name: &str) -> OrganizationReportGetCall<'a, S>
pub fn reports_get(&self, name: &str) -> OrganizationReportGetCall<'a, S>
Create a builder to help you perform the following task:
Retrieve a custom report definition.
§Arguments
name
- Required. Custom Report name of the form:organizations/{organization_id}/reports/{report_name}
sourcepub fn reports_list(&self, parent: &str) -> OrganizationReportListCall<'a, S>
pub fn reports_list(&self, parent: &str) -> OrganizationReportListCall<'a, S>
Create a builder to help you perform the following task:
Return a list of Custom Reports
§Arguments
parent
- Required. The parent organization name under which the API product will be listedorganizations/{organization_id}/reports
sourcepub fn reports_update(
&self,
request: GoogleCloudApigeeV1CustomReport,
name: &str
) -> OrganizationReportUpdateCall<'a, S>
pub fn reports_update( &self, request: GoogleCloudApigeeV1CustomReport, name: &str ) -> OrganizationReportUpdateCall<'a, S>
Create a builder to help you perform the following task:
Update an existing custom report definition
§Arguments
request
- No description provided.name
- Required. Custom Report name of the form:organizations/{organization_id}/reports/{report_name}
sourcepub fn security_profiles_environments_compute_environment_scores(
&self,
request: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest,
profile_environment: &str
) -> OrganizationSecurityProfileEnvironmentComputeEnvironmentScoreCall<'a, S>
pub fn security_profiles_environments_compute_environment_scores( &self, request: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest, profile_environment: &str ) -> OrganizationSecurityProfileEnvironmentComputeEnvironmentScoreCall<'a, S>
Create a builder to help you perform the following task:
ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.
§Arguments
request
- No description provided.profileEnvironment
- Required. Name of organization and environment and profile id for which score needs to be computed. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}
sourcepub fn security_profiles_environments_create(
&self,
request: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation,
parent: &str
) -> OrganizationSecurityProfileEnvironmentCreateCall<'a, S>
pub fn security_profiles_environments_create( &self, request: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation, parent: &str ) -> OrganizationSecurityProfileEnvironmentCreateCall<'a, S>
Create a builder to help you perform the following task:
CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.
§Arguments
request
- No description provided.parent
- Required. Name of organization and security profile ID. Format: organizations/{org}/securityProfiles/{profile}
sourcepub fn security_profiles_environments_delete(
&self,
name: &str
) -> OrganizationSecurityProfileEnvironmentDeleteCall<'a, S>
pub fn security_profiles_environments_delete( &self, name: &str ) -> OrganizationSecurityProfileEnvironmentDeleteCall<'a, S>
Create a builder to help you perform the following task:
DeleteSecurityProfileEnvironmentAssociation removes profile environment association i.e. detaches environment from security profile.
§Arguments
name
- Required. The name of the environment attachment to delete. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}
sourcepub fn security_profiles_create(
&self,
request: GoogleCloudApigeeV1SecurityProfile,
parent: &str
) -> OrganizationSecurityProfileCreateCall<'a, S>
pub fn security_profiles_create( &self, request: GoogleCloudApigeeV1SecurityProfile, parent: &str ) -> OrganizationSecurityProfileCreateCall<'a, S>
Create a builder to help you perform the following task:
CreateSecurityProfile create a new custom security profile.
§Arguments
request
- No description provided.parent
- Required. Name of organization. Format: organizations/{org}
sourcepub fn security_profiles_delete(
&self,
name: &str
) -> OrganizationSecurityProfileDeleteCall<'a, S>
pub fn security_profiles_delete( &self, name: &str ) -> OrganizationSecurityProfileDeleteCall<'a, S>
Create a builder to help you perform the following task:
DeleteSecurityProfile delete a profile with all its revisions.
§Arguments
name
- Required. Name of profile. Format: organizations/{org}/securityProfiles/{profile}
sourcepub fn security_profiles_get(
&self,
name: &str
) -> OrganizationSecurityProfileGetCall<'a, S>
pub fn security_profiles_get( &self, name: &str ) -> OrganizationSecurityProfileGetCall<'a, S>
Create a builder to help you perform the following task:
GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.
§Arguments
name
- Required. Security profile in the following format: `organizations/{org}/securityProfiles/{profile}’. Profile may optionally contain revision ID. If revision ID is not provided, the response will contain latest revision by default. Example: organizations/testOrg/securityProfiles/testProfile@5
sourcepub fn security_profiles_list(
&self,
parent: &str
) -> OrganizationSecurityProfileListCall<'a, S>
pub fn security_profiles_list( &self, parent: &str ) -> OrganizationSecurityProfileListCall<'a, S>
Create a builder to help you perform the following task:
ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.
§Arguments
parent
- Required. For a specific organization, list of all the security profiles. Format:organizations/{org}
sourcepub fn security_profiles_list_revisions(
&self,
name: &str
) -> OrganizationSecurityProfileListRevisionCall<'a, S>
pub fn security_profiles_list_revisions( &self, name: &str ) -> OrganizationSecurityProfileListRevisionCall<'a, S>
Create a builder to help you perform the following task:
ListSecurityProfileRevisions lists all the revisions of the security profile.
§Arguments
name
- Required. For a specific profile, list all the revisions. Format:organizations/{org}/securityProfiles/{profile}
sourcepub fn security_profiles_patch(
&self,
request: GoogleCloudApigeeV1SecurityProfile,
name: &str
) -> OrganizationSecurityProfilePatchCall<'a, S>
pub fn security_profiles_patch( &self, request: GoogleCloudApigeeV1SecurityProfile, name: &str ) -> OrganizationSecurityProfilePatchCall<'a, S>
Create a builder to help you perform the following task:
UpdateSecurityProfile update the metadata of security profile.
§Arguments
request
- No description provided.name
- Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
Create a builder to help you perform the following task:
Lists all deployments of a shared flow.
§Arguments
parent
- Required. Name of the shared flow for which to return deployment information in the following format:organizations/{org}/sharedflows/{sharedflow}
Create a builder to help you perform the following task:
Lists all deployments of a shared flow revision.
§Arguments
parent
- Required. Name of the API proxy revision for which to return deployment information in the following format:organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}
.
Create a builder to help you perform the following task:
Deletes a shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.
§Arguments
name
- Required. The name of the shared flow revision to delete. Must be of the form:organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}
Create a builder to help you perform the following task:
Gets a revision of a shared flow. To download the shared flow configuration bundle for the specified revision as a zip file, set the format
query parameter to bundle
. If you are using curl, specify -o filename.zip
to save the output to a file; otherwise, it displays to stdout
. Then, develop the shared flow configuration locally and upload the updated sharedFlow configuration revision, as described in updateSharedFlowRevision.
§Arguments
name
- Required. The name of the shared flow revision to get. Must be of the form:organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}
Create a builder to help you perform the following task:
Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even if it becomes undeployed. The payload is a ZIP-formatted shared flow. Content type must be either multipart/form-data or application/octet-stream.
§Arguments
request
- No description provided.name
- Required. The name of the shared flow revision to update. Must be of the form:organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}
Create a builder to help you perform the following task:
Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.
§Arguments
request
- No description provided.parent
- Required. The name of the parent organization under which to create the shared flow. Must be of the form:organizations/{organization_id}
Create a builder to help you perform the following task:
Deletes a shared flow and all it’s revisions. The shared flow must be undeployed before you can delete it.
§Arguments
name
- Required. shared flow name of the form:organizations/{organization_id}/sharedflows/{shared_flow_id}
Create a builder to help you perform the following task:
Gets a shared flow by name, including a list of its revisions.
§Arguments
name
- Required. The name of the shared flow to get. Must be of the form:organizations/{organization_id}/sharedflows/{shared_flow_id}
Create a builder to help you perform the following task:
Lists all shared flows in the organization.
§Arguments
parent
- Required. The name of the parent organization under which to get shared flows. Must be of the form:organizations/{organization_id}
sourcepub fn sites_apicategories_create(
&self,
request: GoogleCloudApigeeV1ApiCategory,
parent: &str
) -> OrganizationSiteApicategoryCreateCall<'a, S>
pub fn sites_apicategories_create( &self, request: GoogleCloudApigeeV1ApiCategory, parent: &str ) -> OrganizationSiteApicategoryCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new API category.
§Arguments
request
- No description provided.parent
- Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
sourcepub fn sites_apicategories_delete(
&self,
name: &str
) -> OrganizationSiteApicategoryDeleteCall<'a, S>
pub fn sites_apicategories_delete( &self, name: &str ) -> OrganizationSiteApicategoryDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an API category.
§Arguments
name
- Required. Name of the category. Use the following structure in your request:organizations/{org}/sites/{site}/apicategories/{apicategory}
sourcepub fn sites_apicategories_get(
&self,
name: &str
) -> OrganizationSiteApicategoryGetCall<'a, S>
pub fn sites_apicategories_get( &self, name: &str ) -> OrganizationSiteApicategoryGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an API category.
§Arguments
name
- Required. Name of the category. Use the following structure in your request:organizations/{org}/sites/{site}/apicategories/{apicategory}
sourcepub fn sites_apicategories_list(
&self,
parent: &str
) -> OrganizationSiteApicategoryListCall<'a, S>
pub fn sites_apicategories_list( &self, parent: &str ) -> OrganizationSiteApicategoryListCall<'a, S>
Create a builder to help you perform the following task:
Returns the API categories associated with a portal.
§Arguments
parent
- Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
sourcepub fn sites_apicategories_patch(
&self,
request: GoogleCloudApigeeV1ApiCategory,
name: &str
) -> OrganizationSiteApicategoryPatchCall<'a, S>
pub fn sites_apicategories_patch( &self, request: GoogleCloudApigeeV1ApiCategory, name: &str ) -> OrganizationSiteApicategoryPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates an API category.
§Arguments
request
- No description provided.name
- Required. Name of the category. Use the following structure in your request:organizations/{org}/sites/{site}/apicategories/{apicategory}
sourcepub fn sites_apidocs_create(
&self,
request: GoogleCloudApigeeV1ApiDoc,
parent: &str
) -> OrganizationSiteApidocCreateCall<'a, S>
pub fn sites_apidocs_create( &self, request: GoogleCloudApigeeV1ApiDoc, parent: &str ) -> OrganizationSiteApidocCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new catalog item.
§Arguments
request
- No description provided.parent
- Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
sourcepub fn sites_apidocs_delete(
&self,
name: &str
) -> OrganizationSiteApidocDeleteCall<'a, S>
pub fn sites_apidocs_delete( &self, name: &str ) -> OrganizationSiteApidocDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a catalog item.
§Arguments
name
- Required. Name of the catalog item. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}
sourcepub fn sites_apidocs_get(
&self,
name: &str
) -> OrganizationSiteApidocGetCall<'a, S>
pub fn sites_apidocs_get( &self, name: &str ) -> OrganizationSiteApidocGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a catalog item.
§Arguments
name
- Required. Name of the catalog item. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}
sourcepub fn sites_apidocs_get_documentation(
&self,
name: &str
) -> OrganizationSiteApidocGetDocumentationCall<'a, S>
pub fn sites_apidocs_get_documentation( &self, name: &str ) -> OrganizationSiteApidocGetDocumentationCall<'a, S>
Create a builder to help you perform the following task:
Gets the documentation for the specified catalog item.
§Arguments
name
- Required. Resource name of the catalog item documentation. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation
sourcepub fn sites_apidocs_list(
&self,
parent: &str
) -> OrganizationSiteApidocListCall<'a, S>
pub fn sites_apidocs_list( &self, parent: &str ) -> OrganizationSiteApidocListCall<'a, S>
Create a builder to help you perform the following task:
Returns the catalog items associated with a portal.
§Arguments
parent
- Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
sourcepub fn sites_apidocs_update(
&self,
request: GoogleCloudApigeeV1ApiDoc,
name: &str
) -> OrganizationSiteApidocUpdateCall<'a, S>
pub fn sites_apidocs_update( &self, request: GoogleCloudApigeeV1ApiDoc, name: &str ) -> OrganizationSiteApidocUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates a catalog item.
§Arguments
request
- No description provided.name
- Required. Name of the catalog item. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}
sourcepub fn sites_apidocs_update_documentation(
&self,
request: GoogleCloudApigeeV1ApiDocDocumentation,
name: &str
) -> OrganizationSiteApidocUpdateDocumentationCall<'a, S>
pub fn sites_apidocs_update_documentation( &self, request: GoogleCloudApigeeV1ApiDocDocumentation, name: &str ) -> OrganizationSiteApidocUpdateDocumentationCall<'a, S>
Create a builder to help you perform the following task:
Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.
§Arguments
request
- No description provided.name
- Required. Resource name of the catalog item documentation. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation
sourcepub fn create(
&self,
request: GoogleCloudApigeeV1Organization
) -> OrganizationCreateCall<'a, S>
pub fn create( &self, request: GoogleCloudApigeeV1Organization ) -> OrganizationCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates an Apigee organization. See Create an Apigee organization.
§Arguments
request
- No description provided.
sourcepub fn delete(&self, name: &str) -> OrganizationDeleteCall<'a, S>
pub fn delete(&self, name: &str) -> OrganizationDeleteCall<'a, S>
Create a builder to help you perform the following task:
Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the retention
field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to MINIMUM
.
§Arguments
name
- Required. Name of the organization. Use the following structure in your request:organizations/{org}
sourcepub fn get(&self, name: &str) -> OrganizationGetCall<'a, S>
pub fn get(&self, name: &str) -> OrganizationGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the profile for an Apigee organization. See Understanding organizations.
§Arguments
name
- Required. Apigee organization name in the following format:organizations/{org}
sourcepub fn get_deployed_ingress_config(
&self,
name: &str
) -> OrganizationGetDeployedIngressConfigCall<'a, S>
pub fn get_deployed_ingress_config( &self, name: &str ) -> OrganizationGetDeployedIngressConfigCall<'a, S>
Create a builder to help you perform the following task:
Gets the deployed ingress configuration for an organization.
§Arguments
name
- Required. Name of the deployed configuration for the organization in the following format: ‘organizations/{org}/deployedIngressConfig’.
sourcepub fn get_project_mapping(
&self,
name: &str
) -> OrganizationGetProjectMappingCall<'a, S>
pub fn get_project_mapping( &self, name: &str ) -> OrganizationGetProjectMappingCall<'a, S>
Create a builder to help you perform the following task:
Gets the project ID and region for an Apigee organization.
§Arguments
name
- Required. Apigee organization name in the following format:organizations/{org}
sourcepub fn get_runtime_config(
&self,
name: &str
) -> OrganizationGetRuntimeConfigCall<'a, S>
pub fn get_runtime_config( &self, name: &str ) -> OrganizationGetRuntimeConfigCall<'a, S>
Create a builder to help you perform the following task:
Get runtime config for an organization.
§Arguments
name
- Required. Name of the runtime config for the organization in the following format: ‘organizations/{org}/runtimeConfig’.
sourcepub fn get_security_settings(
&self,
name: &str
) -> OrganizationGetSecuritySettingCall<'a, S>
pub fn get_security_settings( &self, name: &str ) -> OrganizationGetSecuritySettingCall<'a, S>
Create a builder to help you perform the following task:
GetSecuritySettings gets the security settings for API Security.
§Arguments
name
- Required. The name of the SecuritySettings to retrieve. This will always be: ‘organizations/{org}/securitySettings’.
Create a builder to help you perform the following task:
Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to getSyncAuthorization
. Pass that ETag when calling setSyncAuthorization to ensure that you are updating the correct version. If you don’t pass the ETag in the call to setSyncAuthorization
, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.
§Arguments
request
- No description provided.name
- Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
sourcepub fn list(&self, parent: &str) -> OrganizationListCall<'a, S>
pub fn list(&self, parent: &str) -> OrganizationListCall<'a, S>
Create a builder to help you perform the following task:
Lists the Apigee organizations and associated Google Cloud projects that you have permission to access. See Understanding organizations.
§Arguments
parent
- Required. Use the following structure in your request:organizations
sourcepub fn set_addons(
&self,
request: GoogleCloudApigeeV1SetAddonsRequest,
org: &str
) -> OrganizationSetAddonCall<'a, S>
pub fn set_addons( &self, request: GoogleCloudApigeeV1SetAddonsRequest, org: &str ) -> OrganizationSetAddonCall<'a, S>
Create a builder to help you perform the following task:
Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.
§Arguments
request
- No description provided.org
- Required. Name of the organization. Use the following structure in your request:organizations/{org}
Create a builder to help you perform the following task:
Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization
to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don’t pass the ETag in the call to setSyncAuthorization
, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.
§Arguments
request
- No description provided.name
- Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
sourcepub fn update(
&self,
request: GoogleCloudApigeeV1Organization,
name: &str
) -> OrganizationUpdateCall<'a, S>
pub fn update( &self, request: GoogleCloudApigeeV1Organization, name: &str ) -> OrganizationUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.
§Arguments
request
- No description provided.name
- Required. Apigee organization name in the following format:organizations/{org}
sourcepub fn update_security_settings(
&self,
request: GoogleCloudApigeeV1SecuritySettings,
name: &str
) -> OrganizationUpdateSecuritySettingCall<'a, S>
pub fn update_security_settings( &self, request: GoogleCloudApigeeV1SecuritySettings, name: &str ) -> OrganizationUpdateSecuritySettingCall<'a, S>
Create a builder to help you perform the following task:
UpdateSecuritySettings updates the current security settings for API Security.
§Arguments
request
- No description provided.name
- Identifier. Full resource name is alwaysorganizations/{org}/securitySettings
.