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

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 is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ NetworkConnectivity \ V1 \ Client

Methods

__construct

Constructor.

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

createHub

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

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\CreateHubRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createSpoke

Creates a Network Connectivity Center spoke.

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\CreateSpokeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteHub

Deletes a Network Connectivity Center hub.

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\DeleteHubRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteSpoke

Deletes a Network Connectivity Center spoke.

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\DeleteSpokeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getHub

Gets details about a Network Connectivity Center hub.

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetHubRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\NetworkConnectivity\V1\Hub`

getSpoke

Gets details about a Network Connectivity Center spoke.

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\GetSpokeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\NetworkConnectivity\V1\Spoke`

listHubs

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

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListHubsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listSpokes

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

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\ListSpokesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateHub

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

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\UpdateHubRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updateSpoke

Updates the parameters of a Network Connectivity Center spoke.

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

Parameters
Name	Description
`request`	`Google\Cloud\NetworkConnectivity\V1\UpdateSpokeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createHubAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createSpokeAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteHubAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSpokeAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getHubAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSpokeAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listHubsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSpokesAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateHubAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateSpokeAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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

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.

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.