Google Cloud Network Connectivity V1 Client - Class HubServiceClient (2.0.1)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class HubServiceClient.

Service Description: Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.

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 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

acceptHubSpoke

Accepts a proposal to attach a Network Connectivity Center spoke to a hub.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::acceptHubSpokeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\AcceptHubSpokeRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\AcceptHubSpokeRequest;
use Google\Cloud\NetworkConnectivity\V1\AcceptHubSpokeResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName     The name of the hub into which to accept the spoke. Please see
 *                                  {@see HubServiceClient::hubName()} for help formatting this field.
 * @param string $formattedSpokeUri The URI of the spoke to accept into the hub. Please see
 *                                  {@see HubServiceClient::spokeName()} for help formatting this field.
 */
function accept_hub_spoke_sample(string $formattedName, string $formattedSpokeUri): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new AcceptHubSpokeRequest())
        ->setName($formattedName)
        ->setSpokeUri($formattedSpokeUri);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->acceptHubSpoke($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AcceptHubSpokeResponse $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
{
    $formattedName = HubServiceClient::hubName('[PROJECT]', '[HUB]');
    $formattedSpokeUri = HubServiceClient::spokeName('[PROJECT]', '[LOCATION]', '[SPOKE]');

    accept_hub_spoke_sample($formattedName, $formattedSpokeUri);
}

createHub

Creates a new Network Connectivity Center hub in the specified project.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::createHubAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\CreateHubRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\CreateHubRequest;
use Google\Cloud\NetworkConnectivity\V1\Hub;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource. Please see
 *                                {@see HubServiceClient::locationName()} for help formatting this field.
 * @param string $hubId           A unique identifier for the hub.
 */
function create_hub_sample(string $formattedParent, string $hubId): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $hub = new Hub();
    $request = (new CreateHubRequest())
        ->setParent($formattedParent)
        ->setHubId($hubId)
        ->setHub($hub);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->createHub($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Hub $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 = HubServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $hubId = '[HUB_ID]';

    create_hub_sample($formattedParent, $hubId);
}

createSpoke

Creates a Network Connectivity Center spoke.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::createSpokeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\CreateSpokeRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\CreateSpokeRequest;
use Google\Cloud\NetworkConnectivity\V1\Spoke;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource. Please see
 *                                {@see HubServiceClient::locationName()} for help formatting this field.
 * @param string $spokeId         Unique id for the spoke to create.
 */
function create_spoke_sample(string $formattedParent, string $spokeId): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $spoke = new Spoke();
    $request = (new CreateSpokeRequest())
        ->setParent($formattedParent)
        ->setSpokeId($spokeId)
        ->setSpoke($spoke);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->createSpoke($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Spoke $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 = HubServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $spokeId = '[SPOKE_ID]';

    create_spoke_sample($formattedParent, $spokeId);
}

deleteHub

Deletes a Network Connectivity Center hub.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::deleteHubAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\DeleteHubRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\DeleteHubRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the hub to delete. Please see
 *                              {@see HubServiceClient::hubName()} for help formatting this field.
 */
function delete_hub_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new DeleteHubRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->deleteHub($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 = HubServiceClient::hubName('[PROJECT]', '[HUB]');

    delete_hub_sample($formattedName);
}

deleteSpoke

Deletes a Network Connectivity Center spoke.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::deleteSpokeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\DeleteSpokeRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\DeleteSpokeRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the spoke to delete. Please see
 *                              {@see HubServiceClient::spokeName()} for help formatting this field.
 */
function delete_spoke_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new DeleteSpokeRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->deleteSpoke($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 = HubServiceClient::spokeName('[PROJECT]', '[LOCATION]', '[SPOKE]');

    delete_spoke_sample($formattedName);
}

getGroup

Gets details about a Network Connectivity Center group.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::getGroupAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetGroupRequest` 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\Group`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetGroupRequest;
use Google\Cloud\NetworkConnectivity\V1\Group;

/**
 * @param string $formattedName The name of the route table resource. Please see
 *                              {@see HubServiceClient::groupName()} for help formatting this field.
 */
function get_group_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new GetGroupRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Group $response */
        $response = $hubServiceClient->getGroup($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 = HubServiceClient::groupName('[PROJECT]', '[HUB]', '[GROUP]');

    get_group_sample($formattedName);
}

getHub

Gets details about a Network Connectivity Center hub.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::getHubAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetHubRequest` 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\Hub`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetHubRequest;
use Google\Cloud\NetworkConnectivity\V1\Hub;

/**
 * @param string $formattedName The name of the hub resource to get. Please see
 *                              {@see HubServiceClient::hubName()} for help formatting this field.
 */
function get_hub_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new GetHubRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Hub $response */
        $response = $hubServiceClient->getHub($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 = HubServiceClient::hubName('[PROJECT]', '[HUB]');

    get_hub_sample($formattedName);
}

getRoute

Gets details about the specified route.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::getRouteAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetRouteRequest` 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\Route`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetRouteRequest;
use Google\Cloud\NetworkConnectivity\V1\Route;

/**
 * @param string $formattedName The name of the route resource. Please see
 *                              {@see HubServiceClient::hubRouteName()} for help formatting this field.
 */
function get_route_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new GetRouteRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Route $response */
        $response = $hubServiceClient->getRoute($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 = HubServiceClient::hubRouteName('[PROJECT]', '[HUB]', '[ROUTE_TABLE]', '[ROUTE]');

    get_route_sample($formattedName);
}

getRouteTable

Gets details about a Network Connectivity Center route table.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::getRouteTableAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetRouteTableRequest` 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\RouteTable`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetRouteTableRequest;
use Google\Cloud\NetworkConnectivity\V1\RouteTable;

/**
 * @param string $formattedName The name of the route table resource. Please see
 *                              {@see HubServiceClient::routeTableName()} for help formatting this field.
 */
function get_route_table_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new GetRouteTableRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var RouteTable $response */
        $response = $hubServiceClient->getRouteTable($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 = HubServiceClient::routeTableName('[PROJECT]', '[HUB]', '[ROUTE_TABLE]');

    get_route_table_sample($formattedName);
}

getSpoke

Gets details about a Network Connectivity Center spoke.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::getSpokeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetSpokeRequest` 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\Spoke`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\GetSpokeRequest;
use Google\Cloud\NetworkConnectivity\V1\Spoke;

/**
 * @param string $formattedName The name of the spoke resource. Please see
 *                              {@see HubServiceClient::spokeName()} for help formatting this field.
 */
function get_spoke_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new GetSpokeRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Spoke $response */
        $response = $hubServiceClient->getSpoke($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 = HubServiceClient::spokeName('[PROJECT]', '[LOCATION]', '[SPOKE]');

    get_spoke_sample($formattedName);
}

listGroups

Lists groups in a given hub.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::listGroupsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListGroupsRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\Group;
use Google\Cloud\NetworkConnectivity\V1\ListGroupsRequest;

/**
 * @param string $formattedParent The parent resource's name. Please see
 *                                {@see HubServiceClient::hubName()} for help formatting this field.
 */
function list_groups_sample(string $formattedParent): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new ListGroupsRequest())
        ->setParent($formattedParent);

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

        /** @var Group $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 = HubServiceClient::hubName('[PROJECT]', '[HUB]');

    list_groups_sample($formattedParent);
}

listHubSpokes

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::listHubSpokesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListHubSpokesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListHubSpokesRequest;
use Google\Cloud\NetworkConnectivity\V1\Spoke;

/**
 * @param string $formattedName The name of the hub. Please see
 *                              {@see HubServiceClient::hubName()} for help formatting this field.
 */
function list_hub_spokes_sample(string $formattedName): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new ListHubSpokesRequest())
        ->setName($formattedName);

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

        /** @var Spoke $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
{
    $formattedName = HubServiceClient::hubName('[PROJECT]', '[HUB]');

    list_hub_spokes_sample($formattedName);
}

listHubs

Lists the Network Connectivity Center hubs associated with a given project.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::listHubsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListHubsRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\Hub;
use Google\Cloud\NetworkConnectivity\V1\ListHubsRequest;

/**
 * @param string $formattedParent The parent resource's name. Please see
 *                                {@see HubServiceClient::locationName()} for help formatting this field.
 */
function list_hubs_sample(string $formattedParent): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new ListHubsRequest())
        ->setParent($formattedParent);

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

        /** @var Hub $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 = HubServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_hubs_sample($formattedParent);
}

listRouteTables

Lists route tables in a given project.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::listRouteTablesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListRouteTablesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListRouteTablesRequest;
use Google\Cloud\NetworkConnectivity\V1\RouteTable;

/**
 * @param string $formattedParent The parent resource's name. Please see
 *                                {@see HubServiceClient::hubName()} for help formatting this field.
 */
function list_route_tables_sample(string $formattedParent): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new ListRouteTablesRequest())
        ->setParent($formattedParent);

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

        /** @var RouteTable $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 = HubServiceClient::hubName('[PROJECT]', '[HUB]');

    list_route_tables_sample($formattedParent);
}

listRoutes

Lists routes in a given project.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::listRoutesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListRoutesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListRoutesRequest;
use Google\Cloud\NetworkConnectivity\V1\Route;

/**
 * @param string $formattedParent The parent resource's name. Please see
 *                                {@see HubServiceClient::routeTableName()} for help formatting this field.
 */
function list_routes_sample(string $formattedParent): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new ListRoutesRequest())
        ->setParent($formattedParent);

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

        /** @var Route $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 = HubServiceClient::routeTableName('[PROJECT]', '[HUB]', '[ROUTE_TABLE]');

    list_routes_sample($formattedParent);
}

listSpokes

Lists the Network Connectivity Center spokes in a specified project and location.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::listSpokesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListSpokesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\ListSpokesRequest;
use Google\Cloud\NetworkConnectivity\V1\Spoke;

/**
 * @param string $formattedParent The parent resource. Please see
 *                                {@see HubServiceClient::locationName()} for help formatting this field.
 */
function list_spokes_sample(string $formattedParent): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new ListSpokesRequest())
        ->setParent($formattedParent);

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

        /** @var Spoke $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 = HubServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_spokes_sample($formattedParent);
}

rejectHubSpoke

Rejects a Network Connectivity Center spoke from being attached to a hub.

If the spoke was previously in the ACTIVE state, it transitions to the INACTIVE state and is no longer able to connect to other spokes that are attached to the hub.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::rejectHubSpokeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\RejectHubSpokeRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\RejectHubSpokeRequest;
use Google\Cloud\NetworkConnectivity\V1\RejectHubSpokeResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName     The name of the hub from which to reject the spoke. Please see
 *                                  {@see HubServiceClient::hubName()} for help formatting this field.
 * @param string $formattedSpokeUri The URI of the spoke to reject from the hub. Please see
 *                                  {@see HubServiceClient::spokeName()} for help formatting this field.
 */
function reject_hub_spoke_sample(string $formattedName, string $formattedSpokeUri): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new RejectHubSpokeRequest())
        ->setName($formattedName)
        ->setSpokeUri($formattedSpokeUri);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->rejectHubSpoke($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var RejectHubSpokeResponse $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
{
    $formattedName = HubServiceClient::hubName('[PROJECT]', '[HUB]');
    $formattedSpokeUri = HubServiceClient::spokeName('[PROJECT]', '[LOCATION]', '[SPOKE]');

    reject_hub_spoke_sample($formattedName, $formattedSpokeUri);
}

updateHub

Updates the description and/or labels of a Network Connectivity Center hub.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::updateHubAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\UpdateHubRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\Hub;
use Google\Cloud\NetworkConnectivity\V1\UpdateHubRequest;
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_hub_sample(): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $hub = new Hub();
    $request = (new UpdateHubRequest())
        ->setHub($hub);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->updateHub($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Hub $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());
    }
}

updateSpoke

Updates the parameters of a Network Connectivity Center spoke.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::updateSpokeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\UpdateSpokeRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\Spoke;
use Google\Cloud\NetworkConnectivity\V1\UpdateSpokeRequest;
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_spoke_sample(): void
{
    // Create a client.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $spoke = new Spoke();
    $request = (new UpdateSpokeRequest())
        ->setSpoke($spoke);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $hubServiceClient->updateSpoke($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Spoke $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 Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;

/**
 * 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.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;

/**
 * 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.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;

/**
 * @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.
    $hubServiceClient = new HubServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;

/**
 * @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.
    $hubServiceClient = new HubServiceClient();

    // 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 = $hubServiceClient->setIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient;

/**
 * @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.
    $hubServiceClient = new HubServiceClient();

    // 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 = $hubServiceClient->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);
}

acceptHubSpokeAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\AcceptHubSpokeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createHubAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\CreateHubRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createSpokeAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\CreateSpokeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteHubAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\DeleteHubRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSpokeAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\DeleteSpokeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getGroupAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetGroupRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getHubAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetHubRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getRouteAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetRouteRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getRouteTableAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetRouteTableRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSpokeAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetSpokeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listGroupsAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListGroupsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listHubSpokesAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListHubSpokesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listHubsAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListHubsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listRouteTablesAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListRouteTablesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listRoutesAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListRoutesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSpokesAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListSpokesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

rejectHubSpokeAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\RejectHubSpokeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateHubAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\UpdateHubRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateSpokeAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\UpdateSpokeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIamPolicyAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setIamPolicyAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

testIamPermissionsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\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::groupName

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

Parameters
Name	Description
`project`	`string`
`hub`	`string`
`group`	`string`

Returns
Type	Description
`string`	The formatted group resource.

static::hubName

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

Parameters
Name	Description
`project`	`string`
`hub`	`string`

Returns
Type	Description
`string`	The formatted hub resource.

static::hubRouteName

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

Parameters
Name	Description
`project`	`string`
`hub`	`string`
`routeTable`	`string`
`route`	`string`

Returns
Type	Description
`string`	The formatted hub_route resource.

static::instanceName

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

Parameters
Name	Description
`project`	`string`
`zone`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted instance resource.

static::interconnectAttachmentName

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

Parameters
Name	Description
`project`	`string`
`region`	`string`
`resourceId`	`string`

Returns
Type	Description
`string`	The formatted interconnect_attachment resource.

static::locationName

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

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

Returns
Type	Description
`string`	The formatted location resource.

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

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

Parameters
Name	Description
`project`	`string`
`hub`	`string`
`routeTable`	`string`

Returns
Type	Description
`string`	The formatted route_table resource.

static::spokeName

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

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

Returns
Type	Description
`string`	The formatted spoke resource.

static::vpnTunnelName

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

Parameters
Name	Description
`project`	`string`
`region`	`string`
`resourceId`	`string`

Returns
Type	Description
`string`	The formatted vpn_tunnel 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

group: projects/{project}/locations/global/hubs/{hub}/groups/{group}
hub: projects/{project}/locations/global/hubs/{hub}
hubRoute: projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}
instance: projects/{project}/zones/{zone}/instances/{instance}
interconnectAttachment: projects/{project}/regions/{region}/interconnectAttachments/{resource_id}
location: projects/{project}/locations/{location}
network: projects/{project}/global/networks/{resource_id}
routeTable: projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}
spoke: projects/{project}/locations/{location}/spokes/{spoke}
vpnTunnel: projects/{project}/regions/{region}/vpnTunnels/{resource_id}

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.