Documentation

Google_Service_Storage_Resource_DefaultObjectAccessControls extends Google_Service_Resource
in package

The "defaultObjectAccessControls" collection of methods.

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

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 the default object ACL entry for the specified entity on the specified bucket. (defaultObjectAccessControls.delete)
get()  : Google_Service_Storage_ObjectAccessControl
Returns the default object ACL entry for the specified entity on the specified bucket. (defaultObjectAccessControls.get)
insert()  : Google_Service_Storage_ObjectAccessControl
Creates a new default object ACL entry on the specified bucket.
listDefaultObjectAccessControls()  : Google_Service_Storage_ObjectAccessControls
Retrieves default object ACL entries on the specified bucket.
patch()  : Google_Service_Storage_ObjectAccessControl
Patches a default object ACL entry on the specified bucket.
update()  : Google_Service_Storage_ObjectAccessControl
Updates a default object ACL entry on the specified 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 the default object ACL entry for the specified entity on the specified bucket. (defaultObjectAccessControls.delete)

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

Name of a bucket.

$entity : string

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

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

Returns the default object ACL entry for the specified entity on the specified bucket. (defaultObjectAccessControls.get)

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

Name of a bucket.

$entity : string

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

$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_ObjectAccessControl

insert()

Creates a new default object ACL entry on the specified bucket.

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

(defaultObjectAccessControls.insert)

Parameters
$bucket : string

Name of a bucket.

$postBody : Google_Service_Storage_ObjectAccessControl
$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_ObjectAccessControl

listDefaultObjectAccessControls()

Retrieves default object ACL entries on the specified bucket.

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

(defaultObjectAccessControls.listDefaultObjectAccessControls)

Parameters
$bucket : string

Name of a bucket.

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

Optional parameters.

Tags
opt_param

string ifMetagenerationMatch If present, only return default ACL listing if the bucket's current metageneration matches this value.

opt_param

string ifMetagenerationNotMatch If present, only return default ACL listing if the bucket's current metageneration does not match the given value.

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_ObjectAccessControls

patch()

Patches a default object ACL entry on the specified bucket.

public patch(string $bucket, string $entity, Google_Service_Storage_ObjectAccessControl $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_ObjectAccessControl

(defaultObjectAccessControls.patch)

Parameters
$bucket : string

Name of a bucket.

$entity : string

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

$postBody : Google_Service_Storage_ObjectAccessControl
$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_ObjectAccessControl

update()

Updates a default object ACL entry on the specified bucket.

public update(string $bucket, string $entity, Google_Service_Storage_ObjectAccessControl $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_ObjectAccessControl

(defaultObjectAccessControls.update)

Parameters
$bucket : string

Name of a bucket.

$entity : string

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

$postBody : Google_Service_Storage_ObjectAccessControl
$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_ObjectAccessControl

convertToArrayAndStripNulls()

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

Search results