Reference documentation and code samples for the Google Cloud BeyondCorp AppConnectors V1 Client class AppConnectorsServiceClient.
Service Description: API Overview:
The beyondcorp.googleapis.com
service implements the Google Cloud
BeyondCorp API.
Data Model:
The AppConnectorsService exposes the following resource:
- AppConnectors, named as follows:
projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}
.
The AppConnectorsService provides methods to manage (create/read/update/delete) BeyondCorp AppConnectors.
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:
$appConnectorsServiceClient = new AppConnectorsServiceClient();
try {
$formattedParent = $appConnectorsServiceClient->locationName('[PROJECT]', '[LOCATION]');
$appConnector = new AppConnector();
$operationResponse = $appConnectorsServiceClient->createAppConnector($formattedParent, $appConnector);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $appConnectorsServiceClient->createAppConnector($formattedParent, $appConnector);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $appConnectorsServiceClient->resumeOperation($operationName, 'createAppConnector');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$appConnectorsServiceClient->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
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. |
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. |
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
- appConnector: projects/{project}/locations/{location}/appConnectors/{app_connector}
- 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. |
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 |
__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. |
createAppConnector
Creates a new AppConnector in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource project name of the AppConnector location using the
form: |
appConnector |
Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector
Required. A BeyondCorp AppConnector resource. |
optionalArgs |
array
Optional. |
↳ appConnectorId |
string
Optional. User-settable AppConnector resource ID. * Must start with a letter. * Must contain between 4-63 characters from |
↳ requestId |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. |
↳ 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\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector\PrincipalInfo;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnectorsServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource project name of the AppConnector location using the
* form: `projects/{project_id}/locations/{location_id}`
* Please see {@see AppConnectorsServiceClient::locationName()} for help formatting this field.
* @param string $appConnectorName Unique resource name of the AppConnector.
* The name is ignored when creating a AppConnector.
*/
function create_app_connector_sample(string $formattedParent, string $appConnectorName): void
{
// Create a client.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$appConnectorPrincipalInfo = new PrincipalInfo();
$appConnector = (new AppConnector())
->setName($appConnectorName)
->setPrincipalInfo($appConnectorPrincipalInfo);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $appConnectorsServiceClient->createAppConnector($formattedParent, $appConnector);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AppConnector $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());
}
}
/**
* 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 = AppConnectorsServiceClient::locationName('[PROJECT]', '[LOCATION]');
$appConnectorName = '[NAME]';
create_app_connector_sample($formattedParent, $appConnectorName);
}
deleteAppConnector
Deletes a single AppConnector.
Parameters | |
---|---|
Name | Description |
name |
string
Required. BeyondCorp AppConnector name using the form:
|
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. |
↳ 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\AppConnectors\V1\AppConnectorsServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName BeyondCorp AppConnector name using the form:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
* Please see {@see AppConnectorsServiceClient::appConnectorName()} for help formatting this field.
*/
function delete_app_connector_sample(string $formattedName): void
{
// Create a client.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $appConnectorsServiceClient->deleteAppConnector($formattedName);
$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());
}
}
/**
* 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 = AppConnectorsServiceClient::appConnectorName(
'[PROJECT]',
'[LOCATION]',
'[APP_CONNECTOR]'
);
delete_app_connector_sample($formattedName);
}
getAppConnector
Gets details of a single AppConnector.
Parameters | |
---|---|
Name | Description |
name |
string
Required. BeyondCorp AppConnector name using the form:
|
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\BeyondCorp\AppConnectors\V1\AppConnector |
use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnectorsServiceClient;
/**
* @param string $formattedName BeyondCorp AppConnector name using the form:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
* Please see {@see AppConnectorsServiceClient::appConnectorName()} for help formatting this field.
*/
function get_app_connector_sample(string $formattedName): void
{
// Create a client.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Call the API and handle any network failures.
try {
/** @var AppConnector $response */
$response = $appConnectorsServiceClient->getAppConnector($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 = AppConnectorsServiceClient::appConnectorName(
'[PROJECT]',
'[LOCATION]',
'[APP_CONNECTOR]'
);
get_app_connector_sample($formattedName);
}
listAppConnectors
Lists AppConnectors in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the AppConnector location using the form:
|
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. |
↳ filter |
string
Optional. A filter specifying constraints of a list operation. |
↳ orderBy |
string
Optional. Specifies the ordering of results. See Sorting order for more information. |
↳ 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\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnectorsServiceClient;
/**
* @param string $formattedParent The resource name of the AppConnector location using the form:
* `projects/{project_id}/locations/{location_id}`
* Please see {@see AppConnectorsServiceClient::locationName()} for help formatting this field.
*/
function list_app_connectors_sample(string $formattedParent): void
{
// Create a client.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $appConnectorsServiceClient->listAppConnectors($formattedParent);
/** @var AppConnector $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 = AppConnectorsServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_app_connectors_sample($formattedParent);
}
reportStatus
Report status for a given connector.
Parameters | |
---|---|
Name | Description |
appConnector |
string
Required. BeyondCorp Connector name using the form:
|
resourceInfo |
Google\Cloud\BeyondCorp\AppConnectors\V1\ResourceInfo
Required. Resource info of the connector. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. |
↳ 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\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnectorsServiceClient;
use Google\Cloud\BeyondCorp\AppConnectors\V1\ResourceInfo;
use Google\Rpc\Status;
/**
* @param string $formattedAppConnector BeyondCorp Connector name using the form:
* `projects/{project_id}/locations/{location_id}/connectors/{connector}`
* Please see {@see AppConnectorsServiceClient::appConnectorName()} for help formatting this field.
* @param string $resourceInfoId Unique Id for the resource.
*/
function report_status_sample(string $formattedAppConnector, string $resourceInfoId): void
{
// Create a client.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$resourceInfo = (new ResourceInfo())
->setId($resourceInfoId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $appConnectorsServiceClient->reportStatus($formattedAppConnector, $resourceInfo);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AppConnector $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());
}
}
/**
* 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
{
$formattedAppConnector = AppConnectorsServiceClient::appConnectorName(
'[PROJECT]',
'[LOCATION]',
'[APP_CONNECTOR]'
);
$resourceInfoId = '[ID]';
report_status_sample($formattedAppConnector, $resourceInfoId);
}
updateAppConnector
Updates the parameters of a single AppConnector.
Parameters | |
---|---|
Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnector]:
|
appConnector |
Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector
Required. AppConnector message with updated fields. Only supported fields specified in update_mask are updated. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. |
↳ 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\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector\PrincipalInfo;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnectorsServiceClient;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* @param string $appConnectorName Unique resource name of the AppConnector.
* The name is ignored when creating a AppConnector.
*/
function update_app_connector_sample(string $appConnectorName): void
{
// Create a client.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$appConnectorPrincipalInfo = new PrincipalInfo();
$appConnector = (new AppConnector())
->setName($appConnectorName)
->setPrincipalInfo($appConnectorPrincipalInfo);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $appConnectorsServiceClient->updateAppConnector($updateMask, $appConnector);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AppConnector $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());
}
}
/**
* 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
{
$appConnectorName = '[NAME]';
update_app_connector_sample($appConnectorName);
}
getLocation
Gets information about a location.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ 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\AppConnectors\V1\AppConnectorsServiceClient;
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.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $appConnectorsServiceClient->getLocation();
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.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnectorsServiceClient;
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.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $appConnectorsServiceClient->listLocations();
/** @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.
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 |
↳ 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\AppConnectors\V1\AppConnectorsServiceClient;
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.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $appConnectorsServiceClient->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);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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 |
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: |
↳ 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\AppConnectors\V1\AppConnectorsServiceClient;
use Google\Cloud\Iam\V1\Policy;
/**
* @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.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// 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 = $appConnectorsServiceClient->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 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.
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 |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnectorsServiceClient;
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.
$appConnectorsServiceClient = new AppConnectorsServiceClient();
// 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 = $appConnectorsServiceClient->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);
}
Constants
SERVICE_NAME
Value: 'google.cloud.beyondcorp.appconnectors.v1.AppConnectorsService'
The name of the service.
SERVICE_ADDRESS
Value: 'beyondcorp.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.