Google Cloud Iam V3 Client - Class PrincipalAccessBoundaryPoliciesClient (1.1.1)

Reference documentation and code samples for the Google Cloud Iam V3 Client class PrincipalAccessBoundaryPoliciesClient.

Service Description: Manages Identity and Access Management (IAM) principal access boundary policies.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ Iam \ V3 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

↳ logger false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

createPrincipalAccessBoundaryPolicy

Creates a principal access boundary policy, and returns a long running operation.

The async variant is PrincipalAccessBoundaryPoliciesClient::createPrincipalAccessBoundaryPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V3\CreatePrincipalAccessBoundaryPolicyRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V3\Client\PrincipalAccessBoundaryPoliciesClient;
use Google\Cloud\Iam\V3\CreatePrincipalAccessBoundaryPolicyRequest;
use Google\Cloud\Iam\V3\PrincipalAccessBoundaryPolicy;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                 The parent resource where this principal access boundary policy
 *                                                will be created. Only organizations are supported.
 *
 *                                                Format:
 *                                                `organizations/{organization_id}/locations/{location}`
 *                                                Please see {@see PrincipalAccessBoundaryPoliciesClient::organizationLocationName()} for help formatting this field.
 * @param string $principalAccessBoundaryPolicyId The ID to use for the principal access boundary policy, which
 *                                                will become the final component of the principal access boundary policy's
 *                                                resource name.
 *
 *                                                This value must start with a lowercase letter followed by up to 62
 *                                                lowercase letters, numbers, hyphens, or dots. Pattern,
 *                                                /[a-z][a-z0-9-\.]{2,62}/.
 */
function create_principal_access_boundary_policy_sample(
    string $formattedParent,
    string $principalAccessBoundaryPolicyId
): void {
    // Create a client.
    $principalAccessBoundaryPoliciesClient = new PrincipalAccessBoundaryPoliciesClient();

    // Prepare the request message.
    $principalAccessBoundaryPolicy = new PrincipalAccessBoundaryPolicy();
    $request = (new CreatePrincipalAccessBoundaryPolicyRequest())
        ->setParent($formattedParent)
        ->setPrincipalAccessBoundaryPolicyId($principalAccessBoundaryPolicyId)
        ->setPrincipalAccessBoundaryPolicy($principalAccessBoundaryPolicy);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $principalAccessBoundaryPoliciesClient->createPrincipalAccessBoundaryPolicy($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var PrincipalAccessBoundaryPolicy $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = PrincipalAccessBoundaryPoliciesClient::organizationLocationName(
        '[ORGANIZATION]',
        '[LOCATION]'
    );
    $principalAccessBoundaryPolicyId = '[PRINCIPAL_ACCESS_BOUNDARY_POLICY_ID]';

    create_principal_access_boundary_policy_sample($formattedParent, $principalAccessBoundaryPolicyId);
}

deletePrincipalAccessBoundaryPolicy

Deletes a principal access boundary policy.

The async variant is PrincipalAccessBoundaryPoliciesClient::deletePrincipalAccessBoundaryPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V3\DeletePrincipalAccessBoundaryPolicyRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V3\Client\PrincipalAccessBoundaryPoliciesClient;
use Google\Cloud\Iam\V3\DeletePrincipalAccessBoundaryPolicyRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the principal access boundary policy to delete.
 *
 *                              Format:
 *                              `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`
 *                              Please see {@see PrincipalAccessBoundaryPoliciesClient::principalAccessBoundaryPolicyName()} for help formatting this field.
 */
function delete_principal_access_boundary_policy_sample(string $formattedName): void
{
    // Create a client.
    $principalAccessBoundaryPoliciesClient = new PrincipalAccessBoundaryPoliciesClient();

    // Prepare the request message.
    $request = (new DeletePrincipalAccessBoundaryPolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $principalAccessBoundaryPoliciesClient->deletePrincipalAccessBoundaryPolicy($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PrincipalAccessBoundaryPoliciesClient::principalAccessBoundaryPolicyName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[PRINCIPAL_ACCESS_BOUNDARY_POLICY]'
    );

    delete_principal_access_boundary_policy_sample($formattedName);
}

getPrincipalAccessBoundaryPolicy

Gets a principal access boundary policy.

The async variant is PrincipalAccessBoundaryPoliciesClient::getPrincipalAccessBoundaryPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V3\GetPrincipalAccessBoundaryPolicyRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\Iam\V3\PrincipalAccessBoundaryPolicy
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V3\Client\PrincipalAccessBoundaryPoliciesClient;
use Google\Cloud\Iam\V3\GetPrincipalAccessBoundaryPolicyRequest;
use Google\Cloud\Iam\V3\PrincipalAccessBoundaryPolicy;

/**
 * @param string $formattedName The name of the principal access boundary policy to retrieve.
 *
 *                              Format:
 *                              `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`
 *                              Please see {@see PrincipalAccessBoundaryPoliciesClient::principalAccessBoundaryPolicyName()} for help formatting this field.
 */
function get_principal_access_boundary_policy_sample(string $formattedName): void
{
    // Create a client.
    $principalAccessBoundaryPoliciesClient = new PrincipalAccessBoundaryPoliciesClient();

    // Prepare the request message.
    $request = (new GetPrincipalAccessBoundaryPolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var PrincipalAccessBoundaryPolicy $response */
        $response = $principalAccessBoundaryPoliciesClient->getPrincipalAccessBoundaryPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PrincipalAccessBoundaryPoliciesClient::principalAccessBoundaryPolicyName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[PRINCIPAL_ACCESS_BOUNDARY_POLICY]'
    );

    get_principal_access_boundary_policy_sample($formattedName);
}

listPrincipalAccessBoundaryPolicies

Lists principal access boundary policies.

The async variant is PrincipalAccessBoundaryPoliciesClient::listPrincipalAccessBoundaryPoliciesAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V3\ListPrincipalAccessBoundaryPoliciesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iam\V3\Client\PrincipalAccessBoundaryPoliciesClient;
use Google\Cloud\Iam\V3\ListPrincipalAccessBoundaryPoliciesRequest;
use Google\Cloud\Iam\V3\PrincipalAccessBoundaryPolicy;

/**
 * @param string $formattedParent The parent resource, which owns the collection of principal
 *                                access boundary policies.
 *
 *                                Format:
 *                                `organizations/{organization_id}/locations/{location}`
 *                                Please see {@see PrincipalAccessBoundaryPoliciesClient::organizationLocationName()} for help formatting this field.
 */
function list_principal_access_boundary_policies_sample(string $formattedParent): void
{
    // Create a client.
    $principalAccessBoundaryPoliciesClient = new PrincipalAccessBoundaryPoliciesClient();

    // Prepare the request message.
    $request = (new ListPrincipalAccessBoundaryPoliciesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $principalAccessBoundaryPoliciesClient->listPrincipalAccessBoundaryPolicies($request);

        /** @var PrincipalAccessBoundaryPolicy $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = PrincipalAccessBoundaryPoliciesClient::organizationLocationName(
        '[ORGANIZATION]',
        '[LOCATION]'
    );

    list_principal_access_boundary_policies_sample($formattedParent);
}

searchPrincipalAccessBoundaryPolicyBindings

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

The async variant is PrincipalAccessBoundaryPoliciesClient::searchPrincipalAccessBoundaryPolicyBindingsAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V3\SearchPrincipalAccessBoundaryPolicyBindingsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iam\V3\Client\PrincipalAccessBoundaryPoliciesClient;
use Google\Cloud\Iam\V3\PolicyBinding;
use Google\Cloud\Iam\V3\SearchPrincipalAccessBoundaryPolicyBindingsRequest;

/**
 * @param string $formattedName The name of the principal access boundary policy.
 *                              Format:
 *                              `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`
 *                              Please see {@see PrincipalAccessBoundaryPoliciesClient::principalAccessBoundaryPolicyName()} for help formatting this field.
 */
function search_principal_access_boundary_policy_bindings_sample(string $formattedName): void
{
    // Create a client.
    $principalAccessBoundaryPoliciesClient = new PrincipalAccessBoundaryPoliciesClient();

    // Prepare the request message.
    $request = (new SearchPrincipalAccessBoundaryPolicyBindingsRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $principalAccessBoundaryPoliciesClient->searchPrincipalAccessBoundaryPolicyBindings(
            $request
        );

        /** @var PolicyBinding $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PrincipalAccessBoundaryPoliciesClient::principalAccessBoundaryPolicyName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[PRINCIPAL_ACCESS_BOUNDARY_POLICY]'
    );

    search_principal_access_boundary_policy_bindings_sample($formattedName);
}

updatePrincipalAccessBoundaryPolicy

Updates a principal access boundary policy.

The async variant is PrincipalAccessBoundaryPoliciesClient::updatePrincipalAccessBoundaryPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V3\UpdatePrincipalAccessBoundaryPolicyRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V3\Client\PrincipalAccessBoundaryPoliciesClient;
use Google\Cloud\Iam\V3\PrincipalAccessBoundaryPolicy;
use Google\Cloud\Iam\V3\UpdatePrincipalAccessBoundaryPolicyRequest;
use Google\Rpc\Status;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_principal_access_boundary_policy_sample(): void
{
    // Create a client.
    $principalAccessBoundaryPoliciesClient = new PrincipalAccessBoundaryPoliciesClient();

    // Prepare the request message.
    $principalAccessBoundaryPolicy = new PrincipalAccessBoundaryPolicy();
    $request = (new UpdatePrincipalAccessBoundaryPolicyRequest())
        ->setPrincipalAccessBoundaryPolicy($principalAccessBoundaryPolicy);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $principalAccessBoundaryPoliciesClient->updatePrincipalAccessBoundaryPolicy($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var PrincipalAccessBoundaryPolicy $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

createPrincipalAccessBoundaryPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V3\CreatePrincipalAccessBoundaryPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deletePrincipalAccessBoundaryPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V3\DeletePrincipalAccessBoundaryPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getPrincipalAccessBoundaryPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V3\GetPrincipalAccessBoundaryPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V3\PrincipalAccessBoundaryPolicy>

listPrincipalAccessBoundaryPoliciesAsync

Parameters
Name Description
request Google\Cloud\Iam\V3\ListPrincipalAccessBoundaryPoliciesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

searchPrincipalAccessBoundaryPolicyBindingsAsync

Parameters
Name Description
request Google\Cloud\Iam\V3\SearchPrincipalAccessBoundaryPolicyBindingsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updatePrincipalAccessBoundaryPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V3\UpdatePrincipalAccessBoundaryPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type Description
Google\LongRunning\Client\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name Description
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
Type Description
Google\ApiCore\OperationResponse

static::organizationLocationName

Formats a string containing the fully-qualified path to represent a organization_location resource.

Parameters
Name Description
organization string
location string
Returns
Type Description
string The formatted organization_location resource.

static::principalAccessBoundaryPolicyName

Formats a string containing the fully-qualified path to represent a principal_access_boundary_policy resource.

Parameters
Name Description
organization string
location string
principalAccessBoundaryPolicy string
Returns
Type Description
string The formatted principal_access_boundary_policy resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • organizationLocation: organizations/{organization}/locations/{location}
  • principalAccessBoundaryPolicy: organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string

template ?string

Optional name of template to match

Returns
Type Description
array An associative array from name component IDs to component values.