Cloud Channel API . integrators

Instance Methods

close()

Close httplib2 connections.

listSubscribers(integrator, account=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

listSubscribers_next()

Retrieves the next page of results.

registerSubscriber(integrator, body=None, x__xgafv=None)

Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

unregisterSubscriber(integrator, body=None, x__xgafv=None)

Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Method Details

close()
Close httplib2 connections.
listSubscribers(integrator, account=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

Args:
  integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
  account: string, Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
  pageSize: integer, Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.
  pageToken: string, Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` 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 Message for ListSubscribers.
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "serviceAccounts": [ # List of service accounts which have subscriber access to the topic.
    "A String",
  ],
  "topic": "A String", # Name of the topic registered with the reseller.
}
listSubscribers_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.
        
registerSubscriber(integrator, body=None, x__xgafv=None)
Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

Args:
  integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request Message for RegisterSubscriber.
  "account": "A String", # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
  "integrator": "A String", # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
  "serviceAccount": "A String", # Required. Service account that provides subscriber access to the registered topic.
}

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

Returns:
  An object of the form:

    { # Response Message for RegisterSubscriber.
  "topic": "A String", # Name of the topic the subscriber will listen to.
}
unregisterSubscriber(integrator, body=None, x__xgafv=None)
Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Args:
  integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request Message for UnregisterSubscriber.
  "account": "A String", # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
  "integrator": "A String", # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
  "serviceAccount": "A String", # Required. Service account to unregister from subscriber access to the topic.
}

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

Returns:
  An object of the form:

    { # Response Message for UnregisterSubscriber.
  "topic": "A String", # Name of the topic the service account subscriber access was removed from.
}