Reference documentation and code samples for the Google Cloud Network Security V1 Client class OrganizationAddressGroupServiceClient.
Service Description: Organization AddressGroup is created under organization. Requests against Organization AddressGroup will use project from request credential for activation/quota/visibility check.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ NetworkSecurity \ 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. 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
addAddressGroupItems
Adds items to an address group.
The async variant is OrganizationAddressGroupServiceClient::addAddressGroupItemsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\AddAddressGroupItemsRequest
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\NetworkSecurity\V1\AddAddressGroupItemsRequest;
use Google\Cloud\NetworkSecurity\V1\AddressGroup;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedAddressGroup A name of the AddressGroup to add items to. Must be in the format
* `projects|organization/*/locations/{location}/addressGroups/*`. Please see
* {@see OrganizationAddressGroupServiceClient::addressGroupName()} for help formatting this field.
* @param string $itemsElement List of items to add.
*/
function add_address_group_items_sample(string $formattedAddressGroup, string $itemsElement): void
{
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$items = [$itemsElement,];
$request = (new AddAddressGroupItemsRequest())
->setAddressGroup($formattedAddressGroup)
->setItems($items);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $organizationAddressGroupServiceClient->addAddressGroupItems($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AddressGroup $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
{
$formattedAddressGroup = OrganizationAddressGroupServiceClient::addressGroupName(
'[PROJECT]',
'[LOCATION]',
'[ADDRESS_GROUP]'
);
$itemsElement = '[ITEMS]';
add_address_group_items_sample($formattedAddressGroup, $itemsElement);
}
cloneAddressGroupItems
Clones items from one address group to another.
The async variant is OrganizationAddressGroupServiceClient::cloneAddressGroupItemsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\CloneAddressGroupItemsRequest
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\NetworkSecurity\V1\AddressGroup;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\CloneAddressGroupItemsRequest;
use Google\Rpc\Status;
/**
* @param string $formattedAddressGroup A name of the AddressGroup to clone items to. Must be in the
* format `projects|organization/*/locations/{location}/addressGroups/*`. Please see
* {@see OrganizationAddressGroupServiceClient::addressGroupName()} for help formatting this field.
* @param string $formattedSourceAddressGroup Source address group to clone items from. Please see
* {@see OrganizationAddressGroupServiceClient::addressGroupName()} for help formatting this field.
*/
function clone_address_group_items_sample(
string $formattedAddressGroup,
string $formattedSourceAddressGroup
): void {
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = (new CloneAddressGroupItemsRequest())
->setAddressGroup($formattedAddressGroup)
->setSourceAddressGroup($formattedSourceAddressGroup);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $organizationAddressGroupServiceClient->cloneAddressGroupItems($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AddressGroup $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
{
$formattedAddressGroup = OrganizationAddressGroupServiceClient::addressGroupName(
'[PROJECT]',
'[LOCATION]',
'[ADDRESS_GROUP]'
);
$formattedSourceAddressGroup = OrganizationAddressGroupServiceClient::addressGroupName(
'[PROJECT]',
'[LOCATION]',
'[ADDRESS_GROUP]'
);
clone_address_group_items_sample($formattedAddressGroup, $formattedSourceAddressGroup);
}
createAddressGroup
Creates a new address group in a given project and location.
The async variant is OrganizationAddressGroupServiceClient::createAddressGroupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\CreateAddressGroupRequest
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\NetworkSecurity\V1\AddressGroup;
use Google\Cloud\NetworkSecurity\V1\AddressGroup\Type;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\CreateAddressGroupRequest;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource of the AddressGroup. Must be in the
* format `projects/*/locations/{location}`. Please see
* {@see OrganizationAddressGroupServiceClient::organizationLocationName()} for help formatting this field.
* @param string $addressGroupId Short name of the AddressGroup resource to be created.
* This value should be 1-63 characters long, containing only
* letters, numbers, hyphens, and underscores, and should not start
* with a number. E.g. "authz_policy".
* @param string $addressGroupName Name of the AddressGroup resource. It matches pattern
* `projects/*/locations/{location}/addressGroups/<address_group>`.
* @param int $addressGroupType The type of the Address Group. Possible values are "IPv4" or
* "IPV6".
* @param int $addressGroupCapacity Capacity of the Address Group
*/
function create_address_group_sample(
string $formattedParent,
string $addressGroupId,
string $addressGroupName,
int $addressGroupType,
int $addressGroupCapacity
): void {
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$addressGroup = (new AddressGroup())
->setName($addressGroupName)
->setType($addressGroupType)
->setCapacity($addressGroupCapacity);
$request = (new CreateAddressGroupRequest())
->setParent($formattedParent)
->setAddressGroupId($addressGroupId)
->setAddressGroup($addressGroup);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $organizationAddressGroupServiceClient->createAddressGroup($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AddressGroup $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 = OrganizationAddressGroupServiceClient::organizationLocationName(
'[ORGANIZATION]',
'[LOCATION]'
);
$addressGroupId = '[ADDRESS_GROUP_ID]';
$addressGroupName = '[NAME]';
$addressGroupType = Type::TYPE_UNSPECIFIED;
$addressGroupCapacity = 0;
create_address_group_sample(
$formattedParent,
$addressGroupId,
$addressGroupName,
$addressGroupType,
$addressGroupCapacity
);
}
deleteAddressGroup
Deletes an address group.
The async variant is OrganizationAddressGroupServiceClient::deleteAddressGroupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\DeleteAddressGroupRequest
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\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\DeleteAddressGroupRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName A name of the AddressGroup to delete. Must be in the format
* `projects/*/locations/{location}/addressGroups/*`. Please see
* {@see OrganizationAddressGroupServiceClient::addressGroupName()} for help formatting this field.
*/
function delete_address_group_sample(string $formattedName): void
{
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = (new DeleteAddressGroupRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $organizationAddressGroupServiceClient->deleteAddressGroup($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = OrganizationAddressGroupServiceClient::addressGroupName(
'[PROJECT]',
'[LOCATION]',
'[ADDRESS_GROUP]'
);
delete_address_group_sample($formattedName);
}
getAddressGroup
Gets details of a single address group.
The async variant is OrganizationAddressGroupServiceClient::getAddressGroupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\GetAddressGroupRequest
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\NetworkSecurity\V1\AddressGroup |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\AddressGroup;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\GetAddressGroupRequest;
/**
* @param string $formattedName A name of the AddressGroup to get. Must be in the format
* `projects/*/locations/{location}/addressGroups/*`. Please see
* {@see OrganizationAddressGroupServiceClient::addressGroupName()} for help formatting this field.
*/
function get_address_group_sample(string $formattedName): void
{
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = (new GetAddressGroupRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var AddressGroup $response */
$response = $organizationAddressGroupServiceClient->getAddressGroup($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = OrganizationAddressGroupServiceClient::addressGroupName(
'[PROJECT]',
'[LOCATION]',
'[ADDRESS_GROUP]'
);
get_address_group_sample($formattedName);
}
listAddressGroupReferences
Lists references of an address group.
The async variant is OrganizationAddressGroupServiceClient::listAddressGroupReferencesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\ListAddressGroupReferencesRequest
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\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\ListAddressGroupReferencesRequest;
use Google\Cloud\NetworkSecurity\V1\ListAddressGroupReferencesResponse\AddressGroupReference;
/**
* @param string $formattedAddressGroup A name of the AddressGroup to clone items to. Must be in the
* format `projects|organization/*/locations/{location}/addressGroups/*`. Please see
* {@see OrganizationAddressGroupServiceClient::addressGroupName()} for help formatting this field.
*/
function list_address_group_references_sample(string $formattedAddressGroup): void
{
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = (new ListAddressGroupReferencesRequest())
->setAddressGroup($formattedAddressGroup);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $organizationAddressGroupServiceClient->listAddressGroupReferences($request);
/** @var AddressGroupReference $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
{
$formattedAddressGroup = OrganizationAddressGroupServiceClient::addressGroupName(
'[PROJECT]',
'[LOCATION]',
'[ADDRESS_GROUP]'
);
list_address_group_references_sample($formattedAddressGroup);
}
listAddressGroups
Lists address groups in a given project and location.
The async variant is OrganizationAddressGroupServiceClient::listAddressGroupsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\ListAddressGroupsRequest
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\NetworkSecurity\V1\AddressGroup;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\ListAddressGroupsRequest;
/**
* @param string $formattedParent The project and location from which the AddressGroups
* should be listed, specified in the format
* `projects/*/locations/{location}`. Please see
* {@see OrganizationAddressGroupServiceClient::locationName()} for help formatting this field.
*/
function list_address_groups_sample(string $formattedParent): void
{
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = (new ListAddressGroupsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $organizationAddressGroupServiceClient->listAddressGroups($request);
/** @var AddressGroup $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 = OrganizationAddressGroupServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_address_groups_sample($formattedParent);
}
removeAddressGroupItems
Removes items from an address group.
The async variant is OrganizationAddressGroupServiceClient::removeAddressGroupItemsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\RemoveAddressGroupItemsRequest
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\NetworkSecurity\V1\AddressGroup;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\RemoveAddressGroupItemsRequest;
use Google\Rpc\Status;
/**
* @param string $formattedAddressGroup A name of the AddressGroup to remove items from. Must be in the
* format `projects|organization/*/locations/{location}/addressGroups/*`. Please see
* {@see OrganizationAddressGroupServiceClient::addressGroupName()} for help formatting this field.
* @param string $itemsElement List of items to remove.
*/
function remove_address_group_items_sample(
string $formattedAddressGroup,
string $itemsElement
): void {
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$items = [$itemsElement,];
$request = (new RemoveAddressGroupItemsRequest())
->setAddressGroup($formattedAddressGroup)
->setItems($items);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $organizationAddressGroupServiceClient->removeAddressGroupItems($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AddressGroup $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
{
$formattedAddressGroup = OrganizationAddressGroupServiceClient::addressGroupName(
'[PROJECT]',
'[LOCATION]',
'[ADDRESS_GROUP]'
);
$itemsElement = '[ITEMS]';
remove_address_group_items_sample($formattedAddressGroup, $itemsElement);
}
updateAddressGroup
Updates parameters of an address group.
The async variant is OrganizationAddressGroupServiceClient::updateAddressGroupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\UpdateAddressGroupRequest
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\NetworkSecurity\V1\AddressGroup;
use Google\Cloud\NetworkSecurity\V1\AddressGroup\Type;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
use Google\Cloud\NetworkSecurity\V1\UpdateAddressGroupRequest;
use Google\Rpc\Status;
/**
* @param string $addressGroupName Name of the AddressGroup resource. It matches pattern
* `projects/*/locations/{location}/addressGroups/<address_group>`.
* @param int $addressGroupType The type of the Address Group. Possible values are "IPv4" or
* "IPV6".
* @param int $addressGroupCapacity Capacity of the Address Group
*/
function update_address_group_sample(
string $addressGroupName,
int $addressGroupType,
int $addressGroupCapacity
): void {
// Create a client.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$addressGroup = (new AddressGroup())
->setName($addressGroupName)
->setType($addressGroupType)
->setCapacity($addressGroupCapacity);
$request = (new UpdateAddressGroupRequest())
->setAddressGroup($addressGroup);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $organizationAddressGroupServiceClient->updateAddressGroup($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AddressGroup $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
{
$addressGroupName = '[NAME]';
$addressGroupType = Type::TYPE_UNSPECIFIED;
$addressGroupCapacity = 0;
update_address_group_sample($addressGroupName, $addressGroupType, $addressGroupCapacity);
}
getLocation
Gets information about a location.
The async variant is OrganizationAddressGroupServiceClient::getLocationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
/**
* 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.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $organizationAddressGroupServiceClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
The async variant is OrganizationAddressGroupServiceClient::listLocationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
/**
* 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.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $organizationAddressGroupServiceClient->listLocations($request);
/** @var Location $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is OrganizationAddressGroupServiceClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
/**
* @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.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $organizationAddressGroupServiceClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
The async variant is OrganizationAddressGroupServiceClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
/**
* @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.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $organizationAddressGroupServiceClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
The async variant is OrganizationAddressGroupServiceClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkSecurity\V1\Client\OrganizationAddressGroupServiceClient;
/**
* @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.
$organizationAddressGroupServiceClient = new OrganizationAddressGroupServiceClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $organizationAddressGroupServiceClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
addAddressGroupItemsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\AddAddressGroupItemsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
cloneAddressGroupItemsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\CloneAddressGroupItemsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createAddressGroupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\CreateAddressGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteAddressGroupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\DeleteAddressGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAddressGroupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\GetAddressGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkSecurity\V1\AddressGroup> |
listAddressGroupReferencesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\ListAddressGroupReferencesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listAddressGroupsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\ListAddressGroupsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
removeAddressGroupItemsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\RemoveAddressGroupItemsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
updateAddressGroupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\NetworkSecurity\V1\UpdateAddressGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::addressGroupName
Formats a string containing the fully-qualified path to represent a address_group resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
addressGroup |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted address_group 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::organizationLocationName
Formats a string containing the fully-qualified path to represent a organization_location resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_location resource. |
static::organizationLocationAddressGroupName
Formats a string containing the fully-qualified path to represent a organization_location_address_group resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
addressGroup |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_location_address_group resource. |
static::projectLocationAddressGroupName
Formats a string containing the fully-qualified path to represent a project_location_address_group resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
addressGroup |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_address_group 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
- addressGroup: projects/{project}/locations/{location}/addressGroups/{address_group}
- location: projects/{project}/locations/{location}
- organizationLocation: organizations/{organization}/locations/{location}
- organizationLocationAddressGroup: organizations/{organization}/locations/{location}/addressGroups/{address_group}
- projectLocationAddressGroup: projects/{project}/locations/{location}/addressGroups/{address_group}
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. |