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. Sample code to get started:
$hubServiceClient = new HubServiceClient();
try {
$formattedName = $hubServiceClient->hubName('[PROJECT]', '[HUB]');
$formattedSpokeUri = $hubServiceClient->spokeName('[PROJECT]', '[LOCATION]', '[SPOKE]');
$operationResponse = $hubServiceClient->acceptHubSpoke($formattedName, $formattedSpokeUri);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $hubServiceClient->acceptHubSpoke($formattedName, $formattedSpokeUri);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $hubServiceClient->resumeOperation($operationName, 'acceptHubSpoke');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$hubServiceClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\NetworkConnectivity\V1\Client\HubServiceClient to use the new surface.
Namespace
Google \ Cloud \ NetworkConnectivity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
acceptHubSpoke
Accepts a proposal to attach a Network Connectivity Center spoke to a hub.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the hub into which to accept the spoke. |
spokeUri |
string
Required. The URI of the spoke to accept into the hub. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ 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\AcceptHubSpokeResponse;
use Google\Cloud\NetworkConnectivity\V1\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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->acceptHubSpoke($formattedName, $formattedSpokeUri);
$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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource. |
hubId |
string
Required. A unique identifier for the hub. |
hub |
Google\Cloud\NetworkConnectivity\V1\Hub
Required. The initial values for a new hub. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ 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\Hub;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
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 any non-scalar elements to be passed along with the request.
$hub = new Hub();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->createHub($formattedParent, $hubId, $hub);
$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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource. |
spokeId |
string
Required. Unique id for the spoke to create. |
spoke |
Google\Cloud\NetworkConnectivity\V1\Spoke
Required. The initial values for a new spoke. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ 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\HubServiceClient;
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 any non-scalar elements to be passed along with the request.
$spoke = new Spoke();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->createSpoke($formattedParent, $spokeId, $spoke);
$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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the hub to delete. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ 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\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->deleteHub($formattedName);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the spoke to delete. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ 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\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->deleteSpoke($formattedName);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the route table resource. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkConnectivity\V1\Group | |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Group;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var Group $response */
$response = $hubServiceClient->getGroup($formattedName);
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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the hub resource to get. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkConnectivity\V1\Hub | |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\Hub;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var Hub $response */
$response = $hubServiceClient->getHub($formattedName);
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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the route resource. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkConnectivity\V1\Route | |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var Route $response */
$response = $hubServiceClient->getRoute($formattedName);
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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the route table resource. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkConnectivity\V1\RouteTable | |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var RouteTable $response */
$response = $hubServiceClient->getRouteTable($formattedName);
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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the spoke resource. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkConnectivity\V1\Spoke | |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var Spoke $response */
$response = $hubServiceClient->getSpoke($formattedName);
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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource's name. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
An expression that filters the list of results. |
↳ orderBy |
string
Sort the results by a certain order. |
↳ 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\Group;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hubServiceClient->listGroups($formattedParent);
/** @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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the hub. |
optionalArgs |
array
Optional. |
↳ spokeLocations |
string[]
A list of locations. Specify one of the following: |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
An expression that filters the list of results. |
↳ orderBy |
string
Sort the results by name or create_time. |
↳ view |
int
The view of the spoke to return. The view that you use determines which spoke fields are included in the response. For allowed values, use constants defined on Google\Cloud\NetworkConnectivity\V1\ListHubSpokesRequest\SpokeView |
↳ 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\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hubServiceClient->listHubSpokes($formattedName);
/** @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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource's name. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
An expression that filters the list of results. |
↳ orderBy |
string
Sort the results by a certain order. |
↳ 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\Hub;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hubServiceClient->listHubs($formattedParent);
/** @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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource's name. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
An expression that filters the list of results. |
↳ orderBy |
string
Sort the results by a certain order. |
↳ 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\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hubServiceClient->listRouteTables($formattedParent);
/** @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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource's name. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
An expression that filters the list of results. |
↳ orderBy |
string
Sort the results by a certain order. |
↳ 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\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hubServiceClient->listRoutes($formattedParent);
/** @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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
An expression that filters the list of results. |
↳ orderBy |
string
Sort the results by a certain order. |
↳ 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\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hubServiceClient->listSpokes($formattedParent);
/** @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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the hub from which to reject the spoke. |
spokeUri |
string
Required. The URI of the spoke to reject from the hub. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ details |
string
Optional. Additional information provided by the hub administrator. |
↳ 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\HubServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->rejectHubSpoke($formattedName, $formattedSpokeUri);
$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.
| Parameters | |
|---|---|
| Name | Description |
hub |
Google\Cloud\NetworkConnectivity\V1\Hub
Required. The state that the hub should be in after the update. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Optional. In the case of an update to an existing hub, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ 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\Hub;
use Google\Cloud\NetworkConnectivity\V1\HubServiceClient;
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 any non-scalar elements to be passed along with the request.
$hub = new Hub();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->updateHub($hub);
$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.
| Parameters | |
|---|---|
| Name | Description |
spoke |
Google\Cloud\NetworkConnectivity\V1\Spoke
Required. The state that the spoke should be in after the update. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Optional. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ 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\HubServiceClient;
use Google\Cloud\NetworkConnectivity\V1\Spoke;
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 any non-scalar elements to be passed along with the request.
$spoke = new Spoke();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hubServiceClient->updateSpoke($spoke);
$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.
| Parameters | |
|---|---|
| Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Location\Location | |
use Google\ApiCore\ApiException;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkConnectivity\V1\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();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $hubServiceClient->getLocation();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkConnectivity\V1\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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hubServiceClient->listLocations();
/** @var Location $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy | |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkConnectivity\V1\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();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $hubServiceClient->getIamPolicy($resource);
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.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy | |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkConnectivity\V1\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 any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $hubServiceClient->setIamPolicy($resource, $policy);
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.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse | |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkConnectivity\V1\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 any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $hubServiceClient->testIamPermissions($resource, $permissions);
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);
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\LongRunning\OperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
static::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. |
Constants
SERVICE_NAME
Value: 'google.cloud.networkconnectivity.v1.HubService'The name of the service.
SERVICE_ADDRESS
Value: 'networkconnectivity.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.