Google Cloud Iap V1 Client - Class IdentityAwareProxyAdminServiceClient (1.3.4)

Version 1.3.4

• 2.0.2 (latest)
• 2.0.1
• 1.4.5
• 1.3.4
• 1.2.3
• 1.1.1
• 1.0.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

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.

This class is currently experimental and may be subject to changes. See Google\Cloud\Iap\V1\IdentityAwareProxyAdminServiceClient for the stable implementation

Namespace

Google \ Cloud \ Iap \ V1 \ 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.
↳ 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.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::createTunnelDestGroupAsync() .

Parameters
Name	Description
request	Google\Cloud\Iap\V1\CreateTunnelDestGroupRequest 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\Iap\V1\TunnelDestGroup

deleteTunnelDestGroup

Deletes a TunnelDestGroup.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::deleteTunnelDestGroupAsync() .

Parameters
Name	Description
request	Google\Cloud\Iap\V1\DeleteTunnelDestGroupRequest 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.

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

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest 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\V1\Policy

getIapSettings

Gets the IAP settings on a particular IAP protected resource.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::getIapSettingsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iap\V1\GetIapSettingsRequest 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\Iap\V1\IapSettings

getTunnelDestGroup

Retrieves an existing TunnelDestGroup.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::getTunnelDestGroupAsync() .

Parameters
Name	Description
request	Google\Cloud\Iap\V1\GetTunnelDestGroupRequest 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\Iap\V1\TunnelDestGroup

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

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::listTunnelDestGroupsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iap\V1\ListTunnelDestGroupsRequest 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

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

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest 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\V1\Policy

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

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest 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\V1\TestIamPermissionsResponse

updateIapSettings

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

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::updateIapSettingsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iap\V1\UpdateIapSettingsRequest 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\Iap\V1\IapSettings

updateTunnelDestGroup

Updates a TunnelDestGroup.

The async variant is Google\Cloud\Iap\V1\Client\IdentityAwareProxyAdminServiceClient::updateTunnelDestGroupAsync() .

Parameters
Name	Description
request	Google\Cloud\Iap\V1\UpdateTunnelDestGroupRequest 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\Iap\V1\TunnelDestGroup

createTunnelDestGroupAsync

Parameters
Name	Description
request	Google\Cloud\Iap\V1\CreateTunnelDestGroupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteTunnelDestGroupAsync

Parameters
Name	Description
request	Google\Cloud\Iap\V1\DeleteTunnelDestGroupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIapSettingsAsync

Parameters
Name	Description
request	Google\Cloud\Iap\V1\GetIapSettingsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getTunnelDestGroupAsync

Parameters
Name	Description
request	Google\Cloud\Iap\V1\GetTunnelDestGroupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listTunnelDestGroupsAsync

Parameters
Name	Description
request	Google\Cloud\Iap\V1\ListTunnelDestGroupsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateIapSettingsAsync

Parameters
Name	Description
request	Google\Cloud\Iap\V1\UpdateIapSettingsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateTunnelDestGroupAsync

Parameters
Name	Description
request	Google\Cloud\Iap\V1\UpdateTunnelDestGroupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

static::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.

static::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.

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

• 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.