Apigee API . organizations . appgroups . subscriptions

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a subscription to an API product.

expire(name, body=None, x__xgafv=None)

Expires an API product subscription immediately.

get(name, x__xgafv=None)

Get an api product subscription for an appgroup.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

List all api product subscriptions for an appgroup.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a subscription to an API product. 

Args:
  parent: string, Required. Name of the appgroup that is purchasing a subscription to the API product. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}` (required)
  body: object, The request body.
    The object takes the form of:

{ # AppGroup Subscription details.
  "apiproduct": "A String", # Required. Name of the API product for which the appgroup is purchasing a subscription.
  "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch.
  "endTime": "A String", # Output only. Time when the API product subscription ends in milliseconds since epoch.
  "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch.
  "name": "A String", # Output only. Name of the API product subscription.
  "startTime": "A String", # Output only. Time when the API product subscription starts in milliseconds since epoch.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroup Subscription details.
  "apiproduct": "A String", # Required. Name of the API product for which the appgroup is purchasing a subscription.
  "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch.
  "endTime": "A String", # Output only. Time when the API product subscription ends in milliseconds since epoch.
  "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch.
  "name": "A String", # Output only. Name of the API product subscription.
  "startTime": "A String", # Output only. Time when the API product subscription starts in milliseconds since epoch.
}
expire(name, body=None, x__xgafv=None)
Expires an API product subscription immediately.

Args:
  name: string, Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}/subscriptions/{subscription}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for ExpireAppGroupSubscription.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroup Subscription details.
  "apiproduct": "A String", # Required. Name of the API product for which the appgroup is purchasing a subscription.
  "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch.
  "endTime": "A String", # Output only. Time when the API product subscription ends in milliseconds since epoch.
  "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch.
  "name": "A String", # Output only. Name of the API product subscription.
  "startTime": "A String", # Output only. Time when the API product subscription starts in milliseconds since epoch.
}
get(name, x__xgafv=None)
Get an api product subscription for an appgroup.

Args:
  name: string, Required. The name of the AppGroupSubscription to retrieve. Format: `organizations/{org}/appgroups/{appgroup}/subscriptions/{subscription}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroup Subscription details.
  "apiproduct": "A String", # Required. Name of the API product for which the appgroup is purchasing a subscription.
  "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch.
  "endTime": "A String", # Output only. Time when the API product subscription ends in milliseconds since epoch.
  "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch.
  "name": "A String", # Output only. Name of the API product subscription.
  "startTime": "A String", # Output only. Time when the API product subscription starts in milliseconds since epoch.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all api product subscriptions for an appgroup.

Args:
  parent: string, Required. Name of the appgroup. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}` (required)
  pageSize: integer, Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 100 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListAppGroupSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAppGroupSubscriptions` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListAppGroupSubscriptions.
  "appGroupSubscriptions": [ # The list of subscriptions for an AppGroup.
    { # AppGroup Subscription details.
      "apiproduct": "A String", # Required. Name of the API product for which the appgroup is purchasing a subscription.
      "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch.
      "endTime": "A String", # Output only. Time when the API product subscription ends in milliseconds since epoch.
      "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch.
      "name": "A String", # Output only. Name of the API product subscription.
      "startTime": "A String", # Output only. Time when the API product subscription starts in milliseconds since epoch.
    },
  ],
  "nextPageToken": "A String", # Value that can be sent as `pageToken` to retrieve the next page of content. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.