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 {
$formattedParent = $hubServiceClient->locationName('[PROJECT]', '[LOCATION]');
$hubId = 'hub_id';
$hub = new Hub();
$operationResponse = $hubServiceClient->createHub($formattedParent, $hubId, $hub);
$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->createHub($formattedParent, $hubId, $hub);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $hubServiceClient->resumeOperation($operationName, 'createHub');
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.
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.
createHub
Creates a new Network Connectivity Center hub in the specified project.
parent
string
Required. The parent resource.
hubId
string
Required. A unique identifier for the hub.
hub
optionalArgs
array
Optional.
↳ requestId
string
Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. 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.
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.
parent
string
Required. The parent resource.
spokeId
string
Required. Unique id for the spoke to create.
spoke
optionalArgs
array
Optional.
↳ requestId
string
Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. 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.
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.
name
string
Required. The name of the hub to delete.
optionalArgs
array
Optional.
↳ requestId
string
Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. 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.
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.
name
string
Required. The name of the spoke to delete.
optionalArgs
array
Optional.
↳ requestId
string
Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. 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.
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);
}
getHub
Gets details about a Network Connectivity Center hub.
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.
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);
}
getSpoke
Gets details about a Network Connectivity Center spoke.
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.
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);
}
listHubs
Lists the Network Connectivity Center hubs associated with a given project.
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 results listed in the response.
↳ 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.
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);
}
listSpokes
Lists the Network Connectivity Center spokes in a specified project and location.
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 results listed in the response.
↳ 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.
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);
}
updateHub
Updates the description and/or labels of a Network Connectivity Center hub.
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 unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. 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.
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.
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 unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. 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.
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());
}
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::hubName
Formats a string containing the fully-qualified path to represent a hub resource.
project
string
hub
string
string
static::instanceName
Formats a string containing the fully-qualified path to represent a instance resource.
project
string
zone
string
instance
string
string
static::interconnectAttachmentName
Formats a string containing the fully-qualified path to represent a interconnect_attachment resource.
project
string
region
string
resourceId
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::networkName
Formats a string containing the fully-qualified path to represent a network resource.
project
string
resourceId
string
string
static::spokeName
Formats a string containing the fully-qualified path to represent a spoke resource.
project
string
location
string
spoke
string
string
static::vpnTunnelName
Formats a string containing the fully-qualified path to represent a vpn_tunnel resource.
project
string
region
string
resourceId
string
string
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
- hub: projects/{project}/locations/global/hubs/{hub}
- 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}
- 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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
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: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.
