Documentation

Google_Service_PubsubLite_Resource_AdminProjectsLocationsSubscriptions extends Google_Service_Resource
in package

Application

The "subscriptions" collection of methods.

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

$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.
create() : Google_Service_PubsubLite_Subscription: Creates a new subscription. (subscriptions.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_PubsubLite_PubsubliteEmpty: Deletes the specified subscription. (subscriptions.delete)
get() : Google_Service_PubsubLite_Subscription: Returns the subscription configuration. (subscriptions.get)
listAdminProjectsLocationsSubscriptions() : Google_Service_PubsubLite_ListSubscriptionsResponse: Returns the list of subscriptions for the given project.
patch() : Google_Service_PubsubLite_Subscription: Updates properties of the specified subscription. (subscriptions.patch)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a new subscription. (subscriptions.create)


    public
                create(string $parent, Google_Service_PubsubLite_Subscription $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PubsubLite_Subscription

Parameters

$parent : string: Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.
$postBody : Google_Service_PubsubLite_Subscription
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PubsubLite_Subscription —

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>

Return values

string —

$requestUrl

delete()

Deletes the specified subscription. (subscriptions.delete)


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

Parameters

$name : string: Required. The name of the subscription to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PubsubLite_PubsubliteEmpty —

get()

Returns the subscription configuration. (subscriptions.get)


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

Parameters

$name : string: Required. The name of the subscription whose configuration to return.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PubsubLite_Subscription —

listAdminProjectsLocationsSubscriptions()

Returns the list of subscriptions for the given project.


    public
                listAdminProjectsLocationsSubscriptions(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PubsubLite_ListSubscriptionsResponse

(subscriptions.listAdminProjectsLocationsSubscriptions)

Parameters

$parent : string: Required. The parent whose subscriptions are to be listed. Structured like projects/{project_number}/locations/{location}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PubsubLite_ListSubscriptionsResponse —

patch()

Updates properties of the specified subscription. (subscriptions.patch)


    public
                patch(string $name, Google_Service_PubsubLite_Subscription $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PubsubLite_Subscription

Parameters

$name : string: The name of the subscription. Structured like: projects/{ project_number}/locations/{location}/subscriptions/{subscription_id}
$postBody : Google_Service_PubsubLite_Subscription
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PubsubLite_Subscription —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —