Documentation

Google_Service_AccessContextManager_Resource_AccessPoliciesAccessLevels extends Google_Service_Resource
in package

The "accessLevels" collection of methods.

Typical usage is: $accesscontextmanagerService = new Google_Service_AccessContextManager(...); $accessLevels = $accesscontextmanagerService->accessLevels;

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.
create()  : Google_Service_AccessContextManager_Operation
Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. (accessLevels.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_AccessContextManager_Operation
Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage. (accessLevels.delete)
get()  : Google_Service_AccessContextManager_AccessLevel
Get an Access Level by resource name. (accessLevels.get)
listAccessPoliciesAccessLevels()  : Google_Service_AccessContextManager_ListAccessLevelsResponse
List all Access Levels for an access policy.
patch()  : Google_Service_AccessContextManager_Operation
Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. (accessLevels.patch)
replaceAll()  : Google_Service_AccessContextManager_Operation
Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long- lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error. (accessLevels.replaceAll)
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

create()

Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. (accessLevels.create)

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

Required. Resource name for the access policy which owns this Access Level. Format: accessPolicies/{policy_id}

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

Optional parameters.

Return values
Google_Service_AccessContextManager_Operation

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

Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage. (accessLevels.delete)

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

Required. Resource name for the Access Level. Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

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

Optional parameters.

Return values
Google_Service_AccessContextManager_Operation

get()

Get an Access Level by resource name. (accessLevels.get)

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

Required. Resource name for the Access Level. Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

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

Optional parameters.

Tags
opt_param

string accessLevelFormat Whether to return BasicLevels in the Cloud Common Expression Language rather than as BasicLevels. Defaults to AS_DEFINED, where Access Levels are returned as BasicLevels or CustomLevels based on how they were created. If set to CEL, all Access Levels are returned as CustomLevels. In the CEL case, BasicLevels are translated to equivalent CustomLevels.

Return values
Google_Service_AccessContextManager_AccessLevel

listAccessPoliciesAccessLevels()

List all Access Levels for an access policy.

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

(accessLevels.listAccessPoliciesAccessLevels)

Parameters
$parent : string

Required. Resource name for the access policy to list Access Levels from. Format: accessPolicies/{policy_id}

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

Optional parameters.

Tags
opt_param

string pageToken Next page token for the next batch of Access Level instances. Defaults to the first page of results.

opt_param

string accessLevelFormat Whether to return BasicLevels in the Cloud Common Expression language, as CustomLevels, rather than as BasicLevels. Defaults to returning AccessLevels in the format they were defined.

opt_param

int pageSize Number of Access Levels to include in the list. Default 100.

Return values
Google_Service_AccessContextManager_ListAccessLevelsResponse

patch()

Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. (accessLevels.patch)

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

Required. Resource name for the Access Level. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/accessLevels/{short_name}. The maximum length of the short_name component is 50 characters.

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

Optional parameters.

Tags
opt_param

string updateMask Required. Mask to control which fields get updated. Must be non-empty.

Return values
Google_Service_AccessContextManager_Operation

replaceAll()

Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long- lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error. (accessLevels.replaceAll)

public replaceAll(string $parent, Google_Service_AccessContextManager_ReplaceAccessLevelsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AccessContextManager_Operation
Parameters
$parent : string

Required. Resource name for the access policy which owns these Access Levels. Format: accessPolicies/{policy_id}

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

Optional parameters.

Return values
Google_Service_AccessContextManager_Operation

convertToArrayAndStripNulls()

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

Search results