Google Cloud Iap V1 Client - Class IdentityAwareProxyAdminServiceClient (1.1.1)

Reference documentation and code samples for the Google Cloud Iap V1 Client class IdentityAwareProxyAdminServiceClient.

Service Description: APIs for Identity-Aware Proxy Admin configurations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();
try {
    $formattedParent = $identityAwareProxyAdminServiceClient->tunnelLocationName('[PROJECT]', '[LOCATION]');
    $tunnelDestGroup = new TunnelDestGroup();
    $tunnelDestGroupId = 'tunnel_dest_group_id';
    $response = $identityAwareProxyAdminServiceClient->createTunnelDestGroup($formattedParent, $tunnelDestGroup, $tunnelDestGroupId);
} finally {
    $identityAwareProxyAdminServiceClient->close();
}

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.

Methods

tunnelDestGroupName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`destGroup`	`string`

Returns
Type	Description
`string`	The formatted tunnel_dest_group resource.

tunnelLocationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted tunnel_location resource.

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

tunnelDestGroup: projects/{project}/iap_tunnel/locations/{location}/destGroups/{dest_group}
tunnelLocation: projects/{project}/iap_tunnel/locations/{location}

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.

__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.
`↳ 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.

createTunnelDestGroup

Creates a new TunnelDestGroup.

Parameters
Name	Description
`parent`	`string` Required. Google Cloud Project ID and location. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}`.
`tunnelDestGroup`	`Google\Cloud\Iap\V1\TunnelDestGroup` Required. The TunnelDestGroup to create.
`tunnelDestGroupId`	`string` Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name. This value must be 4-63 characters, and valid characters are `[a-z]-`.
`optionalArgs`	`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\Iap\V1\TunnelDestGroup`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;
use Google\Cloud\Iap\V1\TunnelDestGroup;

/**
 * @param string $formattedParent     Google Cloud Project ID and location.
 *                                    In the following format:
 *                                    `projects/{project_number/id}/iap_tunnel/locations/{location}`. Please see
 *                                    {@see IdentityAwareProxyAdminServiceClient::tunnelLocationName()} for help formatting this field.
 * @param string $tunnelDestGroupName Immutable. Identifier for the TunnelDestGroup. Must be unique
 *                                    within the project and contain only lower case letters (a-z) and dashes
 *                                    (-).
 * @param string $tunnelDestGroupId   The ID to use for the TunnelDestGroup, which becomes the final
 *                                    component of the resource name.
 *
 *                                    This value must be 4-63 characters, and valid characters
 *                                    are `[a-z]-`.
 */
function create_tunnel_dest_group_sample(
    string $formattedParent,
    string $tunnelDestGroupName,
    string $tunnelDestGroupId
): void {
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $tunnelDestGroup = (new TunnelDestGroup())
        ->setName($tunnelDestGroupName);

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

/**
 * 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 = IdentityAwareProxyAdminServiceClient::tunnelLocationName(
        '[PROJECT]',
        '[LOCATION]'
    );
    $tunnelDestGroupName = '[NAME]';
    $tunnelDestGroupId = '[TUNNEL_DEST_GROUP_ID]';

    create_tunnel_dest_group_sample($formattedParent, $tunnelDestGroupName, $tunnelDestGroupId);
}

deleteTunnelDestGroup

Deletes a TunnelDestGroup.

Parameters
Name	Description
`name`	`string` Required. Name of the TunnelDestGroup to delete. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}`.
`optionalArgs`	`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;

/**
 * @param string $formattedName Name of the TunnelDestGroup to delete.
 *                              In the following format:
 *                              `projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}`. Please see
 *                              {@see IdentityAwareProxyAdminServiceClient::tunnelDestGroupName()} for help formatting this field.
 */
function delete_tunnel_dest_group_sample(string $formattedName): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

    // Call the API and handle any network failures.
    try {
        $identityAwareProxyAdminServiceClient->deleteTunnelDestGroup($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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 = IdentityAwareProxyAdminServiceClient::tunnelDestGroupName(
        '[PROJECT]',
        '[LOCATION]',
        '[DEST_GROUP]'
    );

    delete_tunnel_dest_group_sample($formattedName);
}

getIamPolicy

Gets the access control policy for an Identity-Aware Proxy protected resource.

More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`optionalArgs`	`array` Optional.
`↳ options`	`GetPolicyOptions` OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
`↳ 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\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

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

/**
 * 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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

getIapSettings

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name	Description
`name`	`string` Required. The resource name for which to retrieve the settings. Authorization: Requires the `getSettings` permission for the associated resource.
`optionalArgs`	`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\Iap\V1\IapSettings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\IapSettings;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;

/**
 * @param string $name The resource name for which to retrieve the settings.
 *                     Authorization: Requires the `getSettings` permission for the associated
 *                     resource.
 */
function get_iap_settings_sample(string $name): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

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

/**
 * 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
{
    $name = '[NAME]';

    get_iap_settings_sample($name);
}

getTunnelDestGroup

Retrieves an existing TunnelDestGroup.

Parameters
Name	Description
`name`	`string` Required. Name of the TunnelDestGroup to be fetched. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}`.
`optionalArgs`	`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\Iap\V1\TunnelDestGroup`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;
use Google\Cloud\Iap\V1\TunnelDestGroup;

/**
 * @param string $formattedName Name of the TunnelDestGroup to be fetched.
 *                              In the following format:
 *                              `projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}`. Please see
 *                              {@see IdentityAwareProxyAdminServiceClient::tunnelDestGroupName()} for help formatting this field.
 */
function get_tunnel_dest_group_sample(string $formattedName): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

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

/**
 * 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 = IdentityAwareProxyAdminServiceClient::tunnelDestGroupName(
        '[PROJECT]',
        '[LOCATION]',
        '[DEST_GROUP]'
    );

    get_tunnel_dest_group_sample($formattedName);
}

listTunnelDestGroups

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name	Description
`parent`	`string` Required. Google Cloud Project ID and location. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}`. A `-` can be used for the location to group across all locations.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\Iap\V1\IdentityAwareProxyAdminServiceClient;
use Google\Cloud\Iap\V1\TunnelDestGroup;

/**
 * @param string $formattedParent Google Cloud Project ID and location.
 *                                In the following format:
 *                                `projects/{project_number/id}/iap_tunnel/locations/{location}`.
 *                                A `-` can be used for the location to group across all locations. Please see
 *                                {@see IdentityAwareProxyAdminServiceClient::tunnelLocationName()} for help formatting this field.
 */
function list_tunnel_dest_groups_sample(string $formattedParent): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

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

        /** @var TunnelDestGroup $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());
    }
}

/**
 * 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 = IdentityAwareProxyAdminServiceClient::tunnelLocationName(
        '[PROJECT]',
        '[LOCATION]'
    );

    list_tunnel_dest_groups_sample($formattedParent);
}

setIamPolicy

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy.

More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`Google\Cloud\Iam\V1\Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
`↳ 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\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $policy = new Policy();

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

/**
 * 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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has on the Identity-Aware Proxy protected resource.

More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`string[]` The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
`optionalArgs`	`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\V1\TestIamPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $permissions = [$permissionsElement,];

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

/**
 * 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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

updateIapSettings

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters
Name	Description
`iapSettings`	`Google\Cloud\Iap\V1\IapSettings` Required. The new values for the IAP settings to be updated. Authorization: Requires the `updateSettings` permission for the associated resource.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` The field mask specifying which IAP settings should be updated. If omitted, the all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
`↳ 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\Iap\V1\IapSettings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\IapSettings;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;

/**
 * @param string $iapSettingsName The resource name of the IAP protected resource.
 */
function update_iap_settings_sample(string $iapSettingsName): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $iapSettings = (new IapSettings())
        ->setName($iapSettingsName);

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

/**
 * 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
{
    $iapSettingsName = '[NAME]';

    update_iap_settings_sample($iapSettingsName);
}

updateTunnelDestGroup

Updates a TunnelDestGroup.

Parameters
Name	Description
`tunnelDestGroup`	`Google\Cloud\Iap\V1\TunnelDestGroup` Required. The new values for the TunnelDestGroup.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` A field mask that specifies which IAP settings to update. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
`↳ 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\Iap\V1\TunnelDestGroup`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient;
use Google\Cloud\Iap\V1\TunnelDestGroup;

/**
 * @param string $tunnelDestGroupName Immutable. Identifier for the TunnelDestGroup. Must be unique
 *                                    within the project and contain only lower case letters (a-z) and dashes
 *                                    (-).
 */
function update_tunnel_dest_group_sample(string $tunnelDestGroupName): void
{
    // Create a client.
    $identityAwareProxyAdminServiceClient = new IdentityAwareProxyAdminServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $tunnelDestGroup = (new TunnelDestGroup())
        ->setName($tunnelDestGroupName);

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

/**
 * 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
{
    $tunnelDestGroupName = '[NAME]';

    update_tunnel_dest_group_sample($tunnelDestGroupName);
}

Constants

SERVICE_NAME

Value: 'google.cloud.iap.v1.IdentityAwareProxyAdminService'

The name of the service.

SERVICE_ADDRESS

Value: 'iap.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.