google_api_apigee v0.3.0 GoogleApi.Apigee.V1.Api.Organizations View Source
API calls for all endpoints tagged Organizations
.
Link to this section Summary
Functions
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.
Deletes an API product attribute.
Returns the value of an API product attribute.
Returns a list of all API product attributes.
Updates the value of an API product attribute. Limitations are
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
Deletes an API product from an organization.
Gets configuration details for an API product.
Lists all API product names for an organization.
Filter the list by passing an attributename
and attibutevalue
.
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.
Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment.
Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.
Lists all deployments of an API proxy.
Gets an API proxy including a list of existing revisions.
Creates a key value map in an api proxy.
Delete a key value map in an api proxy.
List key value maps in an api proxy.
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.
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.
Lists all deployments of an API proxy revision.
Gets an API proxy revision.
Lists all revisions for an API proxy.
Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine.
Gets the app profile for the specified app ID.
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).
Creates an app for a company.
Deletes a company app.
Gets the profile of a specific company app.
Deletes a key for a company app and removes all API products associated with the app. The key can no longer be used to access any APIs.
Gets information about the consumer key issued to a specific company app.
Updates an existing company app key to add additional API products or attributes. Note that only a single API product can be resolved per app key at runtime. API products are resolved by name, in alphabetical order. The first API product found in the list will be returned.
List company apps in an organization. You can optionally expand the response to include the profile for each app.
Updates an existing company app.
Creates an app for a company. Note that you must first create a profile for the company in your organization before you can register apps that are associated with the company.
Deletes an existing company.
List details for a company.
List all companies in an organization, and optionally returns an expanded list of companies, displaying a full profile for each company in the organization.
Updates an existing company. Send the complete company record as a payload with any changes you want to make. Note that to change the status of the Company you use Set the Status of a Company. The attributes in the sample payload below apply to company configuration in monetization. For non-monetized companies, you need send only displayName.
List all API docs in a ZMS zone that match the given query. Not a recognized rest pattern
Get all consumer resource types managed by this API.
List all pages in a ZMS zone that match the query string. Not a recognized rest pattern
Checks whether a developer has access to a resource.
Creates an app.
Deletes an app.
Gets an app.
Approves or revokes an API key for an app. Not a recognized rest pattern
Creates an API key for an app.
Lists all apps.
Updates an app.
Checks the status of this service.
Creates an Apigee organization. See Create an organization.
Lists all deployments of API proxies or shared flows.
Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.
Deletes a developer app attribute.
Returns a developer app attribute.
Returns a list of all developer app attributes.
Updates a developer app attribute.
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.
Deletes a developer app.
Manages access to a developer app by enabling you to
Returns the details for a developer app.
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.
Approve or revoke an app's consumer key. After a consumer key is approved, the app can use it to access APIs.
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 hybrid from another system.
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 hybrid from another system.
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.
Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.
Updates the scope of an app.
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.
Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps.
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.
Updates developer attributes.
Deletes a developer attribute.
Returns the value of the specified developer attribute.
Returns a list of all developer attributes.
Updates a developer attribute.
Creates a developer. Once created, the developer can register an app and obtain an API key.
Deletes a developer. All apps and API keys associated with the developer are also removed.
Returns the developer details, including the developer's name, email address, apps, and other information.
Lists all developers in an organization by email address.
Sets the status of a developer. Valid values are active
or inactive
.
Updates a developer.
Get a list of metrics and dimensions which can be used for creating analytics queries and reports. Each schema element contains the name of the field with its associated type and if it is either custom field or standard field.
Lists all deployments of an API proxy in an environment.
Creates a debug session for a deployed API Proxy revision.
Gets the debug data from a transaction.
Lists the transaction IDs from a debug session.
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.
Lists debug sessions that are currently active in the given API Proxy revision.
Undeploys an API proxy revision from an environment.
Gets the deployment of an API proxy revision and actual state reported by runtime pods.
Deletes a cache.
Lists all caches in an environment.
Creates an environment in an organization.
Deletes an environment from an organization. Returns the deleted environment resource.
Lists all deployments of API proxies or shared flows in an environment.
Attaches a shared flow to a flow hook.
Detaches a shared flow from a flow hook.
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.
Lists the flow hooks attached to an environment. This API always
returns: ["PreProxyFlowHook", "PostProxyFlowHook", "PreTargetFlowHook", "PostTargetFlowHook"]
Gets environment details.
Get Google Cloud Storage (GCS) signed url for specific organization and environment. Collection agent uses this signed url to upload data to GCS bucket.
Gets the debug mask singleton resource for an Environment.
Gets the deployed configuration for an environment.
Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API.
Creates an alias from a key, certificate pair.
The structure of the request is controlled by the format
query parameter
Generates a PKCS #10 Certificate Signing Request for the private key in an alias.
Deletes an alias.
Gets an alias.
Gets the certificate from an alias in PEM-encoded form.
Lists all aliases.
Updates the certificate in an alias.
Creates a keystore or truststore
Deletes a keystore or truststore.
Gets a keystore or truststore.
Lists all keystores and truststores.
Creates a key value map in an environment.
Delete a key value map in an environment.
List key value maps in an environment.
Lists all environments in an organization.
This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.
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.
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"
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-
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the asynchronous query result view to get. Must be of the formorganizations/{org}/environments/{env}/queries/{queryId}/resultView
.optional_params
(type:keyword()
) - Optional parameters
Return a list of Asynchronous Queries
Creates a Reference in the specified environment.
Deletes a Reference from an environment. Returns the deleted Reference resource.
Gets a Reference resource.
Lists all References in an environment as a JSON array.
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.
Creates a resource file.
Deletes a resource file.
Gets the contents of a resource file.
Lists all resource files.
Lists all resource files.
Updates a resource file.
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.
Lists all deployments of a shared flow in an environment.
Undeploys a shared flow revision from an environment.
Gets the deployment of a shared flow revision and actual state reported by runtime pods.
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. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.
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.
Creates a TargetServer in the specified environment.
Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.
Gets a TargetServer resource.
Lists all TargetServers in an environment as a JSON array.
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.
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).
Deletes a subscription for the environment's Pub/Sub topic.
Updates an existing environment.
Updates the debug mask singleton resource for an environment.
Updates an existing environment.
Gets the profile for an Apigee organization. See Organizations.
Gets metrics for an organization.
Lists details for all portals.
Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane.
Gets the current state of the portal application.
Creates a key value map in an organization.
Delete a key value map in an organization.
List key value maps in an organization.
Lists the Apigee organizations and associated GCP projects that you have permission to access. See Organizations.
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
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.
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
Gets a health check from the server.
Clears the scope of an identity provider. Not a recognized rest pattern
Creates a resource ID for the resource path. Not a recognized rest pattern
Deletes a resource.
Deletes a user.
Retrieves a user.
Lists all users.
Updates a user.
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.
Deletes an existing custom report definition
Retrieve a custom report definition.
Return a list of Custom Reports
Update an existing custom report definition
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.
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.
Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.
Lists all deployments of a shared flow.
Gets a shared flow by name, including a list of its revisions.
Lists all shared flows in the organization.
Deletes a shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.
Lists all deployments of a shared flow revision.
Gets a revision of a shared flow.
Lists all revisions for a shared flow.
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.
Publishes an API to the portal.
Removes a published API from the portal.
Removes the current OpenAPI Specification snapshot from the published API.
Gets the details for a published API.
Lists the details for all published APIs.
Lists the APIs that can be published to the portal.
Uploads the contents of an OpenAPI Specification snapshot for a published API.
Updates the details or specification for a published API.
Creates a new portal.
Gets the information required for the theme editor.
Publishes the custom CSS for a portal
Checks DNS to verify that a domain has the expected canonical name (CNAME) record.
Verifies a draft token for a portal.
Gets an email template for a portal.
Updates an email template for a portal.
Deletes a file from the portal.
Lists all files stored on the portal.
Uploads a file to the portal.
Retrieves the audience feature flag setting for a portal.
Gets the portal configuration.
Gets the custom CSS for a portal.
Gets the draft token for a portal.
Lists the keystores and certs that are available for TLS configuration.
Gets the organization type for a portal.
Gets the details for a portal.
Lists all published APIs.
Gets the SMTP configuration for a portal.
Creates a menu item.
Deletes a menu item.
Lists all menu items.
Lists the menu items for a menu type.
Publishes all menu items.
Rearranges the order of menu items.
Toggles the nesting of a menu item.
Updates a menu item.
Creates a menu type.
Deletes a menu type.
Lists all menu types.
Updates the draft content of a page on the portal.
Creates a new page on the portal.
Deletes a page from the portal.
Gets a page on the portal.
Lists the pages on the portal.
Lists the menu types that reference a specific page.
Publishes a page on the portal.
Unpublishes a page on the portal.
Updates a page on the portal.
Gets the title and contents of the page on the portal.
Lists the resource audience entitlements.
Updates audience entitlements for a resource. Not a recognized rest pattern
Sends a test email using the email template.
Updates the custom analytics script for a portal.
Restricts portal registration by identifying the individual email addresses or email domains that can create accounts on the portal.
Clones an existing portal.
Sets the default visibility to all users (public), using the
defaultAnonAllowed
flag, for pages and API products that are published
on the portal.
Enables or updates the custom domain for a portal.
Gets the defaultAnonAllowed
flag setting for a portal. This flag
defines the default visibility for pages and API products that are
published on the portal.
Gets the custom domain configuration for a portal.
Regenerates the secret key for a portal.
Resets the default settings for the SMTP configuration for a portal.
Lists details for the OpenAPI Specifications associated with an API.
Deletes a portal.
Updates the custom CSS for a portal.
Updates a portal.
Updates the SMTP configuration for a portal.
Associates a portal with a zone.
Gets any cross-organizational announcement that you want to display to customers on the UI.
Lists all teams a user can access.
Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.
Lists all zones in an Apigee organization with the audience feature enabled.
Enables the audience feature in a zone.
Retrieves the audience feature flag setting for a zone.
Validates a certificate in a zone.
Creates an identity provider in a zone.
Gets an identity provider in a zone.
Lists the identity providers in a zone. Underscore in URL
Updates an identity provider in a zone.
Updates the certificate for an identity provider.
Updates the configuration for an identity provider.
Lists the zones for an Apigee organization.
Note: This feature is not available to Apigee hybrid at this time.
Link to this section Functions
apigee_organizations_apiproducts_attributes(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_attributes( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API product name in the following form:organizations/organization_ID/apiproducts/api_product_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_attributes_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_attributes_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes an API product attribute.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API product name in the following form:organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_attributes_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_attributes_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns the value of an API product attribute.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API product name in the following form:organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_attributes_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_attributes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns a list of all API product attributes.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent organization name. Must be in the following form:organizations/organization_ID/apiproducts/api_product_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_attributes_update_api_product_attribute(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_attributes_update_api_product_attribute( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the value of an API product attribute. Limitations are:
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API product name in the following form:organizations/organization_ID/apiproducts/api_product_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
For more information, see {{what_api_product}}
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent organization name under which the API product will be created. Must be in the following form:organizations/organization_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API product name in the following form:organizations/organization_ID/apiproducts/api_product_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API product name in the following form:organizations/organization_ID/apiproducts/api_product_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProductsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all API product names for an organization.
Filter the list by passing an attributename
and attibutevalue
.
The limit on the number of API products returned by the API is 1000. You
can paginate the list of API products returned using the startKey
and
count
query parameters.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent organization name in the following form:organizations/organization_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:attributename
(type:String.t
) - The name of the attribute to search.:attributevalue
(type:String.t
) - The value of the attribute.:count
(type:String.t
) - Enter the number of API products you want returned in the API call. The limit is 1000.:expand
(type:boolean()
) - Set totrue
to get expanded details about each API.:startKey
(type:String.t
) - Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using thecount
query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without usingstartKey
). Product name is case sensitive.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProductsResponse{}}
on success{:error, info}
on failure
apigee_organizations_apiproducts_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apiproducts_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API product name in the following form:organizations/organization_ID/apiproducts/api_product_name
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}}
on success{:error, info}
on failure
apigee_organizations_apis_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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 toimport
. - Set the
Content-Type
header tomultipart/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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the organization in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values:import
to import the API proxy configuration bundle.validate
to validate the API proxy configuration bundle without importing it.
:name
(type:String.t
) - Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-:validate
(type:boolean()
) - Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision{}}
on success{:error, info}
on failure
apigee_organizations_apis_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the API proxy in the following format:organizations/{org}/apis/{api}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy{}}
on success{:error, info}
on failure
apigee_organizations_apis_deployments_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_deployments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all deployments of an API proxy.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the API proxy for which to return deployment information in the following format:organizations/{org}/apis/{api}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse{}}
on success{:error, info}
on failure
apigee_organizations_apis_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets an API proxy including a list of existing revisions.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the API proxy in the following format:organizations/{org}/apis/{api}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy{}}
on success{:error, info}
on failure
apigee_organizations_apis_keyvaluemaps_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_keyvaluemaps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a key value map in an api proxy.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the environment in which to create the key value map. Must be of the formorganizations/{organization}/apis/{api}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}}
on success{:error, info}
on failure
apigee_organizations_apis_keyvaluemaps_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_keyvaluemaps_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Delete a key value map in an api proxy.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the key value map. Must be of the formorganizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}}
on success{:error, info}
on failure
apigee_organizations_apis_keyvaluemaps_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_keyvaluemaps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List key value maps in an api proxy.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the environment in which to list key value maps. Must be of the formorganizations/{organization}/apis/{api}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_apis_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProxiesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the organization in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:includeMetaData
(type:boolean()
) - Flag that specifies whether to include API proxy metadata in the response.:includeRevisions
(type:boolean()
) - Flag that specifies whether to include a list of revisions in the response.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProxiesResponse{}}
on success{:error, info}
on failure
apigee_organizations_apis_revisions_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_revisions_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API proxy revision in the following format:organizations/{org}/apis/{api}/revisions/{rev}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision{}}
on success{:error, info}
on failure
apigee_organizations_apis_revisions_deployments_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_revisions_deployments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all deployments of an API proxy revision.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the API proxy revision for which to return deployment information in the following format:organizations/{org}/apis/{api}/revisions/{rev}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse{}}
on success{:error, info}
on failure
apigee_organizations_apis_revisions_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_revisions_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets an API proxy revision.
To download the API proxy configuration bundle for the specified revision as a zip file, do the following:
- Set the
format
query parameter tobundle
. - Set the
Accept
header toapplication/zip
.
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API proxy revision in the following format:organizations/{org}/apis/{api}/revisions/{rev}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:format
(type:String.t
) - Format used when downloading the API proxy configuration revision. Set tobundle
to download the API proxy configuration revision as a zip file.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleApiHttpBody{}}
on success{:error, info}
on failure
apigee_organizations_apis_revisions_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_revisions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all revisions for an API proxy.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the API proxy in the following format:organizations/{org}/apis/{api}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_apis_revisions_update_api_proxy_revision(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apis_revisions_update_api_proxy_revision( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. API proxy revision to update in the following format:organizations/{org}/apis/{api}/revisions/{rev}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:validate
(type:boolean()
) - Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision{}}
on success{:error, info}
on failure
apigee_organizations_apps_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apps_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1App.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the app profile for the specified app ID.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. App ID in the following format:organizations/{org}/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1App{}}
on success{:error, info}
on failure
apigee_organizations_apps_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_apps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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).
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Resource path of the parent in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:apiProduct
(type:String.t
) - API product.:apptype
(type:String.t
) - Optional. Filter by the type of the app. Valid values arecompany
ordeveloper
. Defaults todeveloper
.:expand
(type:boolean()
) - Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults tofalse
.:ids
(type:String.t
) - Optional. Comma-separated list of app IDs on which to filter.:includeCred
(type:boolean()
) - Optional. Flag that specifies whether to include credentials in the response.:keyStatus
(type:String.t
) - Optional. Key status of the app. Valid values includeapproved
orrevoked
. Defaults toapproved
.:rows
(type:String.t
) - Optional. Maximum number of app IDs to return. Defaults to 10000.:startKey
(type:String.t
) - Returns the list of apps starting from the specified app ID.:status
(type:String.t
) - Optional. Filter by the status of the app. Valid values areapproved
orrevoked
. Defaults toapproved
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppsResponse{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates an app for a company.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Resource path of the parent:organizations/{org}/companies/{company_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a company app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - name of the app resource:organizations/{org}/companies/{company_name}/apps/{app_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the profile of a specific company app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - name of the app resource:organizations/{org}/companies/{company_name}/apps/{app_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_keys_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_keys_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a key for a company app and removes all API products associated with the app. The key can no longer be used to access any APIs.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Resource name of a company app keyorganizations/{org}/companies/{company}/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyAppKey{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_keys_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_keys_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets information about the consumer key issued to a specific company app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Resource name of a company app keyorganizations/{org}/companies/{company}/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyAppKey{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_keys_update_company_app_key(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_keys_update_company_app_key( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an existing company app key to add additional API products or attributes. Note that only a single API product can be resolved per app key at runtime. API products are resolved by name, in alphabetical order. The first API product found in the list will be returned.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Resource name of a company app keyorganizations/{org}/companies/{company}/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Set action to approve or revoke.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyAppKey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyAppKey{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListCompanyAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List company apps in an organization. You can optionally expand the response to include the profile for each app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - The name of a company resource:organizations/{org}/companies/{company_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:count
(type:String.t
) - Limits the list to the number you specify. The limit is 100.:expand
(type:boolean()
) - Set expand to true to return a full profile:startKey
(type:String.t
) - Lets you return a list of app starting with a specific app name in the list.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListCompanyAppsResponse{}}
on success{:error, info}
on failure
apigee_organizations_companies_apps_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_apps_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an existing company app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Resource path of the app:organizations/{org}/companies/{company_name}/apps/{app_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp{}}
on success{:error, info}
on failure
apigee_organizations_companies_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates an app for a company. Note that you must first create a profile for the company in your organization before you can register apps that are associated with the company.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Name of org that the company will be created in{parent=organizations/*}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company{}}
on success{:error, info}
on failure
apigee_organizations_companies_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes an existing company.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - The company resource nameorganizations/{org}/companies/{company}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company{}}
on success{:error, info}
on failure
apigee_organizations_companies_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List details for a company.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - The company resource nameorganizations/{org}/companies/{company}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company{}}
on success{:error, info}
on failure
apigee_organizations_companies_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListCompaniesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List all companies in an organization, and optionally returns an expanded list of companies, displaying a full profile for each company in the organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - The parent organization nameorganizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:count
(type:String.t
) - Limits the list to the number you specify. The limit is 100.:expand
(type:boolean()
) - Set expand to true to return a full profile for each company.:includeDevelopers
(type:boolean()
) - Optional. include developers in the response.:startKey
(type:String.t
) - To filter the keys that are returned, enter the email of a developer that the list will start with.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListCompaniesResponse{}}
on success{:error, info}
on failure
apigee_organizations_companies_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_companies_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an existing company. Send the complete company record as a payload with any changes you want to make. Note that to change the status of the Company you use Set the Status of a Company. The attributes in the sample payload below apply to company configuration in monetization. For non-monetized companies, you need send only displayName.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Name of the company to be updated.{name=organizations/*/companies/*}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Specify the status as active or inactive.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company{}}
on success{:error, info}
on failure
apigee_organizations_consumerresources_apis(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumerresources_apis( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceCollection.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List all API docs in a ZMS zone that match the given query. Not a recognized rest pattern
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Must be of the formorganizations/{organization_id}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:q
(type:String.t
) -:zmsId
(type:String.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceCollection{}}
on success{:error, info}
on failure
apigee_organizations_consumerresources_get_resourcetypes(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumerresources_get_resourcetypes( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceTypeCollection.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Get all consumer resource types managed by this API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Must be of the formorganizations/{organization_id}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceTypeCollection{}}
on success{:error, info}
on failure
apigee_organizations_consumerresources_pages(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumerresources_pages( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceCollection.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List all pages in a ZMS zone that match the query string. Not a recognized rest pattern
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Must be of the formorganizations/{organization_id}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:q
(type:String.t
) -:zmsId
(type:String.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceCollection{}}
on success{:error, info}
on failure
apigee_organizations_consumers_access(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_access( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CheckAccessResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Checks whether a developer has access to a resource.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CheckAccessBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CheckAccessResponse{}}
on success{:error, info}
on failure
apigee_organizations_consumers_apps_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_apps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAppResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates an app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CreateConsumerAppRequestBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAppResponse{}}
on success{:error, info}
on failure
apigee_organizations_consumers_apps_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_apps_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes an app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the app. Use the following structure in your request:organizations/{org}/consumers/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse{}}
on success{:error, info}
on failure
apigee_organizations_consumers_apps_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_apps_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAppResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets an app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the app. Use the following structure in your request:organizations/{org}/consumers/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAppResponse{}}
on success{:error, info}
on failure
apigee_organizations_consumers_apps_keys_approve_revoke_consumer_app_key(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_apps_keys_approve_revoke_consumer_app_key( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Approves or revokes an API key for an app. Not a recognized rest pattern
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the API key. Use the following structure in your request:organizations/{org}/consumers/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyStatusChange.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_consumers_apps_keys_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_apps_keys_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates an API key for an app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the app. Use the following structure in your request:organizations/{org}/consumers/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse{}}
on success{:error, info}
on failure
apigee_organizations_consumers_apps_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_apps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListConsumerAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all apps.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListConsumerAppsResponse{}}
on success{:error, info}
on failure
apigee_organizations_consumers_apps_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_apps_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAppResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the app. Use the following structure in your request:organizations/{org}/consumers/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalApp.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAppResponse{}}
on success{:error, info}
on failure
apigee_organizations_consumers_status(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_consumers_status( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CapiServerStatusResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Checks the status of this service.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CapiServerStatusResponse{}}
on success{:error, info}
on failure
apigee_organizations_create(connection, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates an Apigee organization. See Create an organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:parent
(type:String.t
) - Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request:projects/<project>
:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Organization.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation{}}
on success{:error, info}
on failure
apigee_organizations_deployments_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_deployments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all deployments of API proxies or shared flows.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the organization for which to return deployment information in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:sharedFlows
(type:boolean()
) - Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set totrue
to return shared flow deployments; set tofalse
to return API proxy deployments. Defaults tofalse
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_attributes(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_attributes( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_attributes_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_attributes_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a developer app attribute.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_attributes_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_attributes_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns a developer app attribute.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_attributes_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_attributes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns a list of all developer app attributes.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_attributes_update_developer_app_attribute(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_attributes_update_developer_app_attribute( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_generate_key_pair_or_update_developer_app_status(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_generate_key_pair_or_update_developer_app_status( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
approved
or revoked
, 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 (approved
or revoked
) 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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Action. Valid values areapprove
orrevoke
.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns the details for a developer app.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:entity
(type:String.t
) - Note: Must be used in conjunction with thequery
parameter.Set to
apiresources
to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.:query
(type:String.t
) - Note: Must be used in conjunction with theentity
parameter.Set to
count
to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_apiproducts_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_apiproducts_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - 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}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Approve or revoke an app's consumer key. 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 hybrid checks the status of the consumer key and
if set to revoked
will not allow access to the API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - 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}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Approve or revoke the consumer key by setting this value toapprove
orrevoke
, respectively.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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 hybrid from another system.
Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.
Note: To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each.
After creating the consumer key and secret, associate the key with an API product using the UpdateDeveloperAppKey API.
If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Parent of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_create_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_create_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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 hybrid from another system.
Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.
Note: To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each.
After creating the consumer key and secret, associate the key with an API product using the UpdateDeveloperAppKey API.
If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Parent of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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:
- 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.
- Delete the developer app, if it is no longer required.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_replace_developer_app_key(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_replace_developer_app_key( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_keys_update_developer_app_key(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_keys_update_developer_app_key( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Name of the developer app key. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Approve or revoke the consumer key by setting this value toapprove
orrevoke
, respectively.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperAppKey{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeveloperAppsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:count
(type:String.t
) - Number of developer apps to return in the API call. Use with thestartKey
parameter to provide more targeted filtering. The limit is 1000.:expand
(type:boolean()
) - Optional. Specifies whether to expand the results. Set totrue
to expand the results. This query parameter is not valid if you use thecount
orstartKey
query parameters.:shallowExpand
(type:boolean()
) - Optional. Specifies whether to expand the results in shallow mode. Set totrue
to expand the results in shallow mode.:startKey
(type:String.t
) - Note: Must be used in conjunction with thecount
parameter.Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the
count
query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeveloperAppsResponse{}}
on success{:error, info}
on failure
apigee_organizations_developers_apps_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_apps_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer app. Use the following structure in your request:organizations/{org}/developers/{developer_email}/apps/{app}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp{}}
on success{:error, info}
on failure
apigee_organizations_developers_attributes(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_attributes( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Email address of the developer for which attributes are being updated in the following format:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}}
on success{:error, info}
on failure
apigee_organizations_developers_attributes_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_attributes_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a developer attribute.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/attributes/{attribute}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_developers_attributes_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_attributes_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns the value of the specified developer attribute.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/attributes/{attribute}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_developers_attributes_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_attributes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns a list of all developer attributes.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Email address of the developer for which attributes are being listed in the following format:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}}
on success{:error, info}
on failure
apigee_organizations_developers_attributes_update_developer_attribute(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_attributes_update_developer_attribute( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the developer attribute. Use the following structure in your request:organizations/{org}/developers/{developer_email}/attributes/{attribute}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}}
on success{:error, info}
on failure
apigee_organizations_developers_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request:organizations/{org}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer{}}
on success{:error, info}
on failure
apigee_organizations_developers_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer{}}
on success{:error, info}
on failure
apigee_organizations_developers_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Status of the developer. Valid values areactive
orinactive
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer{}}
on success{:error, info}
on failure
apigee_organizations_developers_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListOfDevelopersResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:count
(type:String.t
) - Optional. Number of developers to return in the API call. Use with thestartKey
parameter to provide more targeted filtering. The limit is 1000.:expand
(type:boolean()
) - Specifies whether to expand the results. Set totrue
to expand the results. This query parameter is not valid if you use thecount
orstartKey
query parameters.:ids
(type:String.t
) - Optional. List of IDs to include, separated by commas.:includeCompany
(type:boolean()
) - Flag that specifies whether to include company details in the response.:startKey
(type:String.t
) - Note: Must be used in conjunction with thecount
parameter.Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns:
westley@example.com fezzik@example.com buttercup@example.com
and your
startKey
isfezzik@example.com
, the list returned will befezzik@example.com buttercup@example.com
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListOfDevelopersResponse{}}
on success{:error, info}
on failure
apigee_organizations_developers_set_developer_status(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_set_developer_status( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Sets the status of a developer. Valid values are active
or inactive
.
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.
If successful, the API call returns the
following HTTP status code: 204 No Content
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:action
(type:String.t
) - Status of the developer. Valid values areactive
andinactive
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_developers_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_developers_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Email address of the developer. Use the following structure in your request:organizations/{org}/developers/{developer_email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer{}}
on success{:error, info}
on failure
apigee_organizations_environments_analytics_admin_get_schemav2(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_analytics_admin_get_schemav2( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Schema.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Get a list of metrics and dimensions which can be used for creating analytics queries and reports. Each schema element contains the name of the field with its associated type and if it is either custom field or standard field.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The parent organization and environment names. Must be of the formorganizations/{org}/environments/{env}/analytics/admin/schemav2
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:type
(type:String.t
) - Required. Type refers to the dataset name whose schema needs to be retrieved E.g. type=fact or type=agg_cus1
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Schema{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_deployments_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_deployments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all deployments of an API proxy in an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name representing an API proxy in an environment in the following format:organizations/{org}/environments/{env}/apis/{api}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_revisions_debugsessions_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_revisions_debugsessions_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugSession.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a debug session for a deployed API Proxy revision.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - 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}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:timeout
(type:String.t
) - Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugSession.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugSession{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_revisions_debugsessions_data_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_revisions_debugsessions_data_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugSessionTransaction.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the debug data from a transaction.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - 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}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugSessionTransaction{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_revisions_debugsessions_data_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_revisions_debugsessions_data_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the transaction IDs from a debug session.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the debug sessions for which to list transactions. Must be of the form:organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:limit
(type:integer()
) - Optional. A http query parameter that can control the maximum number of debug session transactions that can be returned by UAP.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_revisions_debugsessions_delete_data(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_revisions_debugsessions_delete_data( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the debug session to delete. Must be of the form:organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_revisions_debugsessions_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_revisions_debugsessions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDebugSessionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists debug sessions that are currently active in the given API Proxy revision.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - 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}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDebugSessionsResponse{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_revisions_deployments(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_revisions_deployments( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Undeploys an API proxy revision from an environment.
Because multiple revisions of the same API proxy can be deployed in the same environment if the base paths are different, you must specify the revision number of the API proxy.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the API proxy revision deployment in the following format:organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_environments_apis_revisions_get_deployments(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_apis_revisions_get_deployments( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Deployment.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the deployment of an API proxy revision and actual state reported by runtime pods.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name representing an API proxy revision in an environment in the following format:organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Deployment{}}
on success{:error, info}
on failure
apigee_organizations_environments_caches_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_caches_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a cache.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Cache resource name of the form:`organizations/{organization_id}/environments/{environment_id}/caches/{cache_id}`
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_environments_caches_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_caches_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all caches in an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the parent environment under which to get caches. Must be of the form:`organizations/{organization_id}/environments/{environment_id}`
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates an environment in an organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the organization in which the environment will be created in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:name
(type:String.t
) - Optional. Name of the environment. Alternatively, the name may be specified in the request body in the environment_id field.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation{}}
on success{:error, info}
on failure
apigee_organizations_environments_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes an environment from an organization. Returns the deleted environment resource.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the environment to delete in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation{}}
on success{:error, info}
on failure
apigee_organizations_environments_deployments_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_deployments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all deployments of API proxies or shared flows in an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment for which to return deployment information in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:sharedFlows
(type:boolean()
) - Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set totrue
to return shared flow deployments; set tofalse
to return API proxy deployments. Defaults tofalse
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse{}}
on success{:error, info}
on failure
apigee_organizations_environments_flowhooks_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_flowhooks_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1FlowHook.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the flow hook in the following format:organizations/{org}/environments/{env}/flowhooks/{flowhook}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1FlowHook{}}
on success{:error, info}
on failure
apigee_organizations_environments_flowhooks_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_flowhooks_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the flow hooks attached to an environment. This API always
returns: ["PreProxyFlowHook", "PostProxyFlowHook", "PreTargetFlowHook", "PostTargetFlowHook"]
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment for which to display flow hooks in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets environment details.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the environment in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment{}}
on success{:error, info}
on failure
apigee_organizations_environments_get_datalocation(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_get_datalocation( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DataLocation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Get Google Cloud Storage (GCS) signed url for specific organization and environment. Collection agent uses this signed url to upload data to GCS bucket.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The parent organization and environment names. Must be of the formorganizations/{org}/environments/{env}/datalocation
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:contentType
(type:String.t
) - Content-Type for uploaded file.:dataset
(type:String.t
) - Required. Dataset could be one ofapi
,mint
,trace
andevent
:relativeFilePath
(type:String.t
) - Required. Relative path to the GCS bucket:repo
(type:String.t
) - Required. Repository name
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DataLocation{}}
on success{:error, info}
on failure
apigee_organizations_environments_get_debugmask(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_get_debugmask( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugMask.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the debug mask singleton resource for an Environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the Environment debug mask to get. Must be of the formorganizations/{org}/environments/{env}/debugmask
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugMask{}}
on success{:error, info}
on failure
apigee_organizations_environments_get_deployed_config(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_get_deployed_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EnvironmentConfig.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the deployed configuration for an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the environment deployed configuration resource in the following format:organizations/{org}/environments/{env}/deployedConfig
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EnvironmentConfig{}}
on success{:error, info}
on failure
apigee_organizations_environments_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverresource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:"options.requestedPolicyVersion"
(type:integer()
) - Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.
Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleIamV1Policy{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_aliases_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_aliases_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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. The request must haveContent-Type: multipart/form-data
and include fieldskeyFile
andcertFile
. If uploading to a truststore, omitkeyFile
.pkcs12
- A PKCS12 file is uploaded. The request must haveContent-Type: multipart/form-data
with the file provided in the only field.selfsignedcert
- A new private key and certificate are generated. The request must haveContent-Type: application/json
and a body of CertificateGenerationSpec.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the keystore. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:_password
(type:String.t
) - The password for the private key file, if it exists.:alias
(type:String.t
) - The alias for the key, certificate pair. Values must match regular expression[\w\s-.]{1,255}
. This must be provided for all formats except 'selfsignedcert'; self-signed certs may specify the alias in either this parameter or the JSON body.:format
(type:String.t
) - Required. The format of the data. Must be eitherselfsignedcert
,keycertfile
, orpkcs12
.:ignoreExpiryValidation
(type:boolean()
) - Iftrue
, no expiry validation will be performed.:ignoreNewlineValidation
(type:boolean()
) - Iftrue
, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_aliases_csr(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_aliases_csr( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Generates a PKCS #10 Certificate Signing Request for the private key in an alias.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the alias. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleApiHttpBody{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_aliases_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_aliases_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes an alias.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the alias. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_aliases_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_aliases_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets an alias.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the alias. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_aliases_get_certificate(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_aliases_get_certificate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the certificate from an alias in PEM-encoded form.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the alias. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleApiHttpBody{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_aliases_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_aliases_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all aliases.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the keystore. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_aliases_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_aliases_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the certificate in an alias.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the alias. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:ignoreExpiryValidation
(type:boolean()
) - Required. Iftrue
, no expiry validation will be performed.:ignoreNewlineValidation
(type:boolean()
) - Iftrue
, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Alias{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Keystore.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the environment in which to create the keystore. Must be of the formorganizations/{organization}/environments/{environment}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:name
(type:String.t
) - Optional. Overrides the value in Keystore.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Keystore.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Keystore{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Keystore.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a keystore or truststore.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of keystore to delete. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Keystore{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Keystore.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a keystore or truststore.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of keystore. Must be of the formorganizations/{organization}/environments/{environment}/keystores/{keystore}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Keystore{}}
on success{:error, info}
on failure
apigee_organizations_environments_keystores_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keystores_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all keystores and truststores.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the environment in which list keystores. Must be of the formorganizations/{organization}/environments/{environment}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_keyvaluemaps_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keyvaluemaps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a key value map in an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the environment in which to create the key value map. Must be of the formorganizations/{organization}/environments/{environment}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}}
on success{:error, info}
on failure
apigee_organizations_environments_keyvaluemaps_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keyvaluemaps_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Delete a key value map in an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the key value map. Must be of the formorganizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}}
on success{:error, info}
on failure
apigee_organizations_environments_keyvaluemaps_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_keyvaluemaps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List key value maps in an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the environment in which to list key value maps. Must be of the formorganizations/{organization}/environments/{environment}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all environments in an organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the organization in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_optimized_stats_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_optimized_stats_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OptimizedStats.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The organization and environment name for which the interactive query will be executed. Must be of the formorganizations/{organization_id}/environments/{environment_id/stats/{dimensions}
Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown beloworganizations/{org}/environments/{env}/stats/apiproxy,request_verb
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:accuracy
(type:String.t
) - Legacy field. not used anymore:aggTable
(type:String.t
) - If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.:filter
(type:String.t
) - Enables drill-down on specific dimension values:limit
(type:String.t
) - This parameter is used to limit the number of result items. Default and the max value is 14400:offset
(type:String.t
) - Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.:realtime
(type:boolean()
) - Legacy field: not used anymore:select
(type:String.t
) - Required. The select parameter contains a comma separated list of metrics E.g. sum(message_count),sum(error_count):sonar
(type:boolean()
) - This parameter routes the query to api monitoring service for last hour:sort
(type:String.t
) - This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.:sortby
(type:String.t
) - Comma separated list of columns to sort the final result.:timeRange
(type:String.t
) - Required. Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59:timeUnit
(type:String.t
) - A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.:topk
(type:String.t
) - Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.:tsAscending
(type:boolean()
) - Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.:tzo
(type:String.t
) - This parameters contains the timezone offset value
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OptimizedStats{}}
on success{:error, info}
on failure
apigee_organizations_environments_queries_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_queries_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AsyncQuery.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent organization and environment names. Must be of the formorganizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Query.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AsyncQuery{}}
on success{:error, info}
on failure
apigee_organizations_environments_queries_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_queries_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AsyncQuery.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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"
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the asynchronous query to get. Must be of the formorganizations/{org}/environments/{env}/queries/{queryId}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AsyncQuery{}}
on success{:error, info}
on failure
apigee_organizations_environments_queries_get_result(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_queries_get_result( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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-
Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the asynchronous query result to get. Must be of the formorganizations/{org}/environments/{env}/queries/{queryId}/result
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleApiHttpBody{}}
on success{:error, info}
on failure
apigee_organizations_environments_queries_get_result_view(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_queries_get_result_view( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AsyncQueryResultView.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the asynchronous query result view to get. Must be of the formorganizations/{org}/environments/{env}/queries/{queryId}/resultView
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AsyncQueryResultView{}}
on success{:error, info}
on failure
apigee_organizations_environments_queries_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_queries_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAsyncQueriesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Return a list of Asynchronous Queries
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent organization and environment names. Must be of the formorganizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:dataset
(type:String.t
) - Filter response list by dataset.Example:
api
,mint
:from
(type:String.t
) - Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.:inclQueriesWithoutReport
(type:String.t
) - Flag to include asynchronous queries that don't have a report denifition.:status
(type:String.t
) - Filter response list by asynchronous query status:submittedBy
(type:String.t
) - Filter response list by user who submitted queries:to
(type:String.t
) - Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAsyncQueriesResponse{}}
on success{:error, info}
on failure
apigee_organizations_environments_references_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_references_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a Reference in the specified environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent environment name under which the Reference will be created. Must be of the formorganizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference{}}
on success{:error, info}
on failure
apigee_organizations_environments_references_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_references_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a Reference from an environment. Returns the deleted Reference resource.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the Reference to delete. Must be of the formorganizations/{org}/environments/{env}/references/{ref}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference{}}
on success{:error, info}
on failure
apigee_organizations_environments_references_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_references_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a Reference resource.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the Reference to get. Must be of the formorganizations/{org}/environments/{env}/references/{ref}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference{}}
on success{:error, info}
on failure
apigee_organizations_environments_references_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_references_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all References in an environment as a JSON array.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent environment name. Must be of the formorganizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_references_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_references_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the Reference to update. Must be of the formorganizations/{org}/environments/{env}/references/{ref}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Reference{}}
on success{:error, info}
on failure
apigee_organizations_environments_resourcefiles_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_resourcefiles_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceFile.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment in which to create the resource file in the following format:organizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:name
(type:String.t
) - Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&{}[]()+-=,.~'` ]{1,255}:type
(type:String.t
) - Required. Resource file type. {{ resource_file_type }}:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceFile{}}
on success{:error, info}
on failure
apigee_organizations_environments_resourcefiles_delete(connection, parent, type, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_resourcefiles_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceFile.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a resource file.
For more information about resource files, see Resource files.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment in the following format:organizations/{org}/environments/{env}
.type
(type:String.t
) - Required. Resource file type. {{ resource_file_type }}name
(type:String.t
) - Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&{}[]()+-=,.~'` ]{1,255}optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceFile{}}
on success{:error, info}
on failure
apigee_organizations_environments_resourcefiles_get(connection, parent, type, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_resourcefiles_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the contents of a resource file.
For more information about resource files, see Resource files.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment in the following format:organizations/{org}/environments/{env}
.type
(type:String.t
) - Required. Resource file type. {{ resource_file_type }}name
(type:String.t
) - Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&{}[]()+-=,.~'` ]{1,255}optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleApiHttpBody{}}
on success{:error, info}
on failure
apigee_organizations_environments_resourcefiles_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_resourcefiles_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListEnvironmentResourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all resource files.
For more information about resource files, see Resource files.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment in which to list resource files in the following format:organizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:type
(type:String.t
) - Optional. Type of resource files to list. {{ resource_file_type }}
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListEnvironmentResourcesResponse{}}
on success{:error, info}
on failure
apigee_organizations_environments_resourcefiles_list_environment_resources(connection, parent, type, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_resourcefiles_list_environment_resources( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListEnvironmentResourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all resource files.
For more information about resource files, see Resource files.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment in which to list resource files in the following format:organizations/{org}/environments/{env}
.type
(type:String.t
) - Optional. Type of resource files to list. {{ resource_file_type }}optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListEnvironmentResourcesResponse{}}
on success{:error, info}
on failure
apigee_organizations_environments_resourcefiles_update(connection, parent, type, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_resourcefiles_update( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceFile.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment in the following format:organizations/{org}/environments/{env}
.type
(type:String.t
) - Required. Resource file type. {{ resource_file_type }}name
(type:String.t
) - Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&{}[]()+-=,.~'` ]{1,255}optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceFile{}}
on success{:error, info}
on failure
apigee_organizations_environments_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverresource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleIamV1SetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleIamV1Policy{}}
on success{:error, info}
on failure
apigee_organizations_environments_stats_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_stats_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Stats.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The organization and environment name for which the interactive query will be executed. Must be of the formorganizations/{organization_id}/environments/{environment_id/stats/{dimensions}
Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown beloworganizations/{org}/environments/{env}/stats/apiproxy,request_verb
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:accuracy
(type:String.t
) - Legacy field. not used anymore This field is present to support UI calls which still use this parameter:aggTable
(type:String.t
) - If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.:filter
(type:String.t
) - Enables drill-down on specific dimension values:limit
(type:String.t
) - This parameter is used to limit the number of result items. Default and the max value is 14400:offset
(type:String.t
) - Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.:realtime
(type:boolean()
) - Legacy field: not used anymore:select
(type:String.t
) - The select parameter contains a comma separated list of metrics E.g. sum(message_count),sum(error_count):sonar
(type:boolean()
) - This parameter routes the query to api monitoring service for last hour:sort
(type:String.t
) - This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.:sortby
(type:String.t
) - Comma separated list of columns to sort the final result.:timeRange
(type:String.t
) - Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59:timeUnit
(type:String.t
) - A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.:topk
(type:String.t
) - Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.:tsAscending
(type:boolean()
) - Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.:tzo
(type:String.t
) - This parameters contains the timezone offset value
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Stats{}}
on success{:error, info}
on failure
apigee_organizations_environments_subscribe(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_subscribe( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Subscription.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment to subscribe in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Subscription{}}
on success{:error, info}
on failure
apigee_organizations_environments_targetservers_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_targetservers_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a TargetServer in the specified environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent environment name under which the TargetServer will be created. Must be of the formorganizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:name
(type:String.t
) - Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer{}}
on success{:error, info}
on failure
apigee_organizations_environments_targetservers_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_targetservers_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the TargetServer to delete. Must be of the formorganizations/{org}/environments/{env}/targetservers/{target_server_id}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer{}}
on success{:error, info}
on failure
apigee_organizations_environments_targetservers_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_targetservers_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a TargetServer resource.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the TargetServer to get. Must be of the formorganizations/{org}/environments/{env}/targetservers/{target_server_id}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer{}}
on success{:error, info}
on failure
apigee_organizations_environments_targetservers_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_targetservers_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all TargetServers in an environment as a JSON array.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent environment name. Must be of the formorganizations/{org}/environments/{env}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_environments_targetservers_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_targetservers_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the TargetServer to replace. Must be of the formorganizations/{org}/environments/{env}/targetservers/{target_server_id}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServer{}}
on success{:error, info}
on failure
apigee_organizations_environments_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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).
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverresource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleIamV1TestIamPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}
on success{:error, info}
on failure
apigee_organizations_environments_unsubscribe(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_unsubscribe( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a subscription for the environment's Pub/Sub topic.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the environment to subscribe in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Subscription.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_environments_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the environment to update in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment{}}
on success{:error, info}
on failure
apigee_organizations_environments_update_debugmask(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_update_debugmask( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugMask.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the debug mask singleton resource for an environment.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - The DebugMask resource name.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:replaceRepeatedFields
(type:boolean()
) - If true, repeated fields covered by the update_mask will replace the existing values. The default behavior is to append.:updateMask
(type:String.t
) - Field mask to support partial updates.:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugMask.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugMask{}}
on success{:error, info}
on failure
apigee_organizations_environments_update_environment(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_environments_update_environment( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the environment to update in the following format:organizations/{org}/environments/{env}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Environment{}}
on success{:error, info}
on failure
apigee_organizations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Organization.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the profile for an Apigee organization. See Organizations.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Apigee organization name in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Organization{}}
on success{:error, info}
on failure
apigee_organizations_get_metrics(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_get_metrics( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Metrics.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets metrics for an organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Metrics{}}
on success{:error, info}
on failure
apigee_organizations_get_sites(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_get_sites( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SiteListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists details for all portals.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:domain
(type:String.t
) -:zmsId
(type:String.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SiteListResponse{}}
on success{:error, info}
on failure
apigee_organizations_get_sync_authorization(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_get_sync_authorization( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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 Enable Synchronizer access.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GetSyncAuthorizationRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization{}}
on success{:error, info}
on failure
apigee_organizations_get_system(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_get_system( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SystemState.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the current state of the portal application.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SystemState{}}
on success{:error, info}
on failure
apigee_organizations_keyvaluemaps_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_keyvaluemaps_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a key value map in an organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the organization in which to create the key value map file. Must be of the formorganizations/{organization}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}}
on success{:error, info}
on failure
apigee_organizations_keyvaluemaps_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_keyvaluemaps_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Delete a key value map in an organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The name of the key value map. Must be of the formorganizations/{organization}/keyvaluemaps/{keyvaluemap}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}}
on success{:error, info}
on failure
apigee_organizations_keyvaluemaps_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_keyvaluemaps_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, String.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List key value maps in an organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The name of the organization in which to list key value maps. Must be of the formorganizations/{organization}
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
apigee_organizations_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListOrganizationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the Apigee organizations and associated GCP projects that you have permission to access. See Organizations.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Apigee organization name in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListOrganizationsResponse{}}
on success{:error, info}
on failure
apigee_organizations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation resource to be cancelled.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleLongrunningCancelOperationRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_operations_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_operations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation resource to be deleted.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}}
on success{:error, info}
on failure
apigee_organizations_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation resource.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation{}}
on success{:error, info}
on failure
apigee_organizations_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleLongrunningListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation's parent resource.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:filter
(type:String.t
) - The standard list filter.:pageSize
(type:integer()
) - The standard list page size.:pageToken
(type:String.t
) - The standard list page token.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleLongrunningListOperationsResponse{}}
on success{:error, info}
on failure
apigee_organizations_portals_get_status(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_portals_get_status( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ServerStatus.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a health check from the server.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ServerStatus{}}
on success{:error, info}
on failure
apigee_organizations_providers_clear_scope(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_providers_clear_scope( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Clears the scope of an identity provider. Not a recognized rest pattern
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the identity provider. Use the following structure in your request:organizations/{org}/providers/{provider}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_providers_resources_create_resource(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_providers_resources_create_resource( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a resource ID for the resource path. Not a recognized rest pattern
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the resource. Use the following structure in your request:organizations/{org}/providers/{provider}/resources/{resource}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse{}}
on success{:error, info}
on failure
apigee_organizations_providers_resources_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_providers_resources_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a resource.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the resource. Use the following structure in your request:organizations/{org}/providers/{provider}/resources/{resource}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_providers_users_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_providers_users_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a user.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the user. Use the following structure in your request:organizations/{org}/providers/{provider}/users/{user}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse{}}
on success{:error, info}
on failure
apigee_organizations_providers_users_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_providers_users_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUserResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves a user.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the user. Use the following structure in your request:organizations/{org}/providers/{provider}/users/{user}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUserResponse{}}
on success{:error, info}
on failure
apigee_organizations_providers_users_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_providers_users_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUserListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all users.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the identity provider. Use the following structure in your request:organizations/{org}/providers/{provider}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:count
(type:String.t
) - Number of items.:filter
(type:String.t
) - String used to filter the list.:sortBy
(type:String.t
) - Field on which to sort the list.:sortOrder
(type:String.t
) - Order in which to sort the list, such as ascending or descending.:startIndex
(type:String.t
) - Starting index of the list.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUserListResponse{}}
on success{:error, info}
on failure
apigee_organizations_providers_users_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_providers_users_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUserResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a user.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the user. Use the following structure in your request:organizations/{org}/providers/{provider}/users/{user}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUser.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUserResponse{}}
on success{:error, info}
on failure
apigee_organizations_reports_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_reports_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent organization name under which the Custom Report will be created. Must be of the form:organizations/{organization_id}/reports
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport{}}
on success{:error, info}
on failure
apigee_organizations_reports_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_reports_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeleteCustomReportResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes an existing custom report definition
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Custom Report name of the form:organizations/{organization_id}/reports/{report_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeleteCustomReportResponse{}}
on success{:error, info}
on failure
apigee_organizations_reports_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_reports_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieve a custom report definition.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Custom Report name of the form:organizations/{organization_id}/reports/{report_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport{}}
on success{:error, info}
on failure
apigee_organizations_reports_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_reports_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListCustomReportsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Return a list of Custom Reports
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent organization name under which the API product will be listedorganizations/{organization_id}/reports
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:expand
(type:boolean()
) - Set to 'true' to get expanded details about each custom report.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListCustomReportsResponse{}}
on success{:error, info}
on failure
apigee_organizations_reports_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_reports_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Update an existing custom report definition
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Custom Report name of the form:organizations/{organization_id}/reports/{report_name}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReport{}}
on success{:error, info}
on failure
apigee_organizations_set_sync_authorization(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_set_sync_authorization( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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 Enable Synchronizer access.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Publishes an API to the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDocBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Removes a published API from the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. ID of the published API. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_delete_snapshot(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_delete_snapshot( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Removes the current OpenAPI Specification snapshot from the published API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. ID of the published API. Must be of the formorganizations/{org}/sites/{site}/apidocs/{apidoc}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the details for a published API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. ID of the published API. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiDocsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the details for all published APIs.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiDocsResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_list_publishable_products(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_list_publishable_products( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListPublishableProductsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the APIs that can be published to the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs:listPublishableProducts
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListPublishableProductsResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_snapshot(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_snapshot( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Uploads the contents of an OpenAPI Specification snapshot for a published API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. ID of the published API. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc{}}
on success{:error, info}
on failure
apigee_organizations_sites_apidocs_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_apidocs_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the details or specification for a published API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. ID of the published API. Use the following structure in your request:organizations/{org}/sites/{site}/apidocs/{apidoc}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDocBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDoc{}}
on success{:error, info}
on failure
apigee_organizations_sites_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a new portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SiteData.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site{}}
on success{:error, info}
on failure
apigee_organizations_sites_customcss_get_editorschema(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_customcss_get_editorschema( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EditorSchema.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the information required for the theme editor.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name for the custom CSS. Use the following structure in your request:organizations/{org}/sites/customcss
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EditorSchema{}}
on success{:error, info}
on failure
apigee_organizations_sites_customcss_publish(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_customcss_publish( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Publishes the custom CSS for a portal
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name for the custom CSS. Use the following structure in your request:organizations/{org}/sites/customcss
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_dns_check(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_dns_check( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DomainVerifiedResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Checks DNS to verify that a domain has the expected canonical name (CNAME) record.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DnsCnameCheck.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DomainVerifiedResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_drafttoken_verify(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_drafttoken_verify( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Verifies a draft token for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1VerifyDraftTokenPayload.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_email_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_email_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EmailTemplate.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets an email template for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the email template. Use the following structure in your request:organizations/{org}/sites/{site}/email/{email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EmailTemplate{}}
on success{:error, info}
on failure
apigee_organizations_sites_email_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_email_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EmailTemplate.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an email template for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the email template. Use the following structure in your request:organizations/{org}/sites/{site}/email/{email}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EmailTemplateBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EmailTemplate{}}
on success{:error, info}
on failure
apigee_organizations_sites_file_delete(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_file_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a file from the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1FilenamePayload.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_file_list_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_file_list_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListFilesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all files stored on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListFilesResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_file_post(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_file_post( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1File.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Uploads a file to the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1File{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_audiencesenabled(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_audiencesenabled( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAudienceEnabledResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves the audience feature flag setting for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAudienceEnabledResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_config(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalConfigResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the portal configuration.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalConfigResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_customcss(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_customcss( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomCss.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the custom CSS for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomCss{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_drafttoken(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_drafttoken( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the draft token for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_keystores(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_keystores( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeystoreSetResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the keystores and certs that are available for TLS configuration.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeystoreSetResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_orgtype(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_orgtype( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the organization type for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_portal(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_portal( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the details for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_publishedapis(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_publishedapis( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PublishedApisPageResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all published APIs.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:filter
(type:String.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PublishedApisPageResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_get_smtp(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_get_smtp( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SmtpConfigResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the SMTP configuration for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SmtpConfigResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_content(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_content( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the draft content of a page on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the page. Use the following structure in your request:organizations/{org}/sites/{site}/pages/{page}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageContentPayload.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Page.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a new page on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Page{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a page from the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the page. Use the following structure in your request:organizations/{org}/sites/{site}/pages/{page}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Page.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a page on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the page. Use the following structure in your request:organizations/{org}/sites/{site}/pages/{page}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Page{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListPagesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the pages on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListPagesResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_publish(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_publish( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Publishes a page on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the page. Use the following structure in your request:organizations/{org}/sites/{site}/pages/{page}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_unpublish(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_unpublish( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Unpublishes a page on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the page. Use the following structure in your request:organizations/{org}/sites/{site}/pages/{page}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_pages_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_pages_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Page.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a page on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the page. Use the following structure in your request:organizations/{org}/sites/{site}/pages/{page}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageBody.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Page{}}
on success{:error, info}
on failure
apigee_organizations_sites_render(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_render( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageContentResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the title and contents of the page on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:draft
(type:String.t
) -:pageId
(type:String.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageContentResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_resource_entitlements_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_resource_entitlements_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceEntitlement.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the resource audience entitlements.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the resource. Use the following structure in your request:organizations/{org}/sites/{site}/resource-entitlements/{resourceType}/{resource}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceEntitlement{}}
on success{:error, info}
on failure
apigee_organizations_sites_resource_entitlements_update_resource_entitlement(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_resource_entitlements_update_resource_entitlement( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceEntitlement.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates audience entitlements for a resource. Not a recognized rest pattern
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the resource. Use the following structure in your request:organizations/{org}/sites/{site}/resource-entitlements/{resourceType}/{resource}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceEntitlementData.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceEntitlement{}}
on success{:error, info}
on failure
apigee_organizations_sites_send_test_email(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_send_test_email( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Sends a test email using the email template.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SendTestEmailPayload.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_analytics(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_analytics( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the custom analytics script for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AnalyticsUpdatePayload.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_approved_emails(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_approved_emails( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Restricts portal registration by identifying the individual email addresses or email domains that can create accounts on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApprovedEmailsPayload.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_clone(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_clone( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Clones an existing portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SiteData.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_defaultanonallowed(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_defaultanonallowed( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Sets the default visibility to all users (public), using the
defaultAnonAllowed
flag, for pages and API products that are published
on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DefaultAnonAllowed.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_domains(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_domains( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomDomainConfig.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Enables or updates the custom domain for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomDomainConfigData.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomDomainConfig{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_get_defaultanonallowed(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_get_defaultanonallowed( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the defaultAnonAllowed
flag setting for a portal. This flag
defines the default visibility for pages and API products that are
published on the portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1StringResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_get_domains(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_get_domains( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomDomainConfig.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the custom domain configuration for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomDomainConfig{}}
on success{:error, info}
on failure
apigee_organizations_sites_site_key(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_site_key( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Regenerates the secret key for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_smtp_reset(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_smtp_reset( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Resets the default settings for the SMTP configuration for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_specs_list_proxy_specs(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_specs_list_proxy_specs( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListProxySpecsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists details for the OpenAPI Specifications associated with an API.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the API. Use the following structure in your request:organizations/{org}sites/{site}/specs/{api}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListProxySpecsResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_trash(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_trash( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_sites_update_customcss(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_update_customcss( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomCss.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the custom CSS for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateCustomCssRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomCss{}}
on success{:error, info}
on failure
apigee_organizations_sites_update_portal(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_update_portal( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SiteData.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Site{}}
on success{:error, info}
on failure
apigee_organizations_sites_update_smtp(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_update_smtp( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SmtpConfigResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the SMTP configuration for a portal.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SmtpConfig.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SmtpConfigResponse{}}
on success{:error, info}
on failure
apigee_organizations_sites_zones_associate_site_zone(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_sites_zones_associate_site_zone( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Associates a portal with a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_system_get_announcements(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_system_get_announcements( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Announcement.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets any cross-organizational announcement that you want to display to customers on the UI.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Announcement{}}
on success{:error, info}
on failure
apigee_organizations_teams_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_teams_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListEdgeTeamsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all teams a user can access.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListEdgeTeamsResponse{}}
on success{:error, info}
on failure
apigee_organizations_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Organization.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Apigee organization name in the following format:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Organization.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Organization{}}
on success{:error, info}
on failure
apigee_organizations_zone_audiencesenabled_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zone_audiencesenabled_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAudiencesEnabledForZonesInOrgResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all zones in an Apigee organization with the audience feature enabled.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAudiencesEnabledForZonesInOrgResponse{}}
on success{:error, info}
on failure
apigee_organizations_zone_enableaudiences(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zone_enableaudiences( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Enables the audience feature in a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_zone_get_audiencesenabled(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zone_get_audiencesenabled( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAudienceEnabledResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves the audience feature flag setting for a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAudienceEnabledResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_certificate(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_certificate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1VerifyCertificateResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Validates a certificate in a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1VerifyCertificateRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1VerifyCertificateResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GetZoneResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GetZoneResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_identity_providers_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_identity_providers_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CreateIdentityProviderResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates an identity provider in a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1IdentityProvider.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CreateIdentityProviderResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_identity_providers_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_identity_providers_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GetIdentityProviderResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets an identity provider in a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the identity provider. Use the following structure in your request:organizations/{org}/zones/{zone}/identity_providers/{identity_provider}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GetIdentityProviderResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_identity_providers_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_identity_providers_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListIdentityProvidersResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the identity providers in a zone. Underscore in URL
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListIdentityProvidersResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_identity_providers_patch(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_identity_providers_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateIdentityProviderResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an identity provider in a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the identity provider. Use the following structure in your request:organizations/{org}/zones/{zone}/identity_providers/{identity_provider}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1IdentityProvider.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateIdentityProviderResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_identity_providers_update_certificate(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_identity_providers_update_certificate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateIdentityProviderCertificateResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the certificate for an identity provider.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the identity provider. Use the following structure in your request:organizations/{org}/zones/{zone}/identity_providers/{identity_provider}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SamlCertificate.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateIdentityProviderCertificateResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_identity_providers_update_config(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_identity_providers_update_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateIdentityProviderConfigResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates the configuration for an identity provider.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the identity provider. Use the following structure in your request:organizations/{org}/zones/{zone}/identity_providers/{identity_provider}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1IdentityProviderConfig.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateIdentityProviderConfigResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListZonesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the zones for an Apigee organization.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name for the Apigee organization. Use the following structure in your request:organizations/{org}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListZonesResponse{}}
on success{:error, info}
on failure
apigee_organizations_zones_testemail(connection, parent, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_testemail( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Note: This feature is not available to Apigee hybrid at this time.
Sends a test email to verify the SMTP settings for an identity provider. Sends the email to the requester's email using the token.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TestEmail.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiResponseWrapper{}}
on success{:error, info}
on failure
apigee_organizations_zones_update(connection, name, optional_params \\ [], opts \\ [])
View Sourceapigee_organizations_zones_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateZoneResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a zone.
Parameters
connection
(type:GoogleApi.Apigee.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Name of the zone. Use the following structure in your request:organizations/{org}/zones/{zone}
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Zone.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateZoneResponse{}}
on success{:error, info}
on failure