Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class CrossNetworkAutomationServiceClient.
Service Description: The service for CrossNetworkAutomation resources.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ NetworkConnectivity \ 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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
createServiceConnectionMap
Creates a new ServiceConnectionMap in a given project and location.
The async variant is CrossNetworkAutomationServiceClient::createServiceConnectionMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionMapRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionMapRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionMap;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource's name of the ServiceConnectionMap. ex.
* projects/123/locations/us-east1
* Please see {@see CrossNetworkAutomationServiceClient::locationName()} for help formatting this field.
*/
function create_service_connection_map_sample(string $formattedParent): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$serviceConnectionMap = new ServiceConnectionMap();
$request = (new CreateServiceConnectionMapRequest())
->setParent($formattedParent)
->setServiceConnectionMap($serviceConnectionMap);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->createServiceConnectionMap($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServiceConnectionMap $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 = CrossNetworkAutomationServiceClient::locationName('[PROJECT]', '[LOCATION]');
create_service_connection_map_sample($formattedParent);
}
createServiceConnectionPolicy
Creates a new ServiceConnectionPolicy in a given project and location.
The async variant is CrossNetworkAutomationServiceClient::createServiceConnectionPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionPolicyRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionPolicyRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionPolicy;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource's name of the ServiceConnectionPolicy. ex.
* projects/123/locations/us-east1
* Please see {@see CrossNetworkAutomationServiceClient::locationName()} for help formatting this field.
*/
function create_service_connection_policy_sample(string $formattedParent): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$serviceConnectionPolicy = new ServiceConnectionPolicy();
$request = (new CreateServiceConnectionPolicyRequest())
->setParent($formattedParent)
->setServiceConnectionPolicy($serviceConnectionPolicy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->createServiceConnectionPolicy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServiceConnectionPolicy $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 = CrossNetworkAutomationServiceClient::locationName('[PROJECT]', '[LOCATION]');
create_service_connection_policy_sample($formattedParent);
}
createServiceConnectionToken
Creates a new ServiceConnectionToken in a given project and location.
The async variant is CrossNetworkAutomationServiceClient::createServiceConnectionTokenAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionTokenRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionTokenRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionToken;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource's name of the ServiceConnectionToken. ex.
* projects/123/locations/us-east1
* Please see {@see CrossNetworkAutomationServiceClient::locationName()} for help formatting this field.
*/
function create_service_connection_token_sample(string $formattedParent): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$serviceConnectionToken = new ServiceConnectionToken();
$request = (new CreateServiceConnectionTokenRequest())
->setParent($formattedParent)
->setServiceConnectionToken($serviceConnectionToken);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->createServiceConnectionToken($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServiceConnectionToken $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 = CrossNetworkAutomationServiceClient::locationName('[PROJECT]', '[LOCATION]');
create_service_connection_token_sample($formattedParent);
}
deleteServiceClass
Deletes a single ServiceClass.
The async variant is CrossNetworkAutomationServiceClient::deleteServiceClassAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceClassRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\DeleteServiceClassRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the ServiceClass to delete. Please see
* {@see CrossNetworkAutomationServiceClient::serviceClassName()} for help formatting this field.
*/
function delete_service_class_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new DeleteServiceClassRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->deleteServiceClass($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 = CrossNetworkAutomationServiceClient::serviceClassName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CLASS]'
);
delete_service_class_sample($formattedName);
}
deleteServiceConnectionMap
Deletes a single ServiceConnectionMap.
The async variant is CrossNetworkAutomationServiceClient::deleteServiceConnectionMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionMapRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionMapRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the ServiceConnectionMap to delete. Please see
* {@see CrossNetworkAutomationServiceClient::serviceConnectionMapName()} for help formatting this field.
*/
function delete_service_connection_map_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new DeleteServiceConnectionMapRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->deleteServiceConnectionMap($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 = CrossNetworkAutomationServiceClient::serviceConnectionMapName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CONNECTION_MAP]'
);
delete_service_connection_map_sample($formattedName);
}
deleteServiceConnectionPolicy
Deletes a single ServiceConnectionPolicy.
The async variant is CrossNetworkAutomationServiceClient::deleteServiceConnectionPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionPolicyRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionPolicyRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the ServiceConnectionPolicy to delete. Please see
* {@see CrossNetworkAutomationServiceClient::serviceConnectionPolicyName()} for help formatting this field.
*/
function delete_service_connection_policy_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new DeleteServiceConnectionPolicyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->deleteServiceConnectionPolicy($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 = CrossNetworkAutomationServiceClient::serviceConnectionPolicyName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CONNECTION_POLICY]'
);
delete_service_connection_policy_sample($formattedName);
}
deleteServiceConnectionToken
Deletes a single ServiceConnectionToken.
The async variant is CrossNetworkAutomationServiceClient::deleteServiceConnectionTokenAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionTokenRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionTokenRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the ServiceConnectionToken to delete. Please see
* {@see CrossNetworkAutomationServiceClient::serviceConnectionTokenName()} for help formatting this field.
*/
function delete_service_connection_token_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new DeleteServiceConnectionTokenRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->deleteServiceConnectionToken($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 = CrossNetworkAutomationServiceClient::serviceConnectionTokenName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CONNECTION_TOKEN]'
);
delete_service_connection_token_sample($formattedName);
}
getServiceClass
Gets details of a single ServiceClass.
The async variant is CrossNetworkAutomationServiceClient::getServiceClassAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceClassRequest
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\NetworkConnectivity\V1\ServiceClass |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetServiceClassRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceClass;
/**
* @param string $formattedName Name of the ServiceClass to get. Please see
* {@see CrossNetworkAutomationServiceClient::serviceClassName()} for help formatting this field.
*/
function get_service_class_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new GetServiceClassRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ServiceClass $response */
$response = $crossNetworkAutomationServiceClient->getServiceClass($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 = CrossNetworkAutomationServiceClient::serviceClassName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CLASS]'
);
get_service_class_sample($formattedName);
}
getServiceConnectionMap
Gets details of a single ServiceConnectionMap.
The async variant is CrossNetworkAutomationServiceClient::getServiceConnectionMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionMapRequest
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\NetworkConnectivity\V1\ServiceConnectionMap |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionMapRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionMap;
/**
* @param string $formattedName Name of the ServiceConnectionMap to get. Please see
* {@see CrossNetworkAutomationServiceClient::serviceConnectionMapName()} for help formatting this field.
*/
function get_service_connection_map_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new GetServiceConnectionMapRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ServiceConnectionMap $response */
$response = $crossNetworkAutomationServiceClient->getServiceConnectionMap($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 = CrossNetworkAutomationServiceClient::serviceConnectionMapName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CONNECTION_MAP]'
);
get_service_connection_map_sample($formattedName);
}
getServiceConnectionPolicy
Gets details of a single ServiceConnectionPolicy.
The async variant is CrossNetworkAutomationServiceClient::getServiceConnectionPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionPolicyRequest
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\NetworkConnectivity\V1\ServiceConnectionPolicy |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionPolicyRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionPolicy;
/**
* @param string $formattedName Name of the ServiceConnectionPolicy to get. Please see
* {@see CrossNetworkAutomationServiceClient::serviceConnectionPolicyName()} for help formatting this field.
*/
function get_service_connection_policy_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new GetServiceConnectionPolicyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ServiceConnectionPolicy $response */
$response = $crossNetworkAutomationServiceClient->getServiceConnectionPolicy($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 = CrossNetworkAutomationServiceClient::serviceConnectionPolicyName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CONNECTION_POLICY]'
);
get_service_connection_policy_sample($formattedName);
}
getServiceConnectionToken
Gets details of a single ServiceConnectionToken.
The async variant is CrossNetworkAutomationServiceClient::getServiceConnectionTokenAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionTokenRequest
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\NetworkConnectivity\V1\ServiceConnectionToken |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionTokenRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionToken;
/**
* @param string $formattedName Name of the ServiceConnectionToken to get. Please see
* {@see CrossNetworkAutomationServiceClient::serviceConnectionTokenName()} for help formatting this field.
*/
function get_service_connection_token_sample(string $formattedName): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new GetServiceConnectionTokenRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ServiceConnectionToken $response */
$response = $crossNetworkAutomationServiceClient->getServiceConnectionToken($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 = CrossNetworkAutomationServiceClient::serviceConnectionTokenName(
'[PROJECT]',
'[LOCATION]',
'[SERVICE_CONNECTION_TOKEN]'
);
get_service_connection_token_sample($formattedName);
}
listServiceClasses
Lists ServiceClasses in a given project and location.
The async variant is CrossNetworkAutomationServiceClient::listServiceClassesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceClassesRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListServiceClassesRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceClass;
/**
* @param string $formattedParent The parent resource's name. ex. projects/123/locations/us-east1
* Please see {@see CrossNetworkAutomationServiceClient::locationName()} for help formatting this field.
*/
function list_service_classes_sample(string $formattedParent): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new ListServiceClassesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $crossNetworkAutomationServiceClient->listServiceClasses($request);
/** @var ServiceClass $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 = CrossNetworkAutomationServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_service_classes_sample($formattedParent);
}
listServiceConnectionMaps
Lists ServiceConnectionMaps in a given project and location.
The async variant is CrossNetworkAutomationServiceClient::listServiceConnectionMapsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionMapsRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionMapsRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionMap;
/**
* @param string $formattedParent The parent resource's name. ex. projects/123/locations/us-east1
* Please see {@see CrossNetworkAutomationServiceClient::locationName()} for help formatting this field.
*/
function list_service_connection_maps_sample(string $formattedParent): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new ListServiceConnectionMapsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $crossNetworkAutomationServiceClient->listServiceConnectionMaps($request);
/** @var ServiceConnectionMap $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 = CrossNetworkAutomationServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_service_connection_maps_sample($formattedParent);
}
listServiceConnectionPolicies
Lists ServiceConnectionPolicies in a given project and location.
The async variant is CrossNetworkAutomationServiceClient::listServiceConnectionPoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionPoliciesRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionPoliciesRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionPolicy;
/**
* @param string $formattedParent The parent resource's name. ex. projects/123/locations/us-east1
* Please see {@see CrossNetworkAutomationServiceClient::locationName()} for help formatting this field.
*/
function list_service_connection_policies_sample(string $formattedParent): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new ListServiceConnectionPoliciesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $crossNetworkAutomationServiceClient->listServiceConnectionPolicies($request);
/** @var ServiceConnectionPolicy $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 = CrossNetworkAutomationServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_service_connection_policies_sample($formattedParent);
}
listServiceConnectionTokens
Lists ServiceConnectionTokens in a given project and location.
The async variant is CrossNetworkAutomationServiceClient::listServiceConnectionTokensAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionTokensRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionTokensRequest;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionToken;
/**
* @param string $formattedParent The parent resource's name. ex. projects/123/locations/us-east1
* Please see {@see CrossNetworkAutomationServiceClient::locationName()} for help formatting this field.
*/
function list_service_connection_tokens_sample(string $formattedParent): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new ListServiceConnectionTokensRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $crossNetworkAutomationServiceClient->listServiceConnectionTokens($request);
/** @var ServiceConnectionToken $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 = CrossNetworkAutomationServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_service_connection_tokens_sample($formattedParent);
}
updateServiceClass
Updates the parameters of a single ServiceClass.
The async variant is CrossNetworkAutomationServiceClient::updateServiceClassAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\UpdateServiceClassRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ServiceClass;
use Google\Cloud\NetworkConnectivity\V1\UpdateServiceClassRequest;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_service_class_sample(): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$serviceClass = new ServiceClass();
$request = (new UpdateServiceClassRequest())
->setServiceClass($serviceClass);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->updateServiceClass($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServiceClass $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());
}
}
updateServiceConnectionMap
Updates the parameters of a single ServiceConnectionMap.
The async variant is CrossNetworkAutomationServiceClient::updateServiceConnectionMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\UpdateServiceConnectionMapRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionMap;
use Google\Cloud\NetworkConnectivity\V1\UpdateServiceConnectionMapRequest;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_service_connection_map_sample(): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$serviceConnectionMap = new ServiceConnectionMap();
$request = (new UpdateServiceConnectionMapRequest())
->setServiceConnectionMap($serviceConnectionMap);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->updateServiceConnectionMap($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServiceConnectionMap $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());
}
}
updateServiceConnectionPolicy
Updates the parameters of a single ServiceConnectionPolicy.
The async variant is CrossNetworkAutomationServiceClient::updateServiceConnectionPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\UpdateServiceConnectionPolicyRequest
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\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ServiceConnectionPolicy;
use Google\Cloud\NetworkConnectivity\V1\UpdateServiceConnectionPolicyRequest;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_service_connection_policy_sample(): void
{
// Create a client.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$serviceConnectionPolicy = new ServiceConnectionPolicy();
$request = (new UpdateServiceConnectionPolicyRequest())
->setServiceConnectionPolicy($serviceConnectionPolicy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $crossNetworkAutomationServiceClient->updateServiceConnectionPolicy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServiceConnectionPolicy $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());
}
}
getLocation
Gets information about a location.
The async variant is CrossNetworkAutomationServiceClient::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\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
/**
* 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.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $crossNetworkAutomationServiceClient->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 CrossNetworkAutomationServiceClient::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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
/**
* 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.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $crossNetworkAutomationServiceClient->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 CrossNetworkAutomationServiceClient::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\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
/**
* @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.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $crossNetworkAutomationServiceClient->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 CrossNetworkAutomationServiceClient::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\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
/**
* @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.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// 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 = $crossNetworkAutomationServiceClient->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 CrossNetworkAutomationServiceClient::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\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\CrossNetworkAutomationServiceClient;
/**
* @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.
$crossNetworkAutomationServiceClient = new CrossNetworkAutomationServiceClient();
// 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 = $crossNetworkAutomationServiceClient->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);
}
createServiceConnectionMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionMapRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createServiceConnectionPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createServiceConnectionTokenAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\CreateServiceConnectionTokenRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteServiceClassAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceClassRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteServiceConnectionMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionMapRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteServiceConnectionPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteServiceConnectionTokenAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\DeleteServiceConnectionTokenRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getServiceClassAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceClassRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkConnectivity\V1\ServiceClass> |
getServiceConnectionMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionMapRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkConnectivity\V1\ServiceConnectionMap> |
getServiceConnectionPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkConnectivity\V1\ServiceConnectionPolicy> |
getServiceConnectionTokenAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\GetServiceConnectionTokenRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkConnectivity\V1\ServiceConnectionToken> |
listServiceClassesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceClassesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listServiceConnectionMapsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionMapsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listServiceConnectionPoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionPoliciesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listServiceConnectionTokensAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\ListServiceConnectionTokensRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
updateServiceClassAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\UpdateServiceClassRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
updateServiceConnectionMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\UpdateServiceConnectionMapRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
updateServiceConnectionPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkConnectivity\V1\UpdateServiceConnectionPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::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::networkName
Formats a string containing the fully-qualified path to represent a network resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
resourceId |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted network resource. |
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project resource. |
static::serviceAttachmentName
Formats a string containing the fully-qualified path to represent a service_attachment resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
region |
string
|
serviceAttachment |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted service_attachment resource. |
static::serviceClassName
Formats a string containing the fully-qualified path to represent a service_class resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
serviceClass |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted service_class resource. |
static::serviceConnectionMapName
Formats a string containing the fully-qualified path to represent a service_connection_map resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
serviceConnectionMap |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted service_connection_map resource. |
static::serviceConnectionPolicyName
Formats a string containing the fully-qualified path to represent a service_connection_policy resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
serviceConnectionPolicy |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted service_connection_policy resource. |
static::serviceConnectionTokenName
Formats a string containing the fully-qualified path to represent a service_connection_token resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
serviceConnectionToken |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted service_connection_token resource. |
static::subnetworkName
Formats a string containing the fully-qualified path to represent a subnetwork resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
region |
string
|
subnetwork |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted subnetwork 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
- location: projects/{project}/locations/{location}
- network: projects/{project}/global/networks/{resource_id}
- project: projects/{project}
- serviceAttachment: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
- serviceClass: projects/{project}/locations/{location}/serviceClasses/{service_class}
- serviceConnectionMap: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}
- serviceConnectionPolicy: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy}
- serviceConnectionToken: projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_token}
- subnetwork: projects/{project}/regions/{region}/subnetworks/{subnetwork}
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. |