Documentation

Google_Service_PubsubLite_Resource_AdminProjectsLocationsTopicsSubscriptions extends Google_Service_Resource
in package

The "subscriptions" collection of methods.

Typical usage is: $pubsubliteService = new Google_Service_PubsubLite(...); $subscriptions = $pubsubliteService->subscriptions;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listAdminProjectsLocationsTopicsSubscriptions()  : Google_Service_PubsubLite_ListTopicSubscriptionsResponse
Lists the subscriptions attached to the specified topic.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

listAdminProjectsLocationsTopicsSubscriptions()

Lists the subscriptions attached to the specified topic.

public listAdminProjectsLocationsTopicsSubscriptions(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PubsubLite_ListTopicSubscriptionsResponse

(subscriptions.listAdminProjectsLocationsTopicsSubscriptions)

Parameters
$name : string

Required. The name of the topic whose subscriptions to list.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.

opt_param

string pageToken A page token, received from a previous ListTopicSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopicSubscriptions must match the call that provided the page token.

Return values
Google_Service_PubsubLite_ListTopicSubscriptionsResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results