Reference documentation and code samples for the Compute V1 Client class GlobalNetworkEndpointGroupsClient.
Service Description: The GlobalNetworkEndpointGroups API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
attachNetworkEndpoints
Attach a network endpoint to the specified network endpoint group.
The async variant is GlobalNetworkEndpointGroupsClient::attachNetworkEndpointsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\Client\GlobalNetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\GlobalNetworkEndpointGroupsAttachEndpointsRequest;
use Google\Rpc\Status;
/**
* @param string $networkEndpointGroup The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
* @param string $project Project ID for this request.
*/
function attach_network_endpoints_sample(string $networkEndpointGroup, string $project): void
{
// Create a client.
$globalNetworkEndpointGroupsClient = new GlobalNetworkEndpointGroupsClient();
// Prepare the request message.
$globalNetworkEndpointGroupsAttachEndpointsRequestResource = new GlobalNetworkEndpointGroupsAttachEndpointsRequest();
$request = (new AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest())
->setGlobalNetworkEndpointGroupsAttachEndpointsRequestResource(
$globalNetworkEndpointGroupsAttachEndpointsRequestResource
)
->setNetworkEndpointGroup($networkEndpointGroup)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $globalNetworkEndpointGroupsClient->attachNetworkEndpoints($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
$project = '[PROJECT]';
attach_network_endpoints_sample($networkEndpointGroup, $project);
}
delete
Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.
The async variant is GlobalNetworkEndpointGroupsClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteGlobalNetworkEndpointGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalNetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\DeleteGlobalNetworkEndpointGroupRequest;
use Google\Rpc\Status;
/**
* @param string $networkEndpointGroup The name of the network endpoint group to delete. It should comply with RFC1035.
* @param string $project Project ID for this request.
*/
function delete_sample(string $networkEndpointGroup, string $project): void
{
// Create a client.
$globalNetworkEndpointGroupsClient = new GlobalNetworkEndpointGroupsClient();
// Prepare the request message.
$request = (new DeleteGlobalNetworkEndpointGroupRequest())
->setNetworkEndpointGroup($networkEndpointGroup)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $globalNetworkEndpointGroupsClient->delete($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
$project = '[PROJECT]';
delete_sample($networkEndpointGroup, $project);
}
detachNetworkEndpoints
Detach the network endpoint from the specified network endpoint group.
The async variant is GlobalNetworkEndpointGroupsClient::detachNetworkEndpointsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalNetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\GlobalNetworkEndpointGroupsDetachEndpointsRequest;
use Google\Rpc\Status;
/**
* @param string $networkEndpointGroup The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
* @param string $project Project ID for this request.
*/
function detach_network_endpoints_sample(string $networkEndpointGroup, string $project): void
{
// Create a client.
$globalNetworkEndpointGroupsClient = new GlobalNetworkEndpointGroupsClient();
// Prepare the request message.
$globalNetworkEndpointGroupsDetachEndpointsRequestResource = new GlobalNetworkEndpointGroupsDetachEndpointsRequest();
$request = (new DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest())
->setGlobalNetworkEndpointGroupsDetachEndpointsRequestResource(
$globalNetworkEndpointGroupsDetachEndpointsRequestResource
)
->setNetworkEndpointGroup($networkEndpointGroup)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $globalNetworkEndpointGroupsClient->detachNetworkEndpoints($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
$project = '[PROJECT]';
detach_network_endpoints_sample($networkEndpointGroup, $project);
}
get
Returns the specified network endpoint group.
The async variant is GlobalNetworkEndpointGroupsClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetGlobalNetworkEndpointGroupRequest
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\Compute\V1\NetworkEndpointGroup |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\GlobalNetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\GetGlobalNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\NetworkEndpointGroup;
/**
* @param string $networkEndpointGroup The name of the network endpoint group. It should comply with RFC1035.
* @param string $project Project ID for this request.
*/
function get_sample(string $networkEndpointGroup, string $project): void
{
// Create a client.
$globalNetworkEndpointGroupsClient = new GlobalNetworkEndpointGroupsClient();
// Prepare the request message.
$request = (new GetGlobalNetworkEndpointGroupRequest())
->setNetworkEndpointGroup($networkEndpointGroup)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var NetworkEndpointGroup $response */
$response = $globalNetworkEndpointGroupsClient->get($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
$project = '[PROJECT]';
get_sample($networkEndpointGroup, $project);
}
insert
Creates a network endpoint group in the specified project using the parameters that are included in the request.
The async variant is GlobalNetworkEndpointGroupsClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertGlobalNetworkEndpointGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalNetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\InsertGlobalNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\NetworkEndpointGroup;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
*/
function insert_sample(string $project): void
{
// Create a client.
$globalNetworkEndpointGroupsClient = new GlobalNetworkEndpointGroupsClient();
// Prepare the request message.
$networkEndpointGroupResource = new NetworkEndpointGroup();
$request = (new InsertGlobalNetworkEndpointGroupRequest())
->setNetworkEndpointGroupResource($networkEndpointGroupResource)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $globalNetworkEndpointGroupsClient->insert($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
insert_sample($project);
}
list
Retrieves the list of network endpoint groups that are located in the specified project.
The async variant is GlobalNetworkEndpointGroupsClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListGlobalNetworkEndpointGroupsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\GlobalNetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\ListGlobalNetworkEndpointGroupsRequest;
/**
* @param string $project Project ID for this request.
*/
function list_sample(string $project): void
{
// Create a client.
$globalNetworkEndpointGroupsClient = new GlobalNetworkEndpointGroupsClient();
// Prepare the request message.
$request = (new ListGlobalNetworkEndpointGroupsRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $globalNetworkEndpointGroupsClient->list($request);
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
{
$project = '[PROJECT]';
list_sample($project);
}
listNetworkEndpoints
Lists the network endpoints in the specified network endpoint group.
The async variant is GlobalNetworkEndpointGroupsClient::listNetworkEndpointsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\GlobalNetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest;
/**
* @param string $networkEndpointGroup The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
* @param string $project Project ID for this request.
*/
function list_network_endpoints_sample(string $networkEndpointGroup, string $project): void
{
// Create a client.
$globalNetworkEndpointGroupsClient = new GlobalNetworkEndpointGroupsClient();
// Prepare the request message.
$request = (new ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest())
->setNetworkEndpointGroup($networkEndpointGroup)
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $globalNetworkEndpointGroupsClient->listNetworkEndpoints($request);
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
{
$networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
$project = '[PROJECT]';
list_network_endpoints_sample($networkEndpointGroup, $project);
}
attachNetworkEndpointsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteGlobalNetworkEndpointGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
detachNetworkEndpointsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetGlobalNetworkEndpointGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\NetworkEndpointGroup> |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertGlobalNetworkEndpointGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListGlobalNetworkEndpointGroupsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listNetworkEndpointsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
getOperationsClient
Return an GlobalOperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\GlobalOperationsClient |
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 |