Reference documentation and code samples for the Google Cloud BeyondCorp AppConnections V1 Client class AppConnectionsServiceClient.
Service Description: API Overview:
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ BeyondCorp \ AppConnections \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
createAppConnection
Creates a new AppConnection in a given project and location.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::createAppConnectionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\CreateAppConnectionRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\ApplicationEndpoint;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\Type;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\BeyondCorp\AppConnections\V1\CreateAppConnectionRequest;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource project name of the AppConnection location using the
* form: `projects/{project_id}/locations/{location_id}`
* Please see {@see AppConnectionsServiceClient::locationName()} for help formatting this field.
* @param string $appConnectionName Unique resource name of the AppConnection.
* The name is ignored when creating a AppConnection.
* @param int $appConnectionType The type of network connectivity used by the AppConnection.
* @param string $appConnectionApplicationEndpointHost Hostname or IP address of the remote application endpoint.
* @param int $appConnectionApplicationEndpointPort Port of the remote application endpoint.
*/
function create_app_connection_sample(
string $formattedParent,
string $appConnectionName,
int $appConnectionType,
string $appConnectionApplicationEndpointHost,
int $appConnectionApplicationEndpointPort
): void {
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$appConnectionApplicationEndpoint = (new ApplicationEndpoint())
->setHost($appConnectionApplicationEndpointHost)
->setPort($appConnectionApplicationEndpointPort);
$appConnection = (new AppConnection())
->setName($appConnectionName)
->setType($appConnectionType)
->setApplicationEndpoint($appConnectionApplicationEndpoint);
$request = (new CreateAppConnectionRequest())
->setParent($formattedParent)
->setAppConnection($appConnection);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $appConnectionsServiceClient->createAppConnection($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AppConnection $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 = AppConnectionsServiceClient::locationName('[PROJECT]', '[LOCATION]');
$appConnectionName = '[NAME]';
$appConnectionType = Type::TYPE_UNSPECIFIED;
$appConnectionApplicationEndpointHost = '[HOST]';
$appConnectionApplicationEndpointPort = 0;
create_app_connection_sample(
$formattedParent,
$appConnectionName,
$appConnectionType,
$appConnectionApplicationEndpointHost,
$appConnectionApplicationEndpointPort
);
}
deleteAppConnection
Deletes a single AppConnection.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::deleteAppConnectionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\DeleteAppConnectionRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\BeyondCorp\AppConnections\V1\DeleteAppConnectionRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName BeyondCorp Connector name using the form:
* `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
* Please see {@see AppConnectionsServiceClient::appConnectionName()} for help formatting this field.
*/
function delete_app_connection_sample(string $formattedName): void
{
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$request = (new DeleteAppConnectionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $appConnectionsServiceClient->deleteAppConnection($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 = AppConnectionsServiceClient::appConnectionName(
'[PROJECT]',
'[LOCATION]',
'[APP_CONNECTION]'
);
delete_app_connection_sample($formattedName);
}
getAppConnection
Gets details of a single AppConnection.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::getAppConnectionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\GetAppConnectionRequest
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\BeyondCorp\AppConnections\V1\AppConnection |
use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\BeyondCorp\AppConnections\V1\GetAppConnectionRequest;
/**
* @param string $formattedName BeyondCorp AppConnection name using the form:
* `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
* Please see {@see AppConnectionsServiceClient::appConnectionName()} for help formatting this field.
*/
function get_app_connection_sample(string $formattedName): void
{
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$request = (new GetAppConnectionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var AppConnection $response */
$response = $appConnectionsServiceClient->getAppConnection($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 = AppConnectionsServiceClient::appConnectionName(
'[PROJECT]',
'[LOCATION]',
'[APP_CONNECTION]'
);
get_app_connection_sample($formattedName);
}
listAppConnections
Lists AppConnections in a given project and location.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::listAppConnectionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\ListAppConnectionsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\BeyondCorp\AppConnections\V1\ListAppConnectionsRequest;
/**
* @param string $formattedParent The resource name of the AppConnection location using the form:
* `projects/{project_id}/locations/{location_id}`
* Please see {@see AppConnectionsServiceClient::locationName()} for help formatting this field.
*/
function list_app_connections_sample(string $formattedParent): void
{
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$request = (new ListAppConnectionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $appConnectionsServiceClient->listAppConnections($request);
/** @var AppConnection $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 = AppConnectionsServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_app_connections_sample($formattedParent);
}
resolveAppConnections
Resolves AppConnections details for a given AppConnector.
An internal method called by a connector to find AppConnections to connect to.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::resolveAppConnectionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\ResolveAppConnectionsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\BeyondCorp\AppConnections\V1\ResolveAppConnectionsRequest;
use Google\Cloud\BeyondCorp\AppConnections\V1\ResolveAppConnectionsResponse\AppConnectionDetails;
/**
* @param string $formattedParent The resource name of the AppConnection location using the form:
* `projects/{project_id}/locations/{location_id}`
* Please see {@see AppConnectionsServiceClient::locationName()} for help formatting this field.
* @param string $formattedAppConnectorId BeyondCorp Connector name of the connector associated with those
* AppConnections using the form:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
* Please see {@see AppConnectionsServiceClient::appConnectorName()} for help formatting this field.
*/
function resolve_app_connections_sample(
string $formattedParent,
string $formattedAppConnectorId
): void {
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$request = (new ResolveAppConnectionsRequest())
->setParent($formattedParent)
->setAppConnectorId($formattedAppConnectorId);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $appConnectionsServiceClient->resolveAppConnections($request);
/** @var AppConnectionDetails $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 = AppConnectionsServiceClient::locationName('[PROJECT]', '[LOCATION]');
$formattedAppConnectorId = AppConnectionsServiceClient::appConnectorName(
'[PROJECT]',
'[LOCATION]',
'[APP_CONNECTOR]'
);
resolve_app_connections_sample($formattedParent, $formattedAppConnectorId);
}
updateAppConnection
Updates the parameters of a single AppConnection.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::updateAppConnectionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\UpdateAppConnectionRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\ApplicationEndpoint;
use Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\Type;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\BeyondCorp\AppConnections\V1\UpdateAppConnectionRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* @param string $appConnectionName Unique resource name of the AppConnection.
* The name is ignored when creating a AppConnection.
* @param int $appConnectionType The type of network connectivity used by the AppConnection.
* @param string $appConnectionApplicationEndpointHost Hostname or IP address of the remote application endpoint.
* @param int $appConnectionApplicationEndpointPort Port of the remote application endpoint.
*/
function update_app_connection_sample(
string $appConnectionName,
int $appConnectionType,
string $appConnectionApplicationEndpointHost,
int $appConnectionApplicationEndpointPort
): void {
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$updateMask = new FieldMask();
$appConnectionApplicationEndpoint = (new ApplicationEndpoint())
->setHost($appConnectionApplicationEndpointHost)
->setPort($appConnectionApplicationEndpointPort);
$appConnection = (new AppConnection())
->setName($appConnectionName)
->setType($appConnectionType)
->setApplicationEndpoint($appConnectionApplicationEndpoint);
$request = (new UpdateAppConnectionRequest())
->setUpdateMask($updateMask)
->setAppConnection($appConnection);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $appConnectionsServiceClient->updateAppConnection($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AppConnection $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
{
$appConnectionName = '[NAME]';
$appConnectionType = Type::TYPE_UNSPECIFIED;
$appConnectionApplicationEndpointHost = '[HOST]';
$appConnectionApplicationEndpointPort = 0;
update_app_connection_sample(
$appConnectionName,
$appConnectionType,
$appConnectionApplicationEndpointHost,
$appConnectionApplicationEndpointPort
);
}
getLocation
Gets information about a location.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::getLocationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
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\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
/**
* 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 get_location_sample(): void
{
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $appConnectionsServiceClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::listLocationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
/**
* 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 list_locations_sample(): void
{
// Create a client.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $appConnectionsServiceClient->listLocations($request);
/** @var Location $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());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
/**
* @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.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $appConnectionsServiceClient->getIamPolicy($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
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
/**
* @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.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $appConnectionsServiceClient->setIamPolicy($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
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
The async variant is Google\Cloud\BeyondCorp\AppConnections\V1\Client\BaseClient\self::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnections\V1\Client\AppConnectionsServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
/**
* @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.
$appConnectionsServiceClient = new AppConnectionsServiceClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $appConnectionsServiceClient->testIamPermissions($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
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
createAppConnectionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\CreateAppConnectionRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteAppConnectionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\DeleteAppConnectionRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getAppConnectionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\GetAppConnectionRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listAppConnectionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\ListAppConnectionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
resolveAppConnectionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\ResolveAppConnectionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateAppConnectionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\BeyondCorp\AppConnections\V1\UpdateAppConnectionRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
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 |
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 |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\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::appConnectionName
Formats a string containing the fully-qualified path to represent a app_connection resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
appConnection |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted app_connection resource. |
static::appConnectorName
Formats a string containing the fully-qualified path to represent a app_connector resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
appConnector |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted app_connector resource. |
static::appGatewayName
Formats a string containing the fully-qualified path to represent a app_gateway resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
appGateway |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted app_gateway resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted 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
- appConnection: projects/{project}/locations/{location}/appConnections/{app_connection}
- appConnector: projects/{project}/locations/{location}/appConnectors/{app_connector}
- appGateway: projects/{project}/locations/{location}/appGateways/{app_gateway}
- location: projects/{project}/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. |