Documentation

Google_Service_Storage_Resource_Notifications extends Google_Service_Resource
in package

The "notifications" collection of methods.

Typical usage is: $storageService = new Google_Service_Storage(...); $notifications = $storageService->notifications;

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.
delete()  : mixed
Permanently deletes a notification subscription. (notifications.delete)
get()  : Google_Service_Storage_Notification
View a notification configuration. (notifications.get)
insert()  : Google_Service_Storage_Notification
Creates a notification subscription for a given bucket.
listNotifications()  : Google_Service_Storage_Notifications
Retrieves a list of notification subscriptions for a given bucket.
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

delete()

Permanently deletes a notification subscription. (notifications.delete)

public delete(string $bucket, string $notification[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$bucket : string

The parent bucket of the notification.

$notification : string

ID of the notification to delete.

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

Optional parameters.

Tags
opt_param

string provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket.

opt_param

string userProject The project to be billed for this request. Required for Requester Pays buckets.

Return values
mixed

get()

View a notification configuration. (notifications.get)

public get(string $bucket, string $notification[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_Notification
Parameters
$bucket : string

The parent bucket of the notification.

$notification : string

Notification ID

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

Optional parameters.

Tags
opt_param

string provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket.

opt_param

string userProject The project to be billed for this request. Required for Requester Pays buckets.

Return values
Google_Service_Storage_Notification

insert()

Creates a notification subscription for a given bucket.

public insert(string $bucket, Google_Service_Storage_Notification $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_Notification

(notifications.insert)

Parameters
$bucket : string

The parent bucket of the notification.

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

Optional parameters.

Tags
opt_param

string provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket.

opt_param

string userProject The project to be billed for this request. Required for Requester Pays buckets.

Return values
Google_Service_Storage_Notification

listNotifications()

Retrieves a list of notification subscriptions for a given bucket.

public listNotifications(string $bucket[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_Notifications

(notifications.listNotifications)

Parameters
$bucket : string

Name of a Google Cloud Storage bucket.

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

Optional parameters.

Tags
opt_param

string provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket.

opt_param

string userProject The project to be billed for this request. Required for Requester Pays buckets.

Return values
Google_Service_Storage_Notifications

convertToArrayAndStripNulls()

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

Search results