GoogleApi.Apigee.V1.Api.Organizations.apigee_organizations_apiproducts_list

You're seeing just the function apigee_organizations_apiproducts_list, go back to GoogleApi.Apigee.V1.Api.Organizations module for more information.
Link to this function

apigee_organizations_apiproducts_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

apigee_organizations_apiproducts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProductsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 server
  • parent (type: String.t) - Required. Name of the 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").
    • :attributename (type: String.t) - Name of the attribute used to filter the search.
    • :attributevalue (type: String.t) - Value of the attribute used to filter the search.
    • :count (type: String.t) - Enter the number of API products you want returned in the API call. The limit is 1000.
    • :expand (type: boolean()) - Flag that specifies whether to expand the results. Set to true 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 the count query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using startKey). Product name is case sensitive.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProductsResponse{}} on success
  • {:error, info} on failure