Documentation

Google_Service_AccessContextManager_Resource_AccessPoliciesServicePerimeters extends Google_Service_Resource
in package

Application

The "servicePerimeters" collection of methods.

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

$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.
commit() : Google_Service_AccessContextManager_Operation: Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its `spec` field to that Service Perimeter's `status` field. Only Service Perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled.
create() : Google_Service_AccessContextManager_Operation: Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered. (servicePerimeters.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_AccessContextManager_Operation: Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage. (servicePerimeters.delete)
get() : Google_Service_AccessContextManager_ServicePerimeter: Get a Service Perimeter by resource name. (servicePerimeters.get)
listAccessPoliciesServicePerimeters() : Google_Service_AccessContextManager_ListServicePerimetersResponse: List all Service Perimeters for an access policy.
patch() : Google_Service_AccessContextManager_Operation: Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered. (servicePerimeters.patch)
replaceAll() : Google_Service_AccessContextManager_Operation: Replace all existing Service Perimeters in an Access Policy with the Service Perimeters 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 Service Perimeters will not be affected.
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 —

commit()

Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its `spec` field to that Service Perimeter's `status` field. Only Service Perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled.


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

When successful, Operation.response field will contain CommitServicePerimetersResponse. The dry_run and the spec fields will be cleared after a successful commit operation. (servicePerimeters.commit)

Parameters

$parent : string: Required. Resource name for the parent Access Policy which owns all Service Perimeters in scope for the commit operation. Format: accessPolicies/{policy_id}
$postBody : Google_Service_AccessContextManager_CommitServicePerimetersRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AccessContextManager_Operation —

create()

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


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

Parameters

$parent : string: Required. Resource name for the access policy which owns this Service Perimeter. Format: accessPolicies/{policy_id}
$postBody : Google_Service_AccessContextManager_ServicePerimeter
$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>

Return values

string —

$requestUrl

delete()

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


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

Parameters

$name : string: Required. Resource name for the Service Perimeter. Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AccessContextManager_Operation —

get()

Get a Service Perimeter by resource name. (servicePerimeters.get)


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

Parameters

$name : string: Required. Resource name for the Service Perimeter. Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AccessContextManager_ServicePerimeter —

listAccessPoliciesServicePerimeters()

List all Service Perimeters for an access policy.


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

(servicePerimeters.listAccessPoliciesServicePerimeters)

Parameters

$parent : string: Required. Resource name for the access policy to list Service Perimeters from. Format: accessPolicies/{policy_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AccessContextManager_ListServicePerimetersResponse —

patch()

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


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

Parameters

$name : string: Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}
$postBody : Google_Service_AccessContextManager_ServicePerimeter
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AccessContextManager_Operation —

replaceAll()

Replace all existing Service Perimeters in an Access Policy with the Service Perimeters 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 Service Perimeters will not be affected.


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

Operation.response field will contain ReplaceServicePerimetersResponse. (servicePerimeters.replaceAll)

Parameters

$parent : string: Required. Resource name for the access policy which owns these Service Perimeters. Format: accessPolicies/{policy_id}
$postBody : Google_Service_AccessContextManager_ReplaceServicePerimetersRequest
$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 —